From 4b3746bb6dd56d8fb81991a5aa787a67637d2fa6 Mon Sep 17 00:00:00 2001 From: Colin Watson <cjwatson@canonical.com> Date: Mon, 1 Sep 2008 09:50:23 +0100 Subject: [PATCH] Fix a number of minor glitches in manual pages. --- debian/changelog | 6 ++++ doc/buildd.1 | 25 +++++++--------- doc/check-symbols.1 | 34 +++++++++++----------- doc/dch-repeat.1 | 57 +++++++++++++++++-------------------- doc/dgetlp.1 | 16 ++++------- doc/get-branches.1 | 33 +++++++++------------ doc/get-build-deps.1 | 17 +++++------ doc/grab-attachments.1 | 21 ++++++-------- doc/hugdaylist.1 | 7 ++--- doc/mk-sbuild-lv.1 | 51 ++++++++++++++++----------------- doc/pbuilder-dist-simple.1 | 15 +++++----- doc/pbuilder-dist.1 | 20 +++++++------ doc/pull-lp-source.1 | 26 ++++++++--------- doc/requestsync.1 | 48 +++++++++++++++---------------- doc/reverse-build-depends.1 | 11 +++---- doc/suspicious-source.1 | 7 +++-- doc/what-patch.1 | 34 ++++++++++------------ 17 files changed, 204 insertions(+), 224 deletions(-) diff --git a/debian/changelog b/debian/changelog index 2ac2cbe..f6518fc 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +ubuntu-dev-tools (0.43ubuntu2) UNRELEASED; urgency=low + + * Fix a number of minor glitches in manual pages. + + -- Colin Watson <cjwatson@ubuntu.com> Mon, 01 Sep 2008 09:48:38 +0100 + ubuntu-dev-tools (0.43ubuntu1) intrepid; urgency=low * Bazaar revision 195. diff --git a/doc/buildd.1 b/doc/buildd.1 index e79c814..4bdb6a8 100644 --- a/doc/buildd.1 +++ b/doc/buildd.1 @@ -3,50 +3,47 @@ buildd \- command-line interface to Launchpad build operations .SH SYNOPSIS - .B buildd <srcpackage> <release> <operation> - +.br .B buildd \-\-help .SH DESCRIPTION -.PP \fBbuildd\fR provides a command line interface to the Launchpad build operations. .PP \fBbuildd\fR uses a cookie file stored at \fI~/.lpcookie.txt\fR to authenticate -to Launchpad. This cookie is created on run from the Mozilla Firefox cookie +to Launchpad. +This cookie is created on run from the Mozilla Firefox cookie file at \fI~/.mozilla/*/*/cookies.sqlite\fR. .SH OPERATIONS -.PP Listed below are the available operations for \fBbuildd\fR: .TP .B status Outputs the build status of the package on Launchpad on all architectures. .TP .B retry -Requests that the package has another attempt at rebuilding from source. This -shall only work if the package has \fIFailed to build\fR on Launchpad. +Requests that the package has another attempt at rebuilding from source. +This will only work if the package has \fIFailed to build\fR on Launchpad. .TP .B rescore -Requests that the packages build priority be raised in the build queue. Only -members of the Launchpad build administrators may issue this operation and may -only be performed on packages which \fINeed building\fR. +Requests that the package's build priority be raised in the build queue. +Only members of the Launchpad build administrators may issue this operation, +and it may only be performed on packages which \fINeed building\fR. .SH OPTIONS -.PP Listed below are the command line options for \fBbuildd\fR: .TP .B \-h or \-\-help Display a help message and exit. .TP .B \-a or \-\-architecture -Only available for \fIrescore\fR and \fIretry\fR operations only. This shall -only request the rebuilding/rescoring on the specified architecture only. +Only available for \fIrescore\fR and \fIretry\fR operations only. +This will only request the rebuilding/rescoring on the specified +architecture. .SH AUTHORS -.PP \fBbuildd\fR was written by Martin Pitt <martin.pitt@canonical.com>, and this manual page was written by Jonathan Patrick Davies <jpds@ubuntu.com>. .PP diff --git a/doc/check-symbols.1 b/doc/check-symbols.1 index 8abb439..13ad020 100644 --- a/doc/check-symbols.1 +++ b/doc/check-symbols.1 @@ -7,37 +7,37 @@ check\-symbols \- verify symbols exported by a new library version \fBcheck\-symbols\fP <\fIsource\-package\fR\> [\fIDEBDIR\fR] .SH "DESCRIPTION" -To verify the symbols exported by a new library version, run -\fBcheck-symbols\fP with the name of the source package as argument. -\fBcheck-symbols\fP will first determine the symbols exported by the existing -and installed libary version, then install the new library and compare the -symbols exported by the new library version with the symbols exported -by the old version. For each of the symbols found, \fBcheck-symbols\fP -will list if the symbol is new, unchanged or has been removed in the -new library version. +To verify the symbols exported by a new library version, run +\fBcheck\-symbols\fP with the name of the source package as argument. +\fBcheck\-symbols\fP will first determine the symbols exported by the +existing and installed library version, then install the new library and +compare the symbols exported by the new library version with the symbols +exported by the old version. +For each of the symbols found, \fBcheck\-symbols\fP will list if the symbol +is new, unchanged or has been removed in the new library version. .PP -In case the source package contains multiple binary library packages, +In case the source package contains multiple binary library packages, all library files in each of the binary packages will be verified. .PP -\fBcheck\-symbols\fP uses \fBnm\fP -D to determine +\fBcheck\-symbols\fP uses \fBnm\fP \-D to determine the exported symbols of the libraries. -.PP -If no value is given for DEBDIR, the script will assume the new library +.PP +If no value is given for DEBDIR, the script will assume the new library deb files are stored in /var/cache/pbuilder/result. .SH "EXAMPLES" -\fBcheck\-symbols\fP telepathy-glib . +\fBcheck\-symbols\fP telepathy\-glib . .TP This will: .RS 2 .TP 2 -\(bu Use \fBnm\fP -D to determine the exported symbols of the old, +\(bu Use \fBnm\fP \-D to determine the exported symbols of the old, installed versions of the libraries provided by telepathy\-glib. .TP 2 -\(bu Install the binary libaries provided by the new version of +\(bu Install the binary libaries provided by the new version of telepathy\-glib. .TP 2 -\(bu Compare the output of \fBnm\fP -D of the new libraries with the +\(bu Compare the output of \fBnm\fP \-D of the new libraries with the output of the old version. .TP 2 \(bu List the result in diff format. @@ -45,7 +45,7 @@ output of the old version. .SH "BUGS" .nf -Please report bugs on: +Please report bugs on: https://bugs.launchpad.net/ubuntu/+source/ubuntu\-dev\-tools/ .fi diff --git a/doc/dch-repeat.1 b/doc/dch-repeat.1 index 8506b8b..0c2a6cb 100644 --- a/doc/dch-repeat.1 +++ b/doc/dch-repeat.1 @@ -1,61 +1,56 @@ -.TH DCH-REPEAT "1" "10 August 2008" "ubuntu-dev-tools" +.TH DCH\-REPEAT "1" "10 August 2008" "ubuntu-dev-tools" .SH NAME -dch-repeat \- repeats a changelog entry into an older release +dch\-repeat \- repeats a changelog entry into an older release .SH SYNOPSIS - -.B dch-repeat \-\-build-tree <\fIPATH\fR> - -.B dch-repeat \-\-source-release <\fIRELEASE\fR> - -.B dch-repeat \-\-target-release <\fIRELEASE\fR> - -.B dch-repeat \-\-devel-release <\fIRELEASE\fR> - -.B dch-repeat \-\-pocket <\fIPOCKET\fR> - -.B dch-repeat \-h +.B dch\-repeat \-\-build\-tree <\fIPATH\fR> +.br +.B dch\-repeat \-\-source\-release <\fIRELEASE\fR> +.br +.B dch\-repeat \-\-target\-release <\fIRELEASE\fR> +.br +.B dch\-repeat \-\-devel\-release <\fIRELEASE\fR> +.br +.B dch\-repeat \-\-pocket <\fIPOCKET\fR> +.br +.B dch\-repeat \-h .SH DESCRIPTION -.PP -\fBdch-repeat\fR is used to repeat a changelog into an older release. It -expects that \-\-build-tree is laid out with each Ubuntu release as a separate -directory ("feisty", "edgy", etc). - +\fBdch\-repeat\fR is used to repeat a changelog into an older release. +It expects that \-\-build\-tree is laid out with each Ubuntu release as a +separate directory ("feisty", "edgy", etc). .PP For example, if gimp had a security update prepared for Feisty in -$TREE/feisty/gimp-2.2.13, running \fBdch-repeat\fR in $TREE/edgy/gimp-2.2.13 -would pull in the latest changelog from the Feisty build. +$TREE/feisty/gimp\-2.2.13, running \fBdch\-repeat\fR in +$TREE/edgy/gimp\-2.2.13 would pull in the latest changelog from the Feisty +build. .SH OPTIONS -.PP -Listed below are the command line options for \fBdch-repeat\fR: +Listed below are the command line options for \fBdch\-repeat\fR: .TP .B \-h or \-\-help Display a help message and exit. .TP -.B \-\-build-tree PATH +.B \-\-build\-tree PATH Base of build trees. Default is /scratch/ubuntu/build. .TP -.B \-s or \-\-source-release RELEASE +.B \-s or \-\-source\-release RELEASE Which release to take changelog from. .TP -.B \-\-target-release RELEASE +.B \-\-target\-release RELEASE Which release to build into. .TP -.B \-\-devel-release RELEASE +.B \-\-devel\-release RELEASE Which release is the development release. .TP .B \-\-pocket POCKET Which pocket to use. .SH AUTHOR -.PP -\fBdch-repeat\fR was written by Kees Cook <kees@ubuntu.com>. This manual page -was written by Jonathan Patrick Davies <jpds@ubuntu.com>. +\fBdch-repeat\fR was written by Kees Cook <kees@ubuntu.com>. +This manual page was written by Jonathan Patrick Davies <jpds@ubuntu.com>. .PP Both are released under the GNU General Public License, version 2. .SH SEE ALSO -.PP .BR dch(1). diff --git a/doc/dgetlp.1 b/doc/dgetlp.1 index 9e84872..d6f04de 100644 --- a/doc/dgetlp.1 +++ b/doc/dgetlp.1 @@ -1,18 +1,15 @@ .TH DGETLP "1" "27 August 2008" "ubuntu-dev-tools" .SH NAME -dgetlp \- simulate ``dget'' behaviour for files hosted at -librarian.launchpad.net +dgetlp \- simulate ``dget'' behaviour for files hosted at librarian.launchpad.net .SH SYNOPSIS -.B dgetlp [-d] <\fBLaunchpad DSC URL\fR> +.B dgetlp \fR[\fB\-d\fR] <\fBLaunchpad DSC URL\fR> .SH DESCRIPTION -.PP \fBdgetlp\fR downloads and optionally extracts the <\fBLaunchpad DSC URL\fR> from Launchpad. .SH OPTIONS -.PP Listed below are the command line options for dgetlp: .TP .B \-d @@ -30,8 +27,7 @@ Specifies the default target. .B dgetlp http://launchpadlibrarian.net/10348157/coreutils_5.97-5.4ubuntu1.dsc .SH AUTHOR -.PP -\fBdgetlp\fR was written written by Terence Simpson <tsimpson@ubuntu.com> and -modified by Siegfried-A. Gevatter <rainct@ubuntu.com>. This man page was written -by Ryan Kavanagh <ryanakca@kubuntu.org>. Both are released under the GNU General -Public License, version 2 or later. +\fBdgetlp\fR was written by Terence Simpson <tsimpson@ubuntu.com> and +modified by Siegfried-A. Gevatter <rainct@ubuntu.com>. +This man page was written by Ryan Kavanagh <ryanakca@kubuntu.org>. +Both are released under the GNU General Public License, version 2 or later. diff --git a/doc/get-branches.1 b/doc/get-branches.1 index d0f29be..aa5ca85 100644 --- a/doc/get-branches.1 +++ b/doc/get-branches.1 @@ -1,23 +1,20 @@ -.TH GET-BRANCHES "1" "11 August 2008" "ubuntu-dev-tools" +.TH GET\-BRANCHES "1" "11 August 2008" "ubuntu-dev-tools" .SH NAME -get-branches \- downloads all branches related to a Launchpad team or person +get\-branches \- downloads all branches related to a Launchpad team or person .SH SYNOPSIS - -.B get-branches [-d directory] [-o branch|checkout] \-t <team> - -.B get-branches <team> - -.B get-branches \-\-help +.B get\-branches [\-d directory] [\-o branch|checkout] \-t <team> +.br +.B get\-branches <team> +.br +.B get\-branches \-\-help .SH DESCRIPTION -.PP -\fBget-branches\fR examines the code page of a Launchpad team/person, parses it, -and calls Bazaar to download all branches on that page. +\fBget\-branches\fR examines the code page of a Launchpad team/person, +parses it, and calls Bazaar to download all branches on that page. .SH OPTIONS -.PP -Listed below are the command line options for \fBget-branches\fR: +Listed below are the command line options for \fBget\-branches\fR: .TP .B \-h or \-\-help Display a help message and exit. @@ -30,16 +27,14 @@ Specifies which Bazaar operation to use when downloading the branches; may be either \fIbranch\fR or \fIcheckout\fR. .TP .B \-t or \-\-team -Specifies which Launchpad team/person to download branches from. This option is -required. +Specifies which Launchpad team/person to download branches from. +This option is required. .SH AUTHORS -.PP -\fBget-branches\fR was written by Daniel Holbach <daniel.holbach@ubuntu.com>, and -this manual page was written by Jonathan Patrick Davies <jpds@ubuntu.com>. +\fBget\-branches\fR was written by Daniel Holbach <daniel.holbach@ubuntu.com>, +and this manual page was written by Jonathan Patrick Davies <jpds@ubuntu.com>. .PP Both are released under the terms of the GNU General Public License, version 3. .SH SEE ALSO -.PP .B bzr(1) diff --git a/doc/get-build-deps.1 b/doc/get-build-deps.1 index a15b49d..9f21e00 100644 --- a/doc/get-build-deps.1 +++ b/doc/get-build-deps.1 @@ -17,8 +17,9 @@ missing build dependencies. .PP Alternatively, you can call it with a list of space-separated package names, or the name of a single file which contains the package names -each on a line. Then it will install the missing dependencies for those -packages using "apt-get build-dep". +each on a line. +Then it will install the missing dependencies for those packages using +"apt\-get build\-dep". .SH EXAMPLES .TP @@ -30,9 +31,9 @@ get\-build\-deps geany Installs the build dependencies for the version of \fBgeany\fP that's in the repositories. .TP -get\-build\-deps geany epiphany-browser rhythmbox +get\-build\-deps geany epiphany\-browser rhythmbox Same as the previous example but also with the dependencies for -.B epiphany-browser +.B epiphany\-browser and .BR rhythmbox . .TP @@ -50,10 +51,10 @@ for the dependencies to match the indicated versions, but just installs the newest one available in the repositories. .SH SEE ALSO -.BR dpkg-checkbuilddeps (1), -.BR apt-get (8) +.BR dpkg\-checkbuilddeps (1), +.BR apt\-get (8) .SH AUTHORS \fBget\-build\-deps\fP and this manual page have been written by Siegfried-Angel -Gevatter Pujals <rainct@ubuntu.com>. They are released under the GNU General -Public License, version 3 or later. +Gevatter Pujals <rainct@ubuntu.com>. +They are released under the GNU General Public License, version 3 or later. diff --git a/doc/grab-attachments.1 b/doc/grab-attachments.1 index 2fff303..d66339e 100644 --- a/doc/grab-attachments.1 +++ b/doc/grab-attachments.1 @@ -1,18 +1,16 @@ -.TH GRAB-ATTACHMENTS "1" "10 August 2008" "ubuntu-dev-tools" +.TH GRAB\-ATTACHMENTS "1" "10 August 2008" "ubuntu-dev-tools" .SH NAME -grab-attachments \- downloads attachments from a Launchpad bug +grab\-attachments \- downloads attachments from a Launchpad bug .SH SYNOPSIS -.B grab-attachments\fR <\fIbug-number\fR> - -.B grab-attachments \-h +.B grab\-attachments\fR <\fIbug-number\fR> +.br +.B grab\-attachments \-h .SH DESCRIPTION -.PP -\fBgrab-attachments\fR is a script to download all attachments from a +\fBgrab\-attachments\fR is a script to download all attachments from a Launchpad bug report into the current directory. .SH OPTIONS -.PP -Listed below are the command line options for grab-attachments: +Listed below are the command line options for grab\-attachments: .TP .B \-h Display a help message and exit. @@ -22,8 +20,7 @@ Specifies the Launchpad bug number that the script should download attachments from. .SH AUTHOR -.PP -\fBgrab-attachments\fR was written by Daniel Holbach and this manual page was -written by Jonathan Patrick Davies. +\fBgrab\-attachments\fR was written by Daniel Holbach and this manual page +was written by Jonathan Patrick Davies. .PP Both are released under the GNU General Public License, version 2. diff --git a/doc/hugdaylist.1 b/doc/hugdaylist.1 index a10f160..71d0b9a 100644 --- a/doc/hugdaylist.1 +++ b/doc/hugdaylist.1 @@ -1,12 +1,10 @@ .TH HUGDAYLIST "1" "August 27, 2008" "ubuntu-dev-tools" .SH NAME -hugdaylist \- produce MoinMoin wiki formatted tables based on a Launchpad bug -list +hugdaylist \- produce MoinMoin wiki formatted tables based on a Launchpad bug list .SH SYNOPSIS -.B hugdaylist [\fB\-n <NUMBER>, \fB\-\-number=<NUMBER>\fP] -\fBlaunchpad-buglist-url\fP +.B hugdaylist [\fB\-n\fP|\fB\-\-number <NUMBER>\fP] \fBlaunchpad-buglist-url\fP .SH DESCRIPTION \fBhugdaylist\fP produces MoinMoin wiki formatted tables based on a @@ -20,7 +18,6 @@ This option allows you to specify the number of entries to output. \fBlaunchpad-buglist-url\fP Required, this option is a URL pointing to a launchpad bug list. - .SH AUTHOR \fBhugdaylist\fP has been written by Canonical Ltd., Daniel Holbach <daniel.holbach@canonical.com> and Jonathan Patrick Davies <jpds@ubuntu.com>. diff --git a/doc/mk-sbuild-lv.1 b/doc/mk-sbuild-lv.1 index 068dbcf..4eaf6e7 100644 --- a/doc/mk-sbuild-lv.1 +++ b/doc/mk-sbuild-lv.1 @@ -1,20 +1,18 @@ -.TH MK-SBUILD-LV "1" "27 August 2008" "ubuntu-dev-tools" +.TH MK\-SBUILD\-LV "1" "27 August 2008" "ubuntu-dev-tools" .SH NAME -mk-sbuild-lv \- creates LVM snapshot chroots via schroot and sbuild +mk\-sbuild\-lv \- creates LVM snapshot chroots via schroot and sbuild .SH SYNOPSIS -\fB mk-sbuild-lv\fR [\fB--arch=ARCH\fR] [\fB--name=NAME\fR] -[\fB--personality=PERSONALITY\fR] [\fB--debug\fR] [\fB--source-template=FILE\fR] -[\fB--debootstrap-mirror=URL\fR] <\fBVG\fR> <\fBRelease\fR> +\fBmk\-sbuild\-lv\fR [\fB\-\-arch=ARCH\fR] [\fB\-\-name=NAME\fR] +[\fB\-\-personality=PERSONALITY\fR] [\fB\-\-debug\fR] [\fB\-\-source\-template=FILE\fR] +[\fB\-\-debootstrap\-mirror=URL\fR] <\fBVG\fR> <\fBRelease\fR> .SH DESCRIPTION -.PP -\fBmk-sbuild-lv\fR creates LVM snapshot chroots via schroot and sbuild. +\fBmk\-sbuild\-lv\fR creates LVM snapshot chroots via schroot and sbuild. .SH OPTIONS -.PP -Listed below are the command line options for mk-sbuild-lv: +Listed below are the command line options for mk\-sbuild\-lv: .TP .B \-\-arch=ARCH What architecture to select (defaults to the native architecture). @@ -23,15 +21,15 @@ What architecture to select (defaults to the native architecture). Base name for the schroot (arch is appended) .TP .B \-\-personality=PERSONALITY -What personality to use (defaults to match --arch) +What personality to use (defaults to match \-\-arch) .TP .B \-\-debug Turn on script debugging .TP -.B \-\-source-template=FILE -Use FILE as the sources.list template (defaults to $HOME/.mk-sbuild-lv.sources) +.B \-\-source\-template=FILE +Use FILE as the sources.list template (defaults to $HOME/.mk\-sbuild\-lv.sources) .TP -.B \-\-debootstrap-mirror=URL +.B \-\-debootstrap\-mirror=URL Use URL as the debootstrap source (defaults to http://ports.ubuntu.com for lpia, official Ubuntu repositories for the supported architectures). @@ -48,26 +46,27 @@ Lines to append to schroot entries .SH FILES .TP -.B $HOME/.mk-sbuild-lv.sources -Can contain a customized sources.list. It will be read when creating the -schroot, see sources.list(5) for more details on format. +.B $HOME/.mk\-sbuild\-lv.sources +Can contain a customized sources.list. +It will be read when creating the schroot. +See sources.list(5) for more details on the format. .TP -.B $HOME/.mk-sbuild-lv.schroot.conf +.B $HOME/.mk\-sbuild\-lv.schroot.conf Can contain a customized configuration section to be inserted into -/etc/schroot/schroot.conf, see schroot.conf(5) for more details on format. +/etc/schroot/schroot.conf. +See schroot.conf(5) for more details on the format. .SH USING THE CHROOTS .TP -To UPDATE the golden image: \fBschroot -c ${CHROOT_NAME}-source -u root -- sh -c apt-get update && apt-get -y upgrade\fR +To UPDATE the golden image: \fBschroot \-c ${CHROOT_NAME}\-source -u root \-\- sh \-c apt\-get update && apt\-get \-y upgrade\fR .TP -To ENTER an image snapshot: \fBschroot -c ${CHROOT_NAME}\fR +To ENTER an image snapshot: \fBschroot \-c ${CHROOT_NAME}\fR .TP -To BUILD within a snapshot: \fBsbuild -d ${SCHROOT_NAME} PACKAGE*.dsc\fR +To BUILD within a snapshot: \fBsbuild \-d ${SCHROOT_NAME} PACKAGE*.dsc\fR .SH SEE ALSO -.BR sbuild-setup (7), sources.list (5), schroot.conf (5), https://help.ubuntu.com/community/SbuildLVMHowto +.BR sbuild\-setup (7), sources.list (5), schroot.conf (5), https://help.ubuntu.com/community/SbuildLVMHowto .SH AUTHOR -.PP -\fBmk-sbuild-lv\fR was written written by Kees Cook <kees@ubuntu.com>. This -man page was written by Ryan Kavanagh <ryanakca@kubuntu.org>. Both are released -under the GNU General Public License, version 3 or later. +\fBmk\-sbuild\-lv\fR was written by Kees Cook <kees@ubuntu.com>. +This man page was written by Ryan Kavanagh <ryanakca@kubuntu.org>. +Both are released under the GNU General Public License, version 3 or later. diff --git a/doc/pbuilder-dist-simple.1 b/doc/pbuilder-dist-simple.1 index 1ed6954..8db1772 100644 --- a/doc/pbuilder-dist-simple.1 +++ b/doc/pbuilder-dist-simple.1 @@ -8,14 +8,14 @@ pbuilder\-dist\-simple \- simple multi-distribution pbuilder wrapper .SH DESCRIPTION \fBpbuilder\-dist\fP is a wrapper that makes it easy to use pbuilder with -chroots for many different Ubuntu/Debian distributions. If you need more -features than \fBpbuilder\-dist\-simple\fP provides, have a look at -\fBpbuilder\-dist\fP. +chroots for many different Ubuntu/Debian distributions. +If you need more features than \fBpbuilder\-dist\-simple\fP provides, have a +look at \fBpbuilder\-dist\fP. .SH USAGE Create one symlink to \fBpbuilder\-dist\-simple\fP for each distribution -for which you want a build environment, naming them like "pbuilder-hardy", -"pbuilder-gutsy", etc. +for which you want a build environment, naming them like "pbuilder\-hardy", +"pbuilder\-gutsy", etc. .PP Replace \fIoperation\fP with the action you want \fBpbuilder\-dist\-simple\fP to do (create, update, build, clean, login or execute). @@ -33,8 +33,9 @@ Builds the specified package on an already existing Ubuntu Hardy environment. .SH FILES By default, \fBpbuilder\-dist\-simple\fP will store all the files it -generates in \fB~/pbuilder/\fP. This can be changed by modifying the -BASE_DIR value on the top of the script to any other directory you want. +generates in \fB~/pbuilder/\fP. +This can be changed by modifying the BASE_DIR value on the top of the script +to any other directory you want. If the directory doesn't exit, it will be created at runtime. .SH SEE ALSO diff --git a/doc/pbuilder-dist.1 b/doc/pbuilder-dist.1 index db993f3..1a3518a 100644 --- a/doc/pbuilder-dist.1 +++ b/doc/pbuilder-dist.1 @@ -45,9 +45,10 @@ the current action in a dot-file called \fB.lastlog\fP in its base directory If this file already exists, it will be overwritten. .TP \fBoperation\fP -Replace this with the action you want \fBpbuilder\fP to do (create, update, build, clean, login -or execute). If you don't specify any action, but the next argument is a .dsc file, it will -assume that it should build. +Replace this with the action you want \fBpbuilder\fP to do (create, update, +build, clean, login or execute). +If you don't specify any action, but the next argument is a .dsc file, it +will assume that it should build. Check its manpage for more details. .TP \fB[...]\fP @@ -56,9 +57,10 @@ Replace this with other parameters, if needed. For example, if \fBbuild\fP is the option, you will need to also specify a .dsc file. .PP -The default value of all optional parameters (except the architecture) can be changed by -editing the first lines of the script. You can also change the base directory using the -global variable $PBUILDFOLDER. +The default value of all optional parameters (except the architecture) can +be changed by editing the first lines of the script. +You can also change the base directory using the global variable +$PBUILDFOLDER. .PP .SH EXAMPLES @@ -96,9 +98,9 @@ with \fBpbuilder\fP. .SH AUTHORS \fBpbuilder\-dist\fP was originally written by Jamin W. Collins -<jcollins@asgardsrealm.net> and Jordan Mantha <mantha@ubuntu.com>. On August -2007 it was mostly rewritten, and extended, by Siegfried-Angel Gevatter Pujals -<rainct@ubuntu.com>. +<jcollins@asgardsrealm.net> and Jordan Mantha <mantha@ubuntu.com>. +On August 2007 it was mostly rewritten, and extended, by Siegfried-Angel +Gevatter Pujals <rainct@ubuntu.com>. \fBpbuilder\-dist\fP is released under the GNU General Public License, version 2 or later. diff --git a/doc/pull-lp-source.1 b/doc/pull-lp-source.1 index 64ef9ea..6a05e50 100644 --- a/doc/pull-lp-source.1 +++ b/doc/pull-lp-source.1 @@ -1,23 +1,21 @@ -.TH PULL-LP-SOURCE "1" "4 August 2008" "ubuntu-dev-tools" +.TH PULL\-LP\-SOURCE "1" "4 August 2008" "ubuntu-dev-tools" .SH NAME -pull-lp-source \- download a source package from Launchpad +pull\-lp\-source \- download a source package from Launchpad .SH SYNOPSIS -.B pull-lp-source [-h] <\fBsource package\fR> [\fItarget release\fR] +.B pull\-lp\-source \fR[\fB\-h\fR]\fB <\fBsource package\fR> [\fItarget release\fR] .SH DESCRIPTION -.PP -\fBpull-lp-source\fR downloads and extracts the latest version of -<\fBsource package\fR> from Launchpad. If the optional parameter -[\fItarget release\fR] is specified, the latest version in that release -will be downloaded instead. +\fBpull\-lp\-source\fR downloads and extracts the latest version of +<\fBsource package\fR> from Launchpad. +If the optional parameter [\fItarget release\fR] is specified, the latest +version in that release will be downloaded instead. .SH OPTIONS -.PP -Listed below are the command line options for pull-lp-source: +Listed below are the command line options for pull\-lp\-source: .TP -.B \-h, --help +.B \-h, \-\-help Display a help message and exit. .TP .B <source package> @@ -34,6 +32,6 @@ Specifies the default target. .SH AUTHOR .PP -\fBpull-lp-source\fR and this manual page were written by Iain Lane -<iain@orangesquash.org.uk>. Both are released under the GNU General Public -License, version 3 or later. +\fBpull\-lp\-source\fR and this manual page were written by Iain Lane +<iain@orangesquash.org.uk>. +Both are released under the GNU General Public License, version 3 or later. diff --git a/doc/requestsync.1 b/doc/requestsync.1 index a79b4e7..956d8f2 100644 --- a/doc/requestsync.1 +++ b/doc/requestsync.1 @@ -2,46 +2,47 @@ .SH NAME requestsync \- helper to file sync requests for Ubuntu .SH SYNOPSIS -.B requestsync\fR [\fB-d distro\fR] [\fB\-ns\fR] [\fB\-k \fIkeyid\fR] <\fBsource package\fR> <\fBtarget release\fR> [\fIbase version\fR] - +.B requestsync\fR [\fB\-d distro\fR] [\fB\-ns\fR] [\fB\-k \fIkeyid\fR] <\fBsource package\fR> <\fBtarget release\fR> [\fIbase version\fR] +.br .B requestsync \-\-lp\fR [\fB\-ns\fR] <\fBsource package\fR> <\fBtarget release\fR> [\fIbase version\fR] - +.br .B requestsync \-h .SH DESCRIPTION -.PP \fBrequestsync\fR looks at the versions of <source package> in Debian and Ubuntu and prompts for an explanation of why the Ubuntu changes (if there are any) should be dropped. -The changelog entry is then downloaded from packages.debian.org. If the sync -request is being filed per email (default), a prompt for your GPG passphrase -follows so that it can sign the mail and send it off to Launchpad. +The changelog entry is then downloaded from packages.debian.org. +If the sync request is being filed per email (default), a prompt for your +GPG passphrase follows so that it can sign the mail and send it off to +Launchpad. Alternatively a sync request can be filed directly using the launchpadbugs -python module (option \fB\-\-lp\fR). \fBrequestsync\fR falls back to mail -the sync request if submitting using the launchpadbugs module fails. +python module (option \fB\-\-lp\fR). +\fBrequestsync\fR falls back to mail the sync request if submitting using +the launchpadbugs module fails. .PP \fBrequestsync\fR checks if you have the permissions to request the sync from the archive administrators directly by checking if you are a member of the -\fI~ubuntu-dev\fR team (for universe/multiverse syncs) or a member of the -\fI~ubuntu-core-dev\fR team (for main/restricted syncs) on Launchpad. If you are -not a member of the appropriate team, the script shall subscribe the necessary -team with approval rights to the bug report for you. +\fI~ubuntu\-dev\fR team (for universe/multiverse syncs) or a member of the +\fI~ubuntu\-core\-dev\fR team (for main/restricted syncs) on Launchpad. +If you are not a member of the appropriate team, the script will subscribe +the necessary team with approval rights to the bug report for you. .PP \fBrequestsync\fR uses a cookie file stored at \fI~/.lpcookie.txt\fR to -authenticate with Launchpad. This cookie is created on run from the Mozilla -Firefox cookie file at \fI~/.mozilla/*/*/cookies.sqlite\fR. +authenticate with Launchpad. +This cookie is created on run from the Mozilla Firefox cookie file at +\fI~/.mozilla/*/*/cookies.sqlite\fR. .SH OPTIONS -.PP Listed below are the command line options for requestsync: .TP .B \-h Display a help message and exit. .TP .B \-d -Specifies which Debian distribution a package should be synced from. Default is -\fIunstable\fR. +Specifies which Debian distribution a package should be synced from. +Default is \fIunstable\fR. .TP .B \-n Specifies that the package is a new package, and requestsync should not @@ -50,11 +51,11 @@ attempt to look it up in Ubuntu since it will not exist. .B \-k \fI<keyid>\fR Specifies your GPG key. Can also be set with the line `\fIexport GPGKEY=<keyid>\fR' in your shell's -configuration (For example: \fI$HOME/.bashrc\fR). +configuration (for example: \fI$HOME/.bashrc\fR). This is only used if the sync request is mailed to Launchpad. .TP .B \-\-lp -Use the launchpadbugs python module (packaged as python-launchpad-bugs) to +Use the launchpadbugs python module (packaged as python\-launchpad\-bugs) to file the sync request in Launchpad. .TP .B <source package> @@ -71,7 +72,6 @@ from the Debian package) cannot be automatically determined. Specify this option in this case. .SH ENVIRONMENT VARIABLES -.PP \fBrequestsync\fR uses the following variables which should be set in your shell's configuration by adding \fIexport VARIABLE=\fR lines, where VARIABLE is one of the following: @@ -84,8 +84,8 @@ Specifies your GnuPG key ID. Specifies which email should be used when sending to Launchpad. .TP .B DEBSMTP -Set which SMTP server to use when sending mail. If unspecified this defaults to -fioldland.ubuntu.com. +Set which SMTP server to use when sending mail. +If unspecified this defaults to fiordland.ubuntu.com. .TP .B DEBSMTP_PORT Sets which port of the SMTP server to use. Default is 25. @@ -94,11 +94,9 @@ Sets which port of the SMTP server to use. Default is 25. Sets the username and password to use when authenticating to the SMTP server. .SH SEE ALSO -.PP .BR rmadison (1) .SH AUTHOR -.PP .B requestsync and this manual page were written by the Ubuntu MOTU Team. .PP diff --git a/doc/reverse-build-depends.1 b/doc/reverse-build-depends.1 index 4c7401b..36d2f27 100644 --- a/doc/reverse-build-depends.1 +++ b/doc/reverse-build-depends.1 @@ -19,17 +19,18 @@ reverse dependencies instead. .TP \fB\-s\fP If you prefer to see all build dependencies in a single line, use this -option. Otherwise, each one will be printed on its own line. +option. +Otherwise, each one will be printed on its own line. .SH KNOWN BUGS AND LIMITATIONS Note that to use \fBreverse\-build\-depends\fP it is required for the source -repositories (deb-src lines) to be enabled in your sources.list. +repositories (deb\-src lines) to be enabled in your sources.list. .SH SEE ALSO \fBgrep\-dctrl\fR, \fBapt\-cache\fR .SH AUTHORS \fBreverse\-build\-depends\fP and this manual page were written by -Siegfried-Angel Gevatter Pujals <rainct@ubuntu.com> for YOU. Both are -released under the terms of the GNU General Public License (version 2 -or later). +Siegfried-Angel Gevatter Pujals <rainct@ubuntu.com> for YOU. +Both are released under the terms of the GNU General Public License (version +2 or later). diff --git a/doc/suspicious-source.1 b/doc/suspicious-source.1 index 967fba5..de6fb8f 100644 --- a/doc/suspicious-source.1 +++ b/doc/suspicious-source.1 @@ -9,9 +9,10 @@ suspicious\-source \- search for files that are not the GPL's .SH DESCRIPTION \fBsuspicious\-source\fP is a script that outputs a list of files which -are not common source files. This should be run in the root of a source -tree to find files which might not be the "preferred form of modification" -that the GPL and other licenses require. +are not common source files. +This should be run in the root of a source tree to find files which might +not be the "preferred form of modification" that the GPL and other licenses +require. .PP Neither the files inside version control system directories (like ".bzr/" or "CVS/"), nor those inside "debian/" are considered. diff --git a/doc/what-patch.1 b/doc/what-patch.1 index b160fed..cbca2b9 100644 --- a/doc/what-patch.1 +++ b/doc/what-patch.1 @@ -1,44 +1,40 @@ -.TH WHAT-PATCH "1" "10 August 2008" "ubuntu-dev-tools" +.TH WHAT\-PATCH "1" "10 August 2008" "ubuntu-dev-tools" .SH NAME -what-patch \- detects which patch system a Debian package uses +what\-patch \- detects which patch system a Debian package uses .SH SYNOPSIS - -.B what-patch [options] +.B what\-patch [options] .SH DESCRIPTION -.PP -\fBwhat-patch\fR examines the debian/rules file to determine which patch +\fBwhat\-patch\fR examines the debian/rules file to determine which patch system the Debian package is using. - .PP -\fBwhat-patch\fR should be run from the root directory of the Debian source +\fBwhat\-patch\fR should be run from the root directory of the Debian source package. .SH OPTIONS -.PP -Listed below are the command line options for what-patch: +Listed below are the command line options for what\-patch: .TP .B \-h or \-\-help Display a help message and exit. .TP .B \-v -Enable verbose mode. This shall include the listing of any files modified -outside or the debian/ directory and report any additional details about the -patch system if available. +Enable verbose mode. +This will include the listing of any files modified outside or the debian/ +directory and report any additional details about the patch system if +available. .SH AUTHORS -.PP -\fBwhat-patch\fR was written by Kees Cook <kees@ubuntu.com>, Siegfried-A. -Gevatter <rainct@ubuntu.com>, and Daniel Hahler <ubuntu@thequod.de>, among -others. This manual page was written by Jonathan Patrick Davies <jpds@ubuntu.com>. +\fBwhat\-patch\fR was written by Kees Cook <kees@ubuntu.com>, +Siegfried-A. Gevatter <rainct@ubuntu.com>, and Daniel Hahler +<ubuntu@thequod.de>, among others. +This manual page was written by Jonathan Patrick Davies <jpds@ubuntu.com>. .PP Both are released under the GNU General Public License, version 2. .SH SEE ALSO -.PP The Ubuntu MOTU team has some documentation about patch systems at the Ubuntu wiki: \fBhttps://wiki.ubuntu.com/PackagingGuide/PatchSystems\fR .PP -.B cdbs-edit-patch(1), dbs-edit-patch(1), dpatch-edit-patch(1) +.B cdbs\-edit\-patch(1), dbs\-edit\-patch(1), dpatch\-edit\-patch(1)