Merge lp:~nhandler/lptools/manpages into lp:lptools

[Nathan Handler]

Add manpages for all binaries that were missing them to comply with Debian Policy.

Debian policy requires all binaries to include manpages. Therefore, I have gone ahead and written manpages for all of the binaries that were missing one. These pages are pretty basic. They are based on the information available in the various scripts. Ideally, the script authors will expand on them over time.

It would also be nice for the docs/ directory to be included in future tarball releases.

[Martin Pool (mbp)]

Looks good to me, thanks!

review: Approve

=== added file 'doc/lp-attach.1'
--- doc/lp-attach.1	1970-01-01 00:00:00 +0000
+++ doc/lp-attach.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,20 @@
+.TH lp-attach "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-attach \- attach a file to a Launchpad bug
+
+.SH SYNOPSIS
+.B lp-attach <\fIbugnumber\fR>
+
+.SH DESCRIPTION
+\fBlp-attach\fR attaches a file (read from stdin) as an attachment on a named
+Launchpad bug.
+
+.SH OPTIONS
+Listed below are the command line options for \fBlp-attach\fR:
+.TP
+.BR <\fIbugnumber\fR>
+Launchpad bug number to attach the file to.
+
+.SH AUTHORS
+\fBlp-attach\fR was written by Martin Pool <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-bug-dupe-properties.1'
--- doc/lp-bug-dupe-properties.1	1970-01-01 00:00:00 +0000
+++ doc/lp-bug-dupe-properties.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,37 @@
+.TH lp-bug-dupe-properties "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-bug-dupe-properties \- find duplicate Launchpad bug reports
+
+.SH SYNOPSIS
+.B lp-bug-dupe-properties [\fIOPTION\fR]
+
+.SH DESCRIPTION
+\fBlp-bug-dupe-properties\fR displays information such as date, tags, and Ubuntu release information for duplicate Launchpad bugs. It also allows you to filter by certain apport keys.
+
+.SH OPTIONS
+Listed below are the command line options for \fBlp-bug-dupe-properties\fR:
+.TP
+.BR \-r ", " \-\-reporter
+Display reporter of duplicates
+.TP
+.B \-m ", " \-\-month
+Display month duplicates were reported
+.TP
+.B \-d ", " \-\-day
+Display day duplicates were reported
+.TP
+.B \-t ", " \-\-tags
+Display tags of duplicates
+.TP
+.B \-rt ", " \-\-rtags
+Display Ubuntu release tags of duplicates
+.TP
+.B \-D ", " \-\-desc
+Search apport bug description for this key e.g. Package
+.TP
+.B \-b ", " \-\-bug
+Bug number of which to check the duplicates
+
+.SH AUTHORS
+\fBlp-bug-dupe-properties\fR was written by Brian Murray <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-capture-bug-counts.1'
--- doc/lp-capture-bug-counts.1	1970-01-01 00:00:00 +0000
+++ doc/lp-capture-bug-counts.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,15 @@
+.TH lp-capture-bug-counts "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-capture-bug-counts \- view summary of number of bugs for a Launchpad project
+
+.SH SYNOPSIS
+.B lp-capture-bug-counts
+
+.SH DESCRIPTION
+\fBlp-capture-bug-counts\fR prints some statistics about a project. It can
+quickly display the number of bugs with a particular status or with patches
+attached that affect a project.
+
+.SH AUTHORS
+\fBlp-capture-bug-counts\fR was written by Martin Pool <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-force-branch-mirror.1'
--- doc/lp-force-branch-mirror.1	1970-01-01 00:00:00 +0000
+++ doc/lp-force-branch-mirror.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,19 @@
+.TH lp-force-branch-mirror "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-force-branch-mirror \- force a new import
+
+.SH SYNOPSIS
+.B lp-force-branch-mirror [\fIoptions\fR] \fIBRANCH\fR...
+
+.SH DESCRIPTION
+\fBlp-force-branch-mirror\fR forces the mirrorring of a code mirror.
+
+.SH OPTIONS
+Listed below are the command line options for \fBlp-force-branch-mirror\fR:
+.TP
+.BR PROJECT
+The launchpad project to inspect (eg bzr)
+
+.SH AUTHORS
+\fBlp-force-branch-mirror\fR was written by Jelmer Vernooij <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-milestone2ical.1'
--- doc/lp-milestone2ical.1	1970-01-01 00:00:00 +0000
+++ doc/lp-milestone2ical.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,20 @@
+.TH lp-milestone2ical "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-milestone2ical \- convert project milestones to iCalendar
+
+.SH SYNOPSIS
+.B lp-milestone2ical <\fIproject\fR>
+
+.SH DESCRIPTION
+\fBlp-milestone2ical\fR will convert all the milestones on a project or project
+group, into an iCalendar 2.0 format file, for importing into a calendar program.
+
+.SH OPTIONS
+Listed below are the command line options for \fBlp-milestone2ical\fR:
+.TP
+.BR project
+The launchpad project whose milestones you wish to convert
+
+.SH AUTHORS
+\fBlp-milestone2ical\fR was written by Rodney Dawes <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-milestones.1'
--- doc/lp-milestones.1	1970-01-01 00:00:00 +0000
+++ doc/lp-milestones.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,33 @@
+.TH lp-milestones "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-milestones \- work with milestones in Launchpad
+
+.SH SYNOPSIS
+.B lp-milestones <\fIcommand\fR>
+
+.SH DESCRIPTION
+\fBlp-milestones\fR allows you to create, delete, and rename milestones, as well
+as create a release from a milestone.
+
+.SH OPTIONS
+Listed below are the possible commands that can be passed to \fBlp-milestones\fR:
+.TP
+.BR help\ commands
+List all supported commands
+.TP
+.B create <\fIprojectname\fR>/<\fIseriesname\fR>/<\fImilestonename\fR>
+Create a milestone.
+.TP
+.B delete <\fIprojectname\fR>/<\fImilestonename\fR>
+Delete a milestone. Note that this cannot delete a milestone with releases on it
+(yet).
+.TP
+.B release <\fIprojectname\fR>/<\fImilestonename\fR>
+Create a release from a milestone.
+.TP
+.B rename <\fIprojectname\fR>/<\fImilestonename\fR> <\fInewname\fR>
+Rename a milestone.
+
+.SH AUTHORS
+\fBlp-milestones\fR was written by Robert Collins <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-project.1'
--- doc/lp-project.1	1970-01-01 00:00:00 +0000
+++ doc/lp-project.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,29 @@
+.TH lp-project "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-project \- work with projects in Launchpad
+
+.SH SYNOPSIS
+.B lp-project <\fIcommand\fR>
+
+.SH DESCRIPTION
+\fBlp-project\fR allows you to quickly create a new project on Launchpad. It automates the creation of management/commiter teams, a \-dev mailing list, the project itself, and a bzr branch for trunk.
+
+.SH OPTIONS
+Listed below are the possible commands that can be passed to \fBlp-project\fR:
+.TP
+.BR help\ commands
+List all supported commands
+.TP
+.B create <\fIprojectname\fR>
+Create a project. This creates two teams - a management/committer team owner by
+you and a \-dev mailing list owned by the mgmt team. It then creates the project,
+makes it owned by the committer team, creates a new empty bzr branch for trunk
+and then fires up a web browser pointing at the project for you to fine tune.
+After running this command you need to set what LP features you are using
+(https://bugs.launchpad.net/launchpad/+bug/537269), describe your project
+(title, summary, description), upload your code to lp:PROJECT, and turn on the
+mailing list by hand (https://bugs.launchpad.net/launchpad/+bug/537258)
+
+.SH AUTHORS
+\fBlp-project\fR was written by Robert Collins <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-recipe-status.1'
--- doc/lp-recipe-status.1	1970-01-01 00:00:00 +0000
+++ doc/lp-recipe-status.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,23 @@
+.TH lp-recipe-status "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-recipe-status \- show the status of the recipes owned by a particular user
+
+.SH SYNOPSIS
+.B lp-recipe-status [\fIoptions\fR] <\fIperson\fR>
+
+.SH DESCRIPTION
+\fBlp-recipe-status\fR will render a status table for all of the recipe builds
+owned by the specified person.
+
+.SH OPTIONS
+Listed below are the command line options for \fBlp-recipe-status\fR:
+.TP
+.BR <\fIperson\fR>
+The Launchpad person or team whose recipes to check
+.TP
+.B \-\-html
+Generate HTML
+
+.SH AUTHORS
+\fBlp-recipe-status\fR was written by Jelmer Vernooij <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-remove-team-members.1'
--- doc/lp-remove-team-members.1	1970-01-01 00:00:00 +0000
+++ doc/lp-remove-team-members.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,22 @@
+.TH lp-remove-team-members "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-remove-team-members \- remove members from a Launchpad team
+
+.SH SYNOPSIS
+.B lp-remove-team-members <\fIteam\fR> <\fIMEMBER\fR>...
+
+.SH DESCRIPTION
+\fBlp-remove-team-members\fR allows you to quickly bulk remove users from a team.
+
+.SH OPTIONS
+Listed below are the command line options for \fBlp-remove-team-members\fR:
+.TP
+.BR <\fIteam\fR>
+Launchpad team to remove members from
+.TP
+.B <\fIMEMBER\fR>...
+List of members to remove from the team
+
+.SH AUTHORS
+\fBlp-remove-team-members\fR was written by Martin Pool <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-review-list.1'
--- doc/lp-review-list.1	1970-01-01 00:00:00 +0000
+++ doc/lp-review-list.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,23 @@
+.TH lp-review-list "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-review-list \- list reviews for a project
+
+.SH SYNOPSIS
+.B lp-review-list <\fIproject1\fR> [[\fIproject2\fR] ...]
+
+.SH DESCRIPTION
+\fBlp-review-list\fR will present a list of all the branches currently in the
+Needs Review state. The list includes the branch name, and the votes
+on the proposal. You can double-click on a row to open the merge proposal
+page in your browser. It will use launchpadlib and refresh automatically every
+5 minutes.
+
+.SH OPTIONS
+Listed below are the command line options for \fBlp-review-list\fR:
+.TP
+.BR <\fIproject1\fR> [[\fIproject2\fR] ...]
+List of projects to display branches in the Needs Review state for.
+
+.SH AUTHORS
+\fBlp-review-list\fR was written by Rodney Dawes <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.

=== added file 'doc/lp-review-notifier.1'
--- doc/lp-review-notifier.1	1970-01-01 00:00:00 +0000
+++ doc/lp-review-notifier.1	2012-10-25 03:50:24 +0000
@@ -0,0 +1,21 @@
+.TH lp-review-notifier "1" "Oct 24 2012" "lptools"
+.SH NAME
+lp-review-notifier \- desktop notifier about reviews that can be done
+
+.SH SYNOPSIS
+.B lp-review-notifier <\fIproject1\fR> [[\fIproject2\fR] ...]
+
+.SH DESCRIPTION
+\fBlp-review-notifier\fR will present notifications for changes to merge
+proposals on a project. You currently must pass the list of projects on the
+command line.
+
+.SH OPTIONS
+Listed below are the command line options for \fBlp-review-notifier\fR:
+.TP
+.BR <\fIproject1\fR> [[\fIproject2\fR] ...]
+List of projects to display notifications for changes to merge proposals for.
+
+.SH AUTHORS
+\fBlp-review-notifier\fR was written by Rodney Dawes <[e-mail]>,
+and this manual page was written by Nathan Handler <[e-mail]>.