From 96f0d6dc724fdbf1f36e0d2586cf60f261896d97 Mon Sep 17 00:00:00 2001 From: Scott James Remnant Date: Fri, 7 May 2004 01:40:46 +0000 Subject: [PATCH] Fix a large collection of low-hanging-fruit documentation corrections to clean up the bug list somewhat. --- ChangeLog | 28 +++ debian/changelog | 14 ++ dpkg-deb/dpkg-deb.1 | 78 +++---- dselect/pkginfo.cc | 2 +- main/dpkg-query.8 | 36 ++-- main/dpkg.8 | 269 +++++++++++------------ man/en/dpkg.8.sgml | 1 + scripts/cleanup-info.8 | 24 +-- scripts/dpkg-checkbuilddeps.1 | 8 +- scripts/dpkg-divert.8 | 57 +++-- scripts/dpkg-name.1 | 28 +-- scripts/dpkg-scanpackages.8 | 24 +-- scripts/dpkg-source.1 | 388 +++++++++++++++++----------------- scripts/dpkg-statoverride.8 | 42 ++-- scripts/install-info.8 | 30 +-- scripts/update-alternatives.8 | 142 ++++++------- split/dpkg-split.8 | 82 +++---- utils/md5sum.1 | 20 +- utils/start-stop-daemon.8 | 135 +++++++----- utils/start-stop-daemon.c | 2 +- 20 files changed, 741 insertions(+), 669 deletions(-) diff --git a/ChangeLog b/ChangeLog index d97dfe05..443f6ff8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,31 @@ +Fri May 7 01:21:49 BST 2004 Scott James Remnant + + * dselect/pkginfo.cc: Replace &c. with the slightly clearer etc. + + * main/dpkg.8: Update from sgml, document --force-bad-verify. + * main/dpkg-query,8: Correct --list documentation, without pattern it + searches status not available. + * scripts/dpkg-divert.8: Remove obsolete reference to the Debian Packaging + Manual. + * scripts/dpkg-source.1: Rather than keeping dpkg-source(1) always up to + date with the -i option, document the intent of the default. + * scripts/dpkg-statoverride.8: Correct typo and documentation of --update. + * scripts/update-alternatives.8: Correct documentation of --install + and --remove actions. + * man/en/dpkg.8.sgml: Add missing from last commit. + * utils/start-stop-daemon.c: Correct typo. + * utils/start-stop-daemon.8: Correct --pidfile documentation and mention + what happens if you don't supply it; document that it will chdir("/") + unless -d is specified. + + * dpkg-deb/dpkg-deb.1, main/dpkg.8, main/dpkg-query.8, scripts/cleanup-info.8, + scripts/dpkg-checkbuilddeps.1, scripts/dpkg-divert.8, scripts/dpkg-name.1, + scripts/dpkg-scanpackages.8, scripts/dpkg-source.1, + scripts/dpkg-statoverride.8, scripts/install-info.8, + scripts/update-alternatives.8, split/dpkg-split.8, utils/md5sum.1, + utils/start-stop-daemon.8: Correct manpage hyphenation for those in a + UTF-8 locale. + Fri May 7 01:13:36 BST 2004 Scott James Remnant * man/en/dpkg.8.sgml: Add a new Additional Functionality section at the diff --git a/debian/changelog b/debian/changelog index 9adc3357..080594bc 100644 --- a/debian/changelog +++ b/debian/changelog @@ -21,15 +21,29 @@ dpkg (1.10.22) unstable; urgency=low * Correct documentation of --compare-versions arguments. Closes: #232317. * Correct documentation of start-stop-daemon manpage to refer to --retry alongside --stop. Closes: #204691. + * Correct documentation of dpkg-query --list. Closes: #232639. * Correct invalid use of " within update-alternatives(8) with .BR. Closes: #244624. + * Correct documentation of start-stop-daemon. Closes: #41554, #211856. + * Correct documentation of dpkg-statoverride --update. Closes: #85079. + * Correct documentation of update-alternatives --install. Closes: #179648. + * Correct various typos. Closes: #219623, #221235. + * Correct hyphen characters in manpages. Closes: #212284, #247086, #226800. * Add dpkg-reconfigure(8) to SEE ALSO section of dpkg(8). Closes: #233282. + * Add --force-bad-verify to dpkg manpage. Closes: #192812. + * Add note that start-stop-daemon will chdir("/") unless -d is specified. + Closes: #217823, #218060. * Suggest aptitude as well as dselect. Closes: #217042. * Suggest fakeroot for dpkg-source -r. Closes: #175897. * Suggest dselect update in description of dpkg --update-avail. Closes: #206163. * Suggest packages that provide additional functionality in the dpkg manpage. Closes: #81355. + * Remove obsolete references to the Debian Packaging Manual. + Closes: #122910, #140695. + * Replace "&c." with the slightly clearer "etc.". Closes: #235773. + * Rewrite description of dpkg-source -i to indicate the intent of the + default setting rather than the exact exclusions. Closes: #227169. * Updated Translations: - Catalan (Jordi Mallach). - French (Christian Perrier). Closes: #246359. diff --git a/dpkg-deb/dpkg-deb.1 b/dpkg-deb/dpkg-deb.1 index 14d88e31..6db9f21a 100644 --- a/dpkg-deb/dpkg-deb.1 +++ b/dpkg-deb/dpkg-deb.1 @@ -1,34 +1,34 @@ .TH DPKG\-DEB 1 "1st June 1996" "Debian Project" "dpkg suite" .SH NAME -dpkg\-deb \- Debian package archive (.deb) manipulation tool +dpkg\-deb - Debian package archive (.deb) manipulation tool .SH SYNOPSIS -.B dpkg-deb -.BR -b | --build +.B dpkg\-deb +.BR \-b | \-\-build .IR directory " [" archive | directory ] .br -.B dpkg-deb -.BR -I | --info -.IR archive " [" control\-file\-name " ..]" +.B dpkg\-deb +.BR \-I | \-\-info +.IR archive " [" control-file-name " ..]" .br -.B dpkg-deb -.BR -f | --field -.IR archive " [" control\-field\-name " ...]" +.B dpkg\-deb +.BR \-f | \-\-field +.IR archive " [" control-field-name " ...]" .br -.B dpkg-deb -.BR -c | --contents +.B dpkg\-deb +.BR \-c | \-\-contents .I archive .br -.B dpkg-deb -.BR -x | --extract | -X | --vextract +.B dpkg\-deb +.BR \-x | \-\-extract | \-X | \-\-vextract .I archive directory .br -.B dpkg-deb --fsys-tarfile +.B dpkg\-deb \-\-fsys\-tarfile .I archive .br -.B dpkg-deb --control +.B dpkg\-deb \-\-control .I archive directory .SH DESCRIPTION -.B dpkg-deb +.B dpkg\-deb packs, unpacks and provides information about Debian archives. Use @@ -46,7 +46,7 @@ will spot that you wanted and run it for you. .SH ACTION OPTIONS .TP -.BR --build ", " -b +.BR \-\-build ", " \-b Creates a debian archive from the filesystem tree stored in .IR directory ". " directory must have a @@ -61,7 +61,7 @@ information area. You can specify the compressionlevel used by adding a .B \-z# option. -.B dpkg-deb +.B dpkg\-deb will pass that option on to gzip. Unless you specify @@ -101,23 +101,23 @@ option may not be used (since needs to read and parse the package control file to determine which filename to use). .TP -.BR \-\-info ", " -I +.BR \-\-info ", " \-I Provides information about a binary package archive. If no -.IR control\-file\-name s +.IR control-file-name s are specified then it will print a summary of the contents of the package as well as its control file. If any -.IR control\-file\-name s +.IR control-file-name s are specified then .B dpkg\-deb will print them in the order they were specified; if any of the components weren't present it will print an error message to stderr about each one and exit with status 2. .TP -.BR \-\-field ", " -f +.BR \-\-field ", " \-f Extracts control file information from a binary package archive. If no @@ -135,19 +135,19 @@ will precede each with its field name (and a colon and space). No errors are reported for fields requested but not found. .TP -.BR --contents ", " -c +.BR \-\-contents ", " \-c Lists the contents of the filesystem tree archive portion of the package archive. It is currently produced in the format generated by .BR tar 's verbose listing. .TP -.BR --extract ", " -x ", " \-\-vextract ", " -X +.BR \-\-extract ", " \-x ", " \-\-vextract ", " \-X Extracts the filesystem tree from a package archive into the specified directory. -.BR \-\-vextract " (" -X ")" +.BR \-\-vextract " (" \-X ")" prints a listing of the files extracted as it goes, while -.BR \-\-extract " (" -x ")" +.BR \-\-extract " (" \-x ")" is silent unless an error occurs. Note that extracting a package to the root directory will @@ -159,15 +159,15 @@ to install packages. .I directory (but not its parents) will be created if necessary. .TP -.BR --fsys-tarfile +.BR \-\-fsys\-tarfile Extracts the filesystem tree data from a binary package and sends it to standard output in .B tar format. Together with -.B tar +.BR tar (1) this can be used to extract a particular file from a package archive. .TP -.BR --control ", " -e +.BR \-\-control ", " \-e Extracts the control information files from a package archive into the specified directory. @@ -178,17 +178,17 @@ in the current directory is used. The target directory (but not its parents) will be created if necessary. .TP -.BR --help ", " -h +.BR \-\-help ", " \-h Prints .BR dpkg\-deb 's usage message, giving a summary of its options and their uses. .TP -.BR --version +.BR \-\-version Prints .BR dpkg\-deb 's version number. .TP -.BR --licence +.BR \-\-licence Prints information about .BR dpkg\-deb 's copyright licensing and lack of warranty. (The American spelling @@ -196,12 +196,12 @@ copyright licensing and lack of warranty. (The American spelling is also supported.) .SH OTHER OPTIONS .TP -.BR --new +.BR \-\-new Ensures that .B dpkg\-deb builds a `new' format archive. This is the default. .TP -.BR --old +.BR \-\-old Forces .B dpkg\-deb to build an `old' format archive. This old archive format is less @@ -209,16 +209,16 @@ easily parsed by non-Debian tools and is now obsolete; its only use is when building packages to be parsed by versions of dpkg older than 0.93.76 (September 1995), which was released as i386 a.out only. .TP -.BR --nocheck +.BR \-\-nocheck Inhibits .BR "dpkg\-deb \-\-build" 's usual checks on the proposed contents of an archive. You can build any archive you want, no matter how broken, this way. .TP -.BR --debug ", " -D +.BR \-\-debug ", " \-D Enables debugging output. This is not very interesting. .SH BUGS -.B dpkg-deb -I +.B dpkg\-deb \-I .IB package1 .deb .IB package2 .deb does the wrong thing. @@ -235,7 +235,7 @@ proper to ensure that all the files are correctly placed and the package's scripts run and its status and contents recorded. .SH SEE ALSO .BR deb (5), -.BR deb-control (5), +.BR deb\-control (5), .BR dpkg (8), .BR dselect (8). .SH AUTHOR @@ -246,5 +246,5 @@ by him and released under the GNU General Public Licence; there is NO WARRANTY. See .B /usr/share/doc/dpkg/copyright and -.B /usr/share/common-licenses/GPL +.B /usr/share/common\-licenses/GPL for details. diff --git a/dselect/pkginfo.cc b/dselect/pkginfo.cc index 6c8aeb02..e9c286ce 100644 --- a/dselect/pkginfo.cc +++ b/dselect/pkginfo.cc @@ -80,7 +80,7 @@ void packagelist::severalinfoblurb(const char *whatinfoline) { whatinfovb(whatinfoline); varbuf vb; vb(_("The line you have highlighted represents many packages; " - "if you ask to install, remove, hold, &c it you will affect all " + "if you ask to install, remove, hold, etc. it you will affect all " "the packages which match the criterion shown.\n" "\n" "If you move the highlight to a line for a particular package " diff --git a/main/dpkg-query.8 b/main/dpkg-query.8 index 4d1ae142..4f34554f 100644 --- a/main/dpkg-query.8 +++ b/main/dpkg-query.8 @@ -3,18 +3,18 @@ dpkg\-query \- a tool to query the dpkg database .SH SYNOPSIS -.B dpkg-query +.B dpkg\-query .SH DESCRIPTION -\fBdpkg-query\fP is a tool to show information about packages listed in +\fBdpkg\-query\fP is a tool to show information about packages listed in the \fBdpkg\fP database. .SH COMMANDS .TP -\fB-l\fP | \fB--list\fP \fIpackage-name-pattern\fP ... +\fB\-l\fP | \fB\-\-list\fP \fIpackage-name-pattern\fP ... List packages matching given pattern. If no \fIpackage-name-pattern\fP -is given, list all packages in \fI/var/lib/dpkg/available\fP. Normal +is given, list all packages in \fI/var/lib/dpkg/status\fP. Normal shell wildchars are allowed in \fIpackage-name-pattern\fP. Please note you will probably have to quote \fIpackage-name-pattern\fP to prevent the shell from performing filename expansion. For example this will @@ -22,47 +22,47 @@ list all package names starting with \*(lqlibc5\*(rq: .T .nf - \fBdpkg-query -l 'libc5*'\fP + \fBdpkg\-query \-l 'libc5*'\fP .fi .TP -\fB-W\fP | \fB--show\fP \fIpackage-name-pattern\fP ... -Just like the \fB--list\fP option this will list all packages matching +\fB\-W\fP | \fB\-\-show\fP \fIpackage-name-pattern\fP ... +Just like the \fB\-\-list\fP option this will list all packages matching the given pattern. However the output can be customized using the -\fB--showformat\fP option. +\fB\-\-showformat\fP option. .TP -\fB-s\fP | \fB--status\fP \fIpackage-name\fP ... +\fB\-s\fP | \fB\-\-status\fP \fIpackage-name\fP ... Report status of specified package. This just displays the entry in the installed package status database. .TP -\fB-L\fP | \fB--listfiles\fP \fIpackage\fP ... +\fB\-L\fP | \fB\-\-listfiles\fP \fIpackage\fP ... List files installed to your system from \fBpackage\fP. However, note that files created by package-specific installation-scripts are not listed. .TP -\fB-S\fP | \fB--search\fP \fIfilename-search-pattern\fP ... +\fB\-S\fP | \fB\-\-search\fP \fIfilename-search-pattern\fP ... Search for a filename from installed packages. All standard shell wildchars can be used in the pattern. This command will not list extra files created by maintainer scripts, nor will it list alternatives. .TP -\fB-p\fP |\fB--print-avail\fP package +\fB\-p\fP |\fB\-\-print\-avail\fP package Display details about \fIpackage\fP, as found in \fI/var/lib/dpkg/available\fP. .TP -\fB--licence\fP | \fB--license\fP +\fB\-\-licence\fP | \fB\-\-license\fP Display licence and copyright information. .TP -\fB--version\fP +\fB\-\-version\fP Display version information. .SH OPTIONS .TP -\fB--admindir=\fIdir\fP +\fB\-\-admindir=\fIdir\fP Change the location of the \fBdpkg\fR database. The default location is \fI/var/lib/dpkg\fP. .TP -\fB--showformat=\fP\fIformat\fR -This option is used to specify the format of the output \fB--show\fP +\fB\-\-showformat=\fP\fIformat\fR +This option is used to specify the format of the output \fB\-\-show\fP will produce. The format is a string that will be output for each package listed. It can include the standard escape sequences \en (newline), \er (carriage return) or \e\e (plain backslash). Package information can be @@ -73,7 +73,7 @@ width is negative in which case left alignment will be used. .SH ENVIRONMENT .TP \fBCOLUMNS\fP -This setting influences the output of the \fB--list\fP option by changing +This setting influences the output of the \fB\-\-list\fP option by changing the width of its output. .SH AUTHOR diff --git a/main/dpkg.8 b/main/dpkg.8 index 3b2e8834..17466d34 100644 --- a/main/dpkg.8 +++ b/main/dpkg.8 @@ -1,6 +1,6 @@ .TH DPKG 8 "April 12, 1998" "Debian Project" "dpkg suite" .SH NAME -dpkg \- a medium-level package manager for Debian +dpkg - a medium-level package manager for Debian .SH SYNOPSIS .B dpkg @@ -9,16 +9,12 @@ dpkg \- a medium-level package manager for Debian .SH WARNING This manual is intended for users wishing to understand \fBdpkg\fP's command line options and package states in more detail than that -provided by \fBdpkg --help\fP. +provided by \fBdpkg \-\-help\fP. It should \fInot\fP be used by package maintainers wishing to understand how \fBdpkg\fP will install their packages. The descriptions of what \fBdpkg\fP does when installing and removing -packages are particularly inadequate. For detailed information about -this, please refer to the \fIPackage Management System\fP topic under -\fIdebian-faq\fP in the GNU Info system. For information about -creating Debian packages, see the \fIDebian Package Management -Tools\fP topic in the same place. +packages are particularly inadequate. .SH DESCRIPTION \fBdpkg\fP is a medium-level tool to install, build, remove and manage @@ -28,21 +24,21 @@ controlled entirely via command line parameters, which consist of exactly one action and zero or more options. The action-parameter tells dpkg what to do and options control the behavior of the action in some way. -\fBdpkg\fP can be also be used as a front-end to \fBdpkg-deb\fP. +\fBdpkg\fP can be also be used as a front-end to \fBdpkg\-deb\fP. The following -are \fBdpkg-deb\fP actions, and if they are encountered, \fBdpkg\fP -just runs \fBdpkg-deb\fP with the parameters given to it: +are \fBdpkg\-deb\fP actions, and if they are encountered, \fBdpkg\fP +just runs \fBdpkg\-deb\fP with the parameters given to it: .nf - \fB-b\fP, \fB--build\fP, - \fB-c\fP, \fB--contents\fP, - \fB-I\fP, \fB--info\fP, - \fB-f\fP, \fB--field\fP, - \fB-e\fP, \fB--control\fP, - \fB-x\fP, \fB--extract\fP, - \fB-X\fP, \fB--vextract\fP, and - \fB--fsys-tarfile\fP. + \fB\-b\fP, \fB\-\-build\fP, + \fB\-c\fP, \fB\-\-contents\fP, + \fB\-I\fP, \fB\-\-info\fP, + \fB\-f\fP, \fB\-\-field\fP, + \fB\-e\fP, \fB\-\-control\fP, + \fB\-x\fP, \fB\-\-extract\fP, + \fB\-X\fP, \fB\-\-vextract\fP, and + \fB\-\-fsys\-tarfile\fP. .fi -Please refer to \fBdpkg-deb\fP(1) for information about these actions. +Please refer to \fBdpkg\-deb\fP(1) for information about these actions. .SH INFORMATION ABOUT PACKAGES \fBdpkg\fP maintains some usable information about available @@ -54,21 +50,21 @@ be changed mainly with \fBdselect\fP. .B installed The package is unpacked and configured OK. .TP -.B half-installed +.B half\-installed The installation of the package has been started, but not completed for some reason. .TP -.B not-installed +.B not\-installed The package is not installed on your system. .TP .B unpacked The package is unpacked, but not configured. .TP -.B half-configured +.B half\-configured The package is unpacked and configuration has been started, but not yet completed for some reason. .TP -.B config-files +.B config\-files Only the configuration files of the package exist on the system. .SS PACKAGE SELECTION STATES .TP @@ -86,17 +82,17 @@ even configuration files). .TP .B hold A package marked to be on \fBhold\fP is not handled by \fBdpkg\fP, -unless forced to do that with option \fB--force-hold\fP. +unless forced to do that with option \fB\-\-force\-hold\fP. .TP -.B reinst-required -A package marked \fBreinst-required\fP is broken and requires +.B reinst\-required +A package marked \fBreinst\-required\fP is broken and requires reinstallation. These packages cannot be removed, unless forced with -option \fB--force-remove-reinstreq\fP. +option \fB\-\-force\-remove\-reinstreq\fP. .SH ACTIONS .TP -\fBdpkg -i\fP | \fB--install\fP \fIpackage_file\fP... -Install the package. If \fB--recursive\fP or \fB-R\fP option is +\fBdpkg \-i\fP | \fB\-\-install\fP \fIpackage_file\fP... +Install the package. If \fB\-\-recursive\fP or \fB\-R\fP option is specified, \fIpackage_file\fP must refer to a directory instead. Installation consists of the following steps: @@ -123,16 +119,16 @@ script of the new package, because new files are written at the same time old files are removed. .br -\fB6.\fP Configure the package. See \fB--configure\fP for detailed +\fB6.\fP Configure the package. See \fB\-\-configure\fP for detailed information about how this is done. .TP -\fBdpkg --unpack \fP\fIpackage_file\fP ... -Unpack the package, but don't configure it. If \fB--recursive\fP or -\fB-R\fP option is specified, \fIpackage_file\fP must refer to a +\fBdpkg \-\-unpack \fP\fIpackage_file\fP ... +Unpack the package, but don't configure it. If \fB\-\-recursive\fP or +\fB\-R\fP option is specified, \fIpackage_file\fP must refer to a directory instead. .TP -\fBdpkg --configure \fP\fIpackage\fP ... | \fB-a\fP | \fB--pending\fP -Reconfigure an unpacked package. If \fB-a\fP or \fB--pending\fP is +\fBdpkg \-\-configure \fP\fIpackage\fP ... | \fB\-a\fP | \fB\-\-pending\fP +Reconfigure an unpacked package. If \fB\-a\fP or \fB\-\-pending\fP is given instead of \fIpackage\fP, all unpacked but unconfigured packages are configured. @@ -146,13 +142,13 @@ something goes wrong. \fB2.\fP Run \fIpostinst\fP script, if provided by the package. .TP -\fBdpkg -r\fP | \fB--remove\fP | \fB-P\fP | \fB--purge \fP\fIpackage\fP ... | \fB-a\fP | \fB--pending\fP -Remove an installed package. \fB-r\fP or \fB--remove\fP remove +\fBdpkg \-r\fP | \fB\-\-remove\fP | \fB\-P\fP | \fB\-\-purge \fP\fIpackage\fP ... | \fB\-a\fP | \fB\-\-pending\fP +Remove an installed package. \fB\-r\fP or \fB\-\-remove\fP remove everything except configuration files. This may avoid having to reconfigure the package if it is reinstalled later. (Configuration files are the files listed in the \fIdebian/conffiles\fP control -file). \fB-P\fP or \fB--purge\fP removes everything, including configuration -files. If \fB-a\fP or \fB--pending\fP is given instead of a package +file). \fB\-P\fP or \fB\-\-purge\fP removes everything, including configuration +files. If \fB\-a\fP or \fB\-\-pending\fP is given instead of a package name, then all packages unpacked, but marked to be removed or purged in file \fI/var/lib/dpkg/status\fP, are removed or purged, respectively. @@ -169,123 +165,126 @@ Removing of a package consists of the following steps: \fB3.\fP Run \fIpostrm\fP script .br .TP -\fBdpkg --update-avail\fP | \fB--merge-avail\fP \fIPackages-file\fP +\fBdpkg \-\-update\-avail\fP | \fB\-\-merge\-avail\fP \fIPackages-file\fP Update \fBdpkg\fP's and \fBdselect\fP's idea of which packages are -available. With action \fB--merge-avail\fP, old information is +available. With action \fB\-\-merge\-avail\fP, old information is combined with information from \fIPackages-file\fP. With action -\fB--update-avail\fP, old information is replaced with the information +\fB\-\-update\-avail\fP, old information is replaced with the information in the \fIPackages-file\fP. The \fIPackages-file\fP distributed with Debian is simply named \fIPackages\fP. \fBdpkg\fP keeps its record of available packages in \fI/var/lib/dpkg/available\fP. + +A simpler one-shot command to retrieve and update the \fIavailable\fR +fileis \fBdselect update\fR. .TP -\fBdpkg -A\fP | \fB--record-avail\fP \fIpackage_file\fP ... +\fBdpkg \-A\fP | \fB\-\-record\-avail\fP \fIpackage_file\fP ... Update \fBdpkg\fP and \fBdselect\fP's idea of which packages are available with information from the package \fIpackage_file\fP. If -\fB--recursive\fP or \fB-R\fP option is specified, \fIpackage_file\fP +\fB\-\-recursive\fP or \fB\-R\fP option is specified, \fIpackage_file\fP must refer to a directory instead. .TP -.B dpkg --forget-old-unavail +.B dpkg \-\-forget\-old\-unavail Forget about uninstalled unavailable packages. .TP -.B dpkg --clear-avail +.B dpkg \-\-clear\-avail Erase the existing information about what packages are available. .TP -\fBdpkg -C\fP | \fB--audit\fP +\fBdpkg \-C\fP | \fB\-\-audit\fP Searches for packages that have been installed only partially on your system. \fBdpkg\fP will suggest what to do with them to get them working. .TP -\fBdpkg --get-selections\fP [\fIpattern\fP...] +\fBdpkg \-\-get\-selections\fP [\fIpattern\fP...] Get list of package selections, and write it to stdout. .TP -.B dpkg --set-selections +.B dpkg \-\-set\-selections Set package selections using file read from stdin. .TP -.B dpkg --yet-to-unpack +.B dpkg \-\-yet\-to\-unpack Searches for packages selected for installation, but which for some reason still haven't been installed. .TP .TP -.B dpkg --print-architecture +.B dpkg \-\-print\-architecture Print target architecture (for example, "i386"). This option uses \fBgcc\fP. .TP -.B dpkg --print-gnu-build-architecture +.B dpkg \-\-print\-gnu\-build\-architecture Print GNU version of target architecture (for example, "i486"). .TP -.B dpkg --print-installation-architecture +.B dpkg \-\-print\-installation\-architecture Print host architecture for installation. .TP -.B dpkg --compare-versions \fIver1 op ver2\fP +.B dpkg \-\-compare\-versions \fIver1 op ver2\fP Compare version numbers, where \fIop\fP is a binary operator. \fBdpkg\fP returns success (zero result) if the specified condition is satisfied, and failure (nonzero result) otherwise. There are -two groups of operators, which differ in how they treat a missing -\fIver1\fP or \fIver2\fP. These treat no version as earlier than any -version: \fBlt le eq ne ge gt\fP. These treat no version as later -than any version: \fBlt-nl le-nl ge-nl gt-nl\fP. These are provided +two groups of operators, which differ in how they treat an empty +\fIver1\fP or \fIver2\fP. These treat an empty version as earlier than any +version: \fBlt le eq ne ge gt\fP. These treat an empty version as later +than any version: \fBlt\-nl le\-nl ge\-nl gt\-nl\fP. These are provided only for compatibility with control file syntax: \fB< << <= = >= >> >\fP. .TP -.B dpkg --command-fd +.B dpkg \-\-command\-fd Accept a series of commands on input file descriptor \fB\fP. Note: additional options set on the command line, and thru this file descriptor, are not reset for subsequent commands executed during the same run. .TP -.B dpkg --help +.B dpkg \-\-help Display a brief help message. .TP -.B dpkg --force-help -Give help about the \fB--force-\fP\fIthing\fP options. +.B dpkg \-\-force\-help +Give help about the \fB\-\-force\-\fP\fIthing\fP options. .TP -.BR "dpkg -Dh " | " --debug=help" +.BR "dpkg \-Dh " | " \-\-debug=help" Give help about debugging options. .TP -\fBdpkg --licence\fP | \fBdpkg --license\fP +\fBdpkg \-\-licence\fP | \fBdpkg \-\-license\fP Display \fBdpkg\fP licence. .TP -\fBdpkg --version\fP +\fBdpkg \-\-version\fP Display \fBdpkg\fP version information. .TP -\fBdpkg-deb-actions\fP -See \fBdpkg-deb\fP(1) for more information about the following actions. +\fBdpkg\-deb\-actions\fP +See \fBdpkg\-deb\fP(1) for more information about the following actions. .nf -\fBdpkg -b\fP | \fB--build\fP \fIdirectory\fP [\fIfilename\fP] +\fBdpkg \-b\fP | \fB\-\-build\fP \fIdirectory\fP [\fIfilename\fP] Build a deb package. -\fBdpkg -c\fP | \fB--contents\fP \fIfilename\fP +\fBdpkg \-c\fP | \fB\-\-contents\fP \fIfilename\fP List contents of a deb package. -\fBdpkg -e\fP | \fB--control\fP \fIfilename\fP [\fIdirectory\fP] +\fBdpkg \-e\fP | \fB\-\-control\fP \fIfilename\fP [\fIdirectory\fP] Extract control-information from a package. -\fBdpkg -x\fP | \fB--extract\fP \fIfilename directory\fP +\fBdpkg \-x\fP | \fB\-\-extract\fP \fIfilename directory\fP Extract the files contained by package. -\fBdpkg -f\fP | \fB--field\fP \fIfilename\fP [\fIcontrol-field\fP] ... +\fBdpkg \-f\fP | \fB\-\-field\fP \fIfilename\fP [\fIcontrol-field\fP] ... Display control field(s) of a package. -\fBdpkg --fsys-tarfile\fP \fIfilename\fP +\fBdpkg \-\-fsys\-tarfile\fP \fIfilename\fP Display the filesystem tar-file contained by a Debian package. -\fBdpkg -I\fP | \fB--info\fP \fIfilename\fP [\fIcontrol-file\fP] +\fBdpkg \-I\fP | \fB\-\-info\fP \fIfilename\fP [\fIcontrol-file\fP] Show information about a package. -\fBdpkg -X\fP | \fB--vextract\fP \fIfilename\fP \fIdirectory\fP +\fBdpkg \-X\fP | \fB\-\-vextract\fP \fIfilename\fP \fIdirectory\fP Extract and display the filenames contained by a package. .fi .TP -\fBdpkg-query-actions\fP -See \fBdpkg-query\fP(1) for more information about the following actions. +\fBdpkg\-query-actions\fP +See \fBdpkg\-query\fP(1) for more information about the following actions. .nf -\fBdpkg -l\fP | \fB--list\fP \fIpackage-name-pattern\fP ... +\fBdpkg \-l\fP | \fB\-\-list\fP \fIpackage-name-pattern\fP ... List packages matching given pattern. -\fBdpkg -s\fP | \fB--status\fP \fIpackage-name\fP ... +\fBdpkg \-s\fP | \fB\-\-status\fP \fIpackage-name\fP ... Report status of specified package. -\fBdpkg -L\fP | \fB--listfiles\fP \fIpackage\fP ... +\fBdpkg \-L\fP | \fB\-\-listfiles\fP \fIpackage\fP ... List files installed to your system from \fBpackage\fP. -\fBdpkg -S\fP | \fB--search\fP \fIfilename-search-pattern\fP ... +\fBdpkg \-S\fP | \fB\-\-search\fP \fIfilename-search-pattern\fP ... Search for a filename from installed packages. -\fBdpkg -p\fP | \fB--print-avail\fP \fIpackage\fP +\fBdpkg \-p\fP | \fB\-\-print\-avail\fP \fIpackage\fP Display details about \fIpackage\fP, as found in \fI/var/lib/dpkg/available\fP. .fi @@ -298,19 +297,19 @@ file is either an option (exactly the same as the commandline option but without leading dashes) or a comment (if it starts with a \fB#\fR). .br .TP -\fB--abort-after=\fP\fInumber\fP +\fB\-\-abort\-after=\fP\fInumber\fP Change after how many errors dpkg will abort. The default is 50. .TP -.BR -B | --auto-deconfigure +.BR \-B | \-\-auto\-deconfigure When a package is removed, there is a possibility that another installed package depended on the removed package. Specifying this option will cause automatic deconfiguration of the package which depended on the removed package. .TP -\fB-D\fIoctal\fP | \fB--debug=\fP\fIoctal\fP +\fB\-D\fIoctal\fP | \fB\-\-debug=\fP\fIoctal\fP Set debugging on. \fIoctal\fP is formed by bitwise-orring desired values together from the list below (note that these values may change -in future releases). \fB-Dh\fP or \fB--debug=help\fP display these +in future releases). \fB\-Dh\fP or \fB\-\-debug=help\fP display these debugging values. number description @@ -325,11 +324,11 @@ debugging values. 1000 Lots of drivel about e.g. the dpkg/info dir 2000 Insane amounts of drivel .TP -\fB--force-\fP\fIthings\fP | \fB--no-force-\fP\fIthings\fP | \fB--refuse-\fP\fIthings\fP +\fB\-\-force\-\fP\fIthings\fP | \fB\-\-no\-force\-\fP\fIthings\fP | \fB\-\-refuse\-\fP\fIthings\fP -Force or refuse (\fBno-force\fP and \fBrefuse\fP mean the same thing) +Force or refuse (\fBno\-force\fP and \fBrefuse\fP mean the same thing) to do some things. \fIthings\fP is a comma separated list of things -specified below. \fB--force-help\fP displays a message describing them. +specified below. \fB\-\-force\-help\fP displays a message describing them. Things marked with (*) are forced by default. \fIWarning: These options are mostly intended to be used by experts @@ -339,7 +338,7 @@ your whole system.\fP \fBall\fP: Turns on(or off) all force options. -\fBauto-select\fP(*): +\fBauto\-select\fP(*): Select packages to install them, and deselect packages to remove them. \fBdowngrade\fP(*): @@ -352,19 +351,19 @@ package. This can have serious side effects, downgrading essential system components can even make your whole system unusable. Use with care.\fP -\fBconfigure-any\fP: +\fBconfigure\-any\fP: Configure also any unpacked but unconfigured packages on which the current package depends. \fBhold\fP: Process packages even when marked "hold". -\fBremove-reinstreq\fP: +\fBremove\-reinstreq\fP: Remove a package, even if it's broken and marked to require reinstallation. This may, for example, cause parts of the package to remain on the system, which will then be forgotten by \fBdpkg\fP. -\fBremove-essential\fP: +\fBremove\-essential\fP: Remove, even if the package is considered essential. Essential packages contain mostly very basic Unix commands. Removing them might cause the whole system to stop working, so use with caution. @@ -372,7 +371,7 @@ cause the whole system to stop working, so use with caution. \fBdepends\fP: Turn all dependency problems into warnings. -\fBdepends-version\fP: +\fBdepends\-version\fP: Don't care about versions when checking dependencies. \fBconflicts\fP: @@ -386,72 +385,75 @@ file. \fBconfnew\fP: If a conffile has been modified always install the new version without -prompting, unless the \fB--force-confdef\fP is also specified, in +prompting, unless the \fB\-\-force\-confdef\fP is also specified, in which case the default action is preferred. \fBconfold\fP: If a conffile has been modified always keep the old version without -prompting, unless the \fB--force-confdef\fP is also specified, in +prompting, unless the \fB\-\-force\-confdef\fP is also specified, in which case the default action is preferred. \fBconfdef\fP: If a conffile has been modified always choose the default action. If there is no default action it will stop to ask the user unless -\fB--force-confnew\fP or \fB--force-confold\fP is also been given, in +\fB\-\-force\-confnew\fP or \fB\-\-force\-confold\fP is also been given, in which case it will use that to decide the final action. \fBoverwrite\fP: Overwrite one package's file with another's file. -\fBoverwrite-dir\fP +\fBoverwrite\-dir\fP Overwrite one package's directory with another's file. -\fBoverwrite-diverted\fP: +\fBoverwrite\-diverted\fP: Overwrite a diverted file with an undiverted version. \fBarchitecture\fP: Process even packages with the wrong architecture. -\fBbad-path\fP: +\fBbad\-path\fP: \fBPATH\fP is missing important programs, so problems are likely. -\fBnot-root\fP: +\fBnot\-root\fP: Try to (de)install things even when not root. +\fBbad\-verify\fP: +Install a package even if it fails authenticity check. + .TP -\fB--ignore-depends\fP=\fIpackage\fP,... +\fB\-\-ignore\-depends\fP=\fIpackage\fP,... Ignore dependency-checking for specified packages (actually, checking is performed, but only warnings about conflicts are given, nothing else). .TP -\fB--new\fP | \fB--old\fP -Select new or old binary package format. This is a \fBdpkg-deb\fP(1) +\fB\-\-new\fP | \fB\-\-old\fP +Select new or old binary package format. This is a \fBdpkg\-deb\fP(1) option. .TP -.B --nocheck +.B \-\-nocheck Don't read or check contents of control file while building a package. -This is a \fBdpkg-deb\fP(1) option. +This is a \fBdpkg\-deb\fP(1) option. .TP -\fB--no-act\fP | \fB--dry-run\fP | \fB--simulate\fP +\fB\-\-no\-act\fP | \fB\-\-dry\-run\fP | \fB\-\-simulate\fP Do everything which is supposed to be done, but don't write any changes. This is used to see what would happen with the specified action, without actually modifying anything. -Be sure to give \fB--no-act\fP before the action-parameter, or you might -end up with undesirable results. (e.g. \fBdpkg --purge foo ---no-act\fP will first purge package foo and then try to purge package ---no-act, even though you probably expected it to actually do nothing) +Be sure to give \fB\-\-no\-act\fP before the action-parameter, or you might +end up with undesirable results. (e.g. \fBdpkg \-\-purge foo +\-\-no\-act\fP will first purge package foo and then try to purge package +\-\-no\-act, even though you probably expected it to actually do nothing) .TP -\fB-R\fP | \fB--recursive\fP +\fB\-R\fP | \fB\-\-recursive\fP Recursively handle all regular files matching pattern \fB*.deb\fP found at specified directories and all of its subdirectories. This can -be used with \fB-i\fP, \fB-A\fP, \fB--install\fP, \fB--unpack\fP and -\fB--avail\fP actions. +be used with \fB\-i\fP, \fB\-A\fP, \fB\-\-install\fP, \fB\-\-unpack\fP and +\fB\-\-avail\fP actions. .TP -\fB-G\fP +\fB\-G\fP Don't install a package if a newer version of the same package is already -installed. This is an alias of \fB--refuse-downgrade.\fP +installed. This is an alias of \fB\-\-refuse\-downgrade.\fP .TP -\fB--root=\fP\fIdir\fP | \fB--admindir=\fP\fIdir\fP | \fB--instdir=\fP\fIdir\fP +\fB\-\-root=\fP\fIdir\fP | \fB\-\-admindir=\fP\fIdir\fP | \fB\-\-instdir=\fP\fIdir\fP Change default directories. \fBadmindir\fP defaults to \fI/var/lib/dpkg\fP and contains many files that give information about status of installed or uninstalled packages, etc. \fBinstdir\fP @@ -462,17 +464,17 @@ means that the scripts see \fBinstdir\fP as a root directory. Changing \fBroot\fP changes \fBinstdir\fP to \fIdir\fP and \fBadmindir\fP to \fIdir\fP\fB/var/lib/dpkg\fP. .TP -\fB-O\fP | \fB--selected-only\fP +\fB\-O\fP | \fB\-\-selected\-only\fP Only process the packages that are selected for installation. The actual marking is done with \fBdselect\fP or by \fBdpkg\fP, when it handles packages. For example, when a package is removed, it will be marked selected for deinstallation. .TP -.BR -E " | " --skip-same-version +.BR \-E " | " \-\-skip\-same\-version Don't install the package if the same version of the package is already installed. .TP -\fB--status-fd \fP\fI\fP +\fB\-\-status\-fd \fP\fI\fP Send package status info to file descriptor \fI\fP. This can be given multiple times. Status updates are of the form `status: : '. .SH FILES @@ -481,7 +483,7 @@ multiple times. Status updates are of the form `status: : '. Configuration file with default options. .P The other files listed below are in their default directories, see option -\fB--admindir\fP to see how to change locations of these files. +\fB\-\-admindir\fP to see how to change locations of these files. .TP .I /var/lib/dpkg/available List of available packages. @@ -518,7 +520,7 @@ The program \fBdpkg\fP will execute while starting a new shell. .TP .B COLUMNS Sets the number of columns \fBdpkg\fP should use when displaying formatted -text. Currently only used by -l. +text. Currently only used by \-l. .TP .B DPKG_OLD_CONFFILE Set by \fBdpkg\fP to the filename of the old configuration file @@ -533,12 +535,12 @@ file. .SH EXAMPLES To list packages related to the editor vi: .br -\fB dpkg -l '*vi*'\fP +\fB dpkg \-l '*vi*'\fP .br To see the entries in \fI/var/lib/dpkg/available\fP on two packages: .br -\fB dpkg --print-avail elvis vim | less\fP +\fB dpkg \-\-print\-avail elvis vim | less\fP .br To search the listing of packages yourself: @@ -548,7 +550,7 @@ To search the listing of packages yourself: To remove an installed elvis package: .br -\fB dpkg -r elvis\fP +\fB dpkg \-r elvis\fP .br To install a package, you first need to find it in an archive or @@ -556,18 +558,18 @@ CDROM. The "available" file shows that the vim package is in section "editors": .br \fB cd /cdrom/hamm/hamm/binary/editors\fP -\fB dpkg -i vim_4.5-3.deb\fP +\fB dpkg \-i vim_4.5\-3.deb\fP .br To make a local copy of the package selection states: .br -\fB dpkg --get-selections >myselections\fP +\fB dpkg \-\-get\-selections >myselections\fP .br You might transfer this file to another computer, and install it there with: .br -\fB dpkg --set-selections apt, aptitude and debsums. + diff --git a/scripts/cleanup-info.8 b/scripts/cleanup-info.8 index 2f1c9b29..66bcce4d 100644 --- a/scripts/cleanup-info.8 +++ b/scripts/cleanup-info.8 @@ -1,12 +1,12 @@ -.TH CLEANUP-INFO 8 "November 1999" "Debian Project" "dpkg utilities" +.TH CLEANUP\-INFO 8 "November 1999" "Debian Project" "dpkg utilities" .SH NAME -cleanup-info \- clean up the mess that bogus install-info may have done +cleanup\-info - clean up the mess that bogus install-info may have done .SH SYNOPSIS -.B cleanup-info -[--help] [--unsafe] [--version] [--] [\fI\fP] +.B cleanup\-info +[\-\-help] [\-\-unsafe] [\-\-version] [\-\-] [\fI\fP] .SH DESCRIPTION -.B cleanup-info -is a Perl script that tries to clean up the mess that bogus install-info may +.B cleanup\-info +is a Perl script that tries to clean up the mess that bogus install\-info may have done. It gathers all sections with the same heading into a single one. It tries to be smart about cases and trailing colon/spaces. .br @@ -17,20 +17,20 @@ Order of sections is preserved (the first encountered section counts). Order of entries within a section is preserved. .sp Please be \fBextremely careful\fP when using this utility - it might -not be 100% safe. cleanup-info tries to be careful with your info dir +not be 100% safe. cleanup\-info tries to be careful with your info dir file, but only until it writes it. You should back the file up prior to using this. .SH OPTIONS .TP -.I --help +.I \-\-help Output the help screen and exit successfully. .TP -.I --unsafe +.I \-\-unsafe Set some additional possibly useful options. .br -.B "Warning: the `--unsafe' option may garble an otherwise correct file!" +.B "Warning: the `\-\-unsafe' option may garble an otherwise correct file!" .TP -.I --version +.I \-\-version Output version and exit successfully. .SH FILES .TP @@ -39,7 +39,7 @@ The info directory file. The lock file is named the same, with ".lock" suffix. .SH BUGS Probably many. .SH SEE ALSO -.BR install-info (8), +.BR install\-info (8), .BR info (1). .SH AUTHOR Copyright (C) 1996 Kim-Minh Kaplan. diff --git a/scripts/dpkg-checkbuilddeps.1 b/scripts/dpkg-checkbuilddeps.1 index 4013b5ff..1785da9b 100644 --- a/scripts/dpkg-checkbuilddeps.1 +++ b/scripts/dpkg-checkbuilddeps.1 @@ -1,8 +1,8 @@ -.TH DPKG-CHECKBUILDDEPS 1 "February 2001" "Debian project" "dpkg utililties" +.TH DPKG\-CHECKBUILDDEPS 1 "February 2001" "Debian project" "dpkg utililties" .SH NAME -dpkg-checkbuilddeps -- check build dependencies and conflicts +dpkg\-checkbuilddeps - check build dependencies and conflicts .SH SYNOPSIS -\fBdpkg-checkbuilddeps\fR -B [\fIcontrol-file\fR] +\fBdpkg\-checkbuilddeps\fR \-B [\fIcontrol-file\fR] .SH DESCRIPTION This program checks the installed packages in the system against the build dependencies and build conflicts listed in the control file. If any are @@ -12,7 +12,7 @@ By default, \fBdebian/control\fR is read, but an alternate control filename may be specified on the command line. .SH OPTIONS .TP -.I -B +.I \-B Ignore Build-Depends-Indep lines. Use when no arch-indep packages will be built. .SH AUTHOR diff --git a/scripts/dpkg-divert.8 b/scripts/dpkg-divert.8 index e2293253..7913b801 100644 --- a/scripts/dpkg-divert.8 +++ b/scripts/dpkg-divert.8 @@ -1,22 +1,22 @@ -.TH DPKG-DIVERT 8 "December 1999" "Debian Project" "dpkg utilities" +.TH DPKG\-DIVERT 8 "December 1999" "Debian Project" "dpkg utilities" .SH NAME -dpkg-divert -- override a package's version of a file +dpkg\-divert - override a package's version of a file .SH SYNOPSIS -.B dpkg-divert -[options] [--add] +.B dpkg\-divert +[options] [\-\-add] .I .br -.B dpkg-divert -[options] --remove +.B dpkg\-divert +[options] \-\-remove .I .br -.B dpkg-divert +.B dpkg\-divert [options] ---list +\-\-list .I .br -.B dpkg-divert -[options] --truename +.B dpkg\-divert +[options] \-\-truename .I .br .SH DESCRIPTION @@ -28,46 +28,46 @@ file, or whenever some files (which aren't marked as 'conffiles') need to be preserved by dpkg, when installing a newer version of a package which contains those files. .sp -.B dpkg-divert +.B dpkg\-divert is the utility used to set up and update the list of diversions. It functions in three basic modes - adding, removing, and listing diversions. -The options are --add, --remove, and --list, respectively. Additionally, +The options are \-\-add, \-\-remove, and \-\-list, respectively. Additionally, it can print out the real name for a diverted file. Other options (listed below) may also be specified. .SH OPTIONS .TP -.I --admindir +.I \-\-admindir Set the dpkg data directory to (default: /var/lib/dpkg). .TP -.I --divert +.I \-\-divert is the name used by other packages' versions. .TP -.I --help +.I \-\-help Output the version and the short usage instructions, and exit successfully. .TP -.I --local +.I \-\-local Specifies that all packages' versions are diverted. .TP -.I --package +.I \-\-package is the name of a package whose copy of will not be diverted. .TP -.I --quiet +.I \-\-quiet Quiet mode, i.e. no verbose output. .TP -.I --rename -Actually move the file aside (or back). dpkg-divert will abort operation +.I \-\-rename +Actually move the file aside (or back). dpkg\-divert will abort operation in case the destination file already exists. .TP -.I --test +.I \-\-test Test mode, i.e. don't actually perform any changes, just demonstrate. .TP -.I --version +.I \-\-version Output program name and version and exit successfully. .SH NOTES -When adding, default is --local and --divert .distrib. -When removing, --package or --local and --divert must match if specified. +When adding, default is \-\-local and \-\-divert .distrib. +When removing, \-\-package or \-\-local and \-\-divert must match if specified. -Directories can't be diverted with dpkg-divert. +Directories can't be diverted with dpkg\-divert. Care should be taken when diverting shared libraries, ldconfig (8) creates a symbolic link based on the DT_SONAME field embedded in the library. @@ -81,13 +81,10 @@ File which contains the current list of diversions of the system. It is located in the dpkg administration directory, along with other files important to dpkg, such as `status' or `available'. .br -Note: dpkg-divert preserves the old copy of this file, with extension -"-old", before replacing it with the new one. +Note: dpkg\-divert preserves the old copy of this file, with extension +"\-old", before replacing it with the new one. .SH SEE ALSO .BR dpkg (8). -.sp -Please read the Debian Packaging Manual, section 11., "Diversions - -overriding a package's version of a file" for more information. .SH AUTHOR Copyright (C) 1995 Ian Jackson. .sp diff --git a/scripts/dpkg-name.1 b/scripts/dpkg-name.1 index 60dcb18a..c6ffadc4 100644 --- a/scripts/dpkg-name.1 +++ b/scripts/dpkg-name.1 @@ -4,14 +4,14 @@ .\" This is free software; see the GNU General Public Licence version 2 .\" or later for copying conditions. There is NO warranty. .\" Time-stamp: <96/05/03 14:00:06 root> -.TH dpkg-name 1 "May 1996" "Debian Project" "dpkg utilities" +.TH dpkg\-name 1 "May 1996" "Debian Project" "dpkg utilities" .SH NAME dpkg\-name \- rename Debian packages to full package names .SH SYNOPSIS .B dpkg\-name [\-a|\-\-no\-architecture] [\-o|\-\-overwrite] [\-s|\-\-subdir [dir]] [\-c|\-\-create\-dir] [\-h|\-\-help] [\-v|\-\-version] -[\-l|\-\-license] [\-k|\-\-symlink] [\-[--] [files] +[\-l|\-\-license] [\-k|\-\-symlink] [\-[\-\-] [files] .SH DESCRIPTION .PP This manual page documents the @@ -25,23 +25,23 @@ the mainstream version information optionally followed by a hyphen and the revision information. .SH EXAMPLES .TP -.B dpkg-name bar-foo.deb -The file `bar-foo.deb' will be renamed to bar-foo_1.0-2_i386.deb or +.B dpkg\-name bar\-foo.deb +The file `bar\-foo.deb' will be renamed to bar\-foo_1.0\-2_i386.deb or something similar (depending on whatever information is in the control -part of `bar-foo.deb'). +part of `bar\-foo.deb'). .TP .B find /root/debian/ \-name '*.deb' | xargs \-n 1 dpkg\-name \-a All files with the extension `deb' in the directory /root/debian and its subdirectory's will be renamed by dpkg\-name if required into names with no architecture information. .TP -.B find -name '*.deb' | xargs \-n 1 dpkg-name -a -o -s -c +.B find \-name '*.deb' | xargs \-n 1 dpkg\-name \-a \-o \-s \-c .B Don't do this. Your archive will be messed up completely because a lot of packages don't come with section information. .B Don't do this. .TP -.B dpkg --build debian-tmp && dpkg-name -o -s .. debian-tmp.deb +.B dpkg \-\-build debian\-tmp && dpkg\-name \-o \-s .. debian\-tmp.deb This can be used when building new packages. .SS OPTIONS .TP @@ -60,11 +60,11 @@ Files will be moved into subdir. If directory given as argument exists the files will be moved into that direcotory otherswise the name of the target directory is extracted from the section field in the control part of the package. The target directory will be -`unstable/binary-/
'. If the section is +`unstable/binary\-/
'. If the section is `non-free', `contrib' or no section information is found in the control file the target directory is -`
/binary-'. The section field isn't required so -a lot of packages will find their way to the `no-section' area. Use +`
/binary\-'. The section field isn't required so +a lot of packages will find their way to the `no\-section' area. Use this option with care, it's messy. .TP .B "\-c, \-\-create\-dir" @@ -83,20 +83,20 @@ Print copyright information and (a reference to GNU) license information and exit successfully. .SH BUGS Some packages don't follow the name structure -__.deb. Packages renamed by dpkg-name +__.deb. Packages renamed by dpkg\-name will follow this structure. Generally this will have no impact on how packages are installed by dselect/dpkg, but other installation tools might depend on this naming structure. .SH SEE ALSO .BR deb (5), -.BR deb-control (5), +.BR deb\-control (5), .BR dpkg (8), -.BR dpkg-deb (1), +.BR dpkg\-deb (1), .BR find (1), .BR xargs (1). .SH COPYRIGHT Copyright 1995,1996 Erick Branderhorst. -.B dpkg-name +.B dpkg\-name is free software; see the GNU General Public Licence version 2 or later for copying conditions. There is .B no diff --git a/scripts/dpkg-scanpackages.8 b/scripts/dpkg-scanpackages.8 index c90555f9..64925d05 100644 --- a/scripts/dpkg-scanpackages.8 +++ b/scripts/dpkg-scanpackages.8 @@ -13,14 +13,14 @@ .\" You should have received a copy of the GNU General Public .\" License along with dpkg; if not, write to the Free Software .\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -.TH DPKG-SCANPACKAGES 8 "1996-07-08" "Debian project" "dpkg utilities" +.TH DPKG\-SCANPACKAGES 8 "1996-07-08" "Debian project" "dpkg utilities" .SH NAME -dpkg-scanpackages \- create Packages files +dpkg\-scanpackages - create Packages files . .SH SYNOPSIS -.B dpkg-scanpackages -.RI [ -u ] -.RI [ -a ] +.B dpkg\-scanpackages +.RI [ \-u ] +.RI [ \-a ] .I binarydir .I overridefile .RI [ pathprefix ] @@ -28,20 +28,20 @@ dpkg-scanpackages \- create Packages files .I Packages . .SH DESCRIPTION -.B dpkg-scanpackages +.B dpkg\-scanpackages sorts through a tree of Debian binary packages and creates a Packages file, used by .BR dselect (8), etc, to tell the user what packages are available for installation. These Packages files are the same as those found on Debian archive sites and CD-ROMs. You might use -.B dpkg-scanpackages +.B dpkg\-scanpackages yourself if making a directory of local packages to install on a cluster of machines. .PP .I binarydir is the name of the binary tree to process (for example, -.BR contrib/binary-i386 ). +.BR contrib/binary\-i386 ). It is best to make this relative to the root of the Debian archive, because every Filename field in the new Packages file will start with this string. @@ -54,10 +54,10 @@ package fits into the distribution; see below. is an optional string to be prepended to the Filename fields. .PP If -.I -u +.I \-u is specified, then scan for *.udeb, instead of *.deb. .PP -When -a\fI\fP is specified, then instead of scanning for all debs, +When \-a\fI\fP is specified, then instead of scanning for all debs, a pattern consisting of *_all.deb and *_arch.deb is used. . .SH THE OVERRIDE FILE @@ -105,7 +105,7 @@ in the directory on any Debian mirror. . .SH DIAGNOSTICS -.B dpkg-scanpackages +.B dpkg\-scanpackages outputs the usual self-explanatory errors. It also warns about packages that are in the wrong subdirectory, are duplicated, have a Filename field in their control file, are missing from the override file, or have @@ -114,4 +114,4 @@ maintainer substitutions which do not take effect. .SH SEE ALSO .BR dpkg (8), .BR dselect (8), -.BR dpkg-scansources (8). \ No newline at end of file +.BR dpkg\-scansources (8). diff --git a/scripts/dpkg-source.1 b/scripts/dpkg-source.1 index 39d6a532..0578c362 100644 --- a/scripts/dpkg-source.1 +++ b/scripts/dpkg-source.1 @@ -5,40 +5,40 @@ dpkg\-source, dpkg\-gencontrol, dpkg\-shlibdeps, dpkg\-genchanges, dpkg\-buildpackage, dpkg\-distaddfile, dpkg\-parsechangelog \- Debian source package tools .SH SYNOPSIS -.B dpkg-source -.BI "-x " filename .dsc +.B dpkg\-source +.BI "\-x " filename .dsc .br -.B dpkg-source -b +.B dpkg\-source \-b .RI [ options "] " directory " [" orig-directory |''] .br -.B dpkg-gencontrol +.B dpkg\-gencontrol .RI [ options ] .br -.B dpkg-shlibdeps +.B dpkg\-shlibdeps .IR options .br -.B dpkg-genchanges +.B dpkg\-genchanges .RI [ options ] .br -.B dpkg-buildpackage +.B dpkg\-buildpackage .RI [ options ] .br -.B dpkg-distaddfile +.B dpkg\-distaddfile .RI [ options ] " filename section priority" .br -.B dpkg-parsechangelog +.B dpkg\-parsechangelog .RI [ options ] .SH DESCRIPTION -.B dpkg-source +.B dpkg\-source packs and unpacks Debian source archives. -.B dpkg-gencontrol +.B dpkg\-gencontrol reads information from an unpacked Debian source tree and generates a binary package control file (which defaults to debian/tmp/DEBIAN/control); it also adds an entry for the binary package to .BR debian/files . -.B dpkg-shlibdeps +.B dpkg\-shlibdeps calculates shared library dependencies for executables named in its arguments. The dependencies are added to the substitution variables file @@ -50,7 +50,7 @@ where is a dependency field name. Any other variables starting .I shlibs: are removed from the file. -.B dpkg-shlibdeps +.B dpkg\-shlibdeps will read shared library dependency information from .BR debian/shlibs.local , .BR /etc/dpkg/shlibs.override , @@ -64,21 +64,21 @@ The first match will be used. See the .I Debian packaging manual for details of the format of shared library dependency files. -.B dpkg-genchanges +.B dpkg\-genchanges reads information from an unpacked and built Debian source tree and from the files it has generated and generates a Debian upload control file .RB ( .changes " file)." -.B dpkg-buildpackage +.B dpkg\-buildpackage is a control script which can be used to help automate the building of a package. -.B dpkg-distaddfile +.B dpkg\-distaddfile adds an entry for a named file to .BR debian/files . -.B dpkg-parsechangelog +.B dpkg\-parsechangelog reads and parses the changelog of an unpacked Debian source tree and outputs the information in it to standard output in a machine-readable form. @@ -90,143 +90,143 @@ separate argument. Many of these programs share options; these are described here, together with the programs that accept them. .TP -.BI -h +.BI \-h Display the particular program's version and usage message, including a synopsis of the options it understands. This option is understood by all the source package tools. .TP -.BI -v version +.BI \-v version In -.BR dpkg-buildpackage ", " dpkg-genchanges " and " dpkg-parsechangelog +.BR dpkg\-buildpackage ", " dpkg\-genchanges " and " dpkg\-parsechangelog this causes changelog information from all versions strictly later than .I version to be used. In -.BR dpkg-gencontrol +.BR dpkg\-gencontrol it sets the version number of the binary package which will be generated. .TP -.BI -C changesdescription +.BI \-C changesdescription Read the description of the changes from the file .I changesdescription rather than using the information from the source tree's changelog file. This is understood by -.BR dpkg-buildpackage " and " dpkg-genchanges . +.BR dpkg\-buildpackage " and " dpkg\-genchanges . .TP -.BI -m maintaineraddress +.BI \-m maintaineraddress Use .I maintaineraddress as the name and email address of the maintainer for this package, rather than using the information from the source tree's control. This is understood by -.BR dpkg-buildpackage " and " dpkg-genchanges . +.BR dpkg\-buildpackage " and " dpkg\-genchanges . .TP -.BI -e maintaineraddress +.BI \-e maintaineraddress Use .I maintaineraddress as the name and email address of the maintainer for this upload, rather than using the information from the source tree's changelog. This is understood by -.BR dpkg-buildpackage " and " dpkg-genchanges . +.BR dpkg\-buildpackage " and " dpkg\-genchanges . .TP -.BR -si ", " -sa ", " -sd +.BR \-si ", " \-sa ", " \-sd These options control whether the original source archive is included in the upload generated by -.BR dpkg-buildpackage " and " dpkg-genchanges +.BR dpkg\-buildpackage " and " dpkg\-genchanges if any source is being generated (ie, -.BR -b " or " -B +.BR \-b " or " \-B haven't been used). By default, or if -.B -si +.B \-si is specified, the original source will be included if the version number ends in -.BR -0 " or " -1 , +.BR \-0 " or " \-1 , ie if the Debian revision part of the version number is .BR 0 " or " 1 . -.B -sa +.B \-sa forces the inclusion of the original source; -.B -sd +.B \-sd forces its exclusion and includes only the diff. .TP -.BI -V name = value +.BI \-V name = value Set an output substitution variable. This option is understood by -.BR dpkg-source ", " dpkg-gencontrol " and " dpkg-genchanges . +.BR dpkg\-source ", " dpkg\-gencontrol " and " dpkg\-genchanges . See below for a discussion of output substitution. .TP -.BI -T substvarsfile +.BI \-T substvarsfile Read (or, for -.BR dpkg-shlibdeps , +.BR dpkg\-shlibdeps , write) substitution variables in .IR substvarsfile ; the default is .BR debian/substvars . This option is understood by -.BR dpkg-source ", " dpkg-gencontrol ", " dpkg-shlibdeps " and " dpkg-genchanges . +.BR dpkg\-source ", " dpkg\-gencontrol ", " dpkg\-shlibdeps " and " dpkg\-genchanges . .TP -.BI -D field = value +.BI \-D field = value Override or add an output control file field. This option is understood by -.BR dpkg-source ", " dpkg-gencontrol " and " dpkg-genchanges . +.BR dpkg\-source ", " dpkg\-gencontrol " and " dpkg\-genchanges . .TP -.BI -U field +.BI \-U field Remove an output control file field. This option is understood by -.BR dpkg-source ", " dpkg-gencontrol " and " dpkg-genchanges . +.BR dpkg\-source ", " dpkg\-gencontrol " and " dpkg\-genchanges . .TP -.BR -b | -B | -S +.BR \-b | \-B | \-S For -.BR dpkg-genchanges " and " dpkg-buildpackage -.BR -b " and " -B +.BR dpkg\-genchanges " and " dpkg\-buildpackage +.BR \-b " and " \-B specify that a binary-only build is taking place. -.B -b +.B \-b indicates that no source files are to be built and/or distributed, and -.B -B +.B \-B that no architecture-independent binary package files are to be distributed either. -.B -S +.B \-S specifies that only the source should be uploaded and no binary packages need to be made. The distinction between -.BR -b " and " -B +.BR \-b " and " \-B is only used by -.BR dpkg-buildpackage ; -.B dpkg-genchanges +.BR dpkg\-buildpackage ; +.B dpkg\-genchanges just produces a .B .changes file for whatever files were produced by the -.B binary-* +.B binary\-* target(s) of the package being built. -.B -b +.B \-b tells -.B dpkg-source +.B dpkg\-source to build a source package (rather than to extract one) - see below. .TP -.BI -c controlfile +.BI \-c controlfile Specifies the main source control file to read information from. The default is .BR debian/control . This option is understood by -.BR dpkg-source ", " dpkg-gencontrol " and " dpkg-genchanges . +.BR dpkg\-source ", " dpkg\-gencontrol " and " dpkg\-genchanges . .TP -.BI -l changelogfile +.BI \-l changelogfile Specifies the change log file to read information from. The default is .BR debian/changelog . This option is understood by -.BR dpkg-source ", " dpkg-gencontrol " and " dpkg-genchanges . +.BR dpkg\-source ", " dpkg\-gencontrol " and " dpkg\-genchanges . .TP -.BI -f fileslistfile +.BI \-f fileslistfile Read or write the list of files to be uploaded here, rather than using .BR debian/files . This option is understood by -.BR dpkg-gencontrol ", " dpkg-genchanges " and " dpkg-distaddfile . +.BR dpkg\-gencontrol ", " dpkg\-genchanges " and " dpkg\-distaddfile . .TP -.BI -F changelogformat +.BI \-F changelogformat Specifies the format of the changelog. By default the format is read from a special line near the bottom of the changelog (see the Debian packaging manual) or failing that defaults to @@ -234,33 +234,33 @@ Debian packaging manual) or failing that defaults to the standard format described in the .IR "Debian packaging manual" . This option is understood by -.BR dpkg-source ", " dpkg-gencontrol " and " dpkg-genchanges . +.BR dpkg\-source ", " dpkg\-gencontrol " and " dpkg\-genchanges . .TP -.BI -W -This option turns certain errors into warnings. Only dpkg-source uses +.BI \-W +This option turns certain errors into warnings. Only dpkg\-source uses this, but -.BR dpkg-buildpackage +.BR dpkg\-buildpackage recognizes it, and passes it thru to -.BR dpkg-source "." +.BR dpkg\-source "." .TP -.BI -E +.BI \-E This option negates a previously set -.BR -W "." +.BR \-W "." It is currently only understood by -.BR dpkg-buildpackage " and " dpkg-source "." -.SH DPKG-SOURCE OPTIONS +.BR dpkg\-buildpackage " and " dpkg\-source "." +.SH dpkg\-SOURCE OPTIONS When the common options -.BR -c " and " -l +.BR \-c " and " \-l are given with relative pathnames these are interpreted starting at the source tree's top level directory. .TP -.B -x +.B \-x Extract a source package. One non-option argument should be supplied, the name of the Debian source control file .RB ( .dsc ). No options are useful with -.BR "dpkg-source -x" . -.B dpkg-source +.BR "dpkg\-source \-x" . +.B dpkg\-source will read the names of the other file(s) making up the source package from the control file; they are assumed to be in the same directory as the @@ -274,14 +274,14 @@ extractors' umask; if the parent directory is setgid then the extracted directories will be too, and all the files and directories will inherit its group ownership. .TP -.B -b +.B \-b Build: pack up a source tree. One or two non-option arguments should be supplied. The first is taken as the name of the directory containing the unpacked source tree. If a second argument is supplied it should be the name of the original source directory or tarfile or the empty string if the package is a Debian-specific one and so has no Debianisation diffs. If no second argument is supplied then -.B dpkg-source +.B dpkg\-source will look for the original source tarfile .IB package _ upstream-version .orig.tar.gz or the original source directory @@ -289,64 +289,64 @@ or the original source directory or the empty string (no original source, and so no diff) depending on the arguments. .TP -.B -i[] +.B \-i[] You may specify a perl regular expression to match files you want filtered out of the list of files for the diff. (This list is -generated by a find command.) \fB-i\fR by itself enables the option, -with a default that will filter out CVS, RCS and libtool .deps -subdirectories, and all files within them, as well as ~ suffixed -backup files and DEADJOEs. +generated by a find command.) \fB\-i\fR by itself enables the option, +with a default that will filter out control files and directories of the +most common revision control systems, backup and swap files and Libtool +build output directories. This is very helpful in cutting out extraneous files that get included in the .diff.gz, (eg: "debian/BUGS_TODO/*" or "debian/RCS/*,v"). For instance, if you maintain a package that you track via remote CVS, where you don't have access permissions for commiting the debian -control files and making tags for \fIcvs-buildpackage(1)\fR, it is +control files and making tags for \fIcvs\-buildpackage(1)\fR, it is necessary to perform an extra checkout/update into a directory you keep pristine, to generate the .orig.tar.gz from. That directory will have CVS/Entries files in it that will contain timestamps that differ from the ones in your working directory, thus causing them to be -unnecessarily included in every .diff.gz, unless you use the \fB-i\fR +unnecessarily included in every .diff.gz, unless you use the \fB\-i\fR switch. .TP -.B -I -If this option is specified, the filename will be passed to tar's --exclude +.B \-I +If this option is specified, the filename will be passed to tar's \-\-exclude option when it is called to generate a .orig.tar.gz or .tar.gz file. For -example, -ICVS will make tar skip over CVS directories when generating +example, \-ICVS will make tar skip over CVS directories when generating a .tar.gz file. The option may be repeated multiple times to list multiple filenames to exclude. .TP -.BR -sa , -sp , -su , -sk , -sA , -sP , -sU , -sK , -ss " with " -b +.BR \-sa , \-sp , \-su , \-sk , \-sA , \-sP , \-sU , \-sK , \-ss " with " \-b If -.BR -sk " or " -sp +.BR \-sk " or " \-sp is specified -.B dpkg-source +.B dpkg\-source expects the original source as a tarfile, by default .IB package _ upstream-version .orig.tar.gz\fR. It will leave this original source in place as a tarfile, or copy it to the current directory if it isn't already there If -.B -sp +.B \-sp is used rather than -.B -sk +.B \-sk it will remove it again afterwards. If -.BR -su " or " -sr +.BR \-su " or " \-sr is specified the original source is expected as a directory, by default .IB package - upstream-version .orig and -.B dpkg-source +.B dpkg\-source will create a new original source archive from it. If -.B -sr +.B \-sr is used -.B dpkg-source will remove that directory after it has been used. +.B dpkg\-source will remove that directory after it has been used. If -.B -ss +.B \-ss is specified -.B dpkg-source +.B dpkg\-source will expect that the original source is available both as a directory and as a tarfile. If will use the directory to create the diff, but the tarfile to create the @@ -355,83 +355,83 @@ This option must be used with care - if the directory and tarfile do not match a bad source archive will be generated. If -.B -sn +.B \-sn is specified -.B dpkg-source +.B dpkg\-source will not look for any original source, and will not generate a diff. The second argument, if supplied, must be the empty string. This is used for Debian-specific packages which do not have a separate upstream source and therefore have no debianisation diffs. If -.BR -sa " or " -sA +.BR \-sa " or " \-sA is specified -.B dpkg-source +.B dpkg\-source will look for the original source archive as a tarfile or as a directory - the second argument, if any, may be either, or the empty string (this is equivalent to using -.BR -sn ). +.BR \-sn ). If a tarfile is found it will unpack it to create the diff and remove it afterwards (this is equivalent to -.BR -sp ); +.BR \-sp ); if a directory is found it will pack it to create the original source and remove it afterwards (this is equivalent to -.BR -sr ); +.BR \-sr ); if neither is found it will assume that the package has no debianisation diffs, only a straightforward source archive (this is equivalent to -.BR -sn ). -If both are found then dpkg-source will ignore the directory, +.BR \-sn ). +If both are found then dpkg\-source will ignore the directory, overwriting it, if -.B -sA +.B \-sA was specified (this is equivalent to -.BR -sP ) +.BR \-sP ) or raise an error if -.B -sa +.B \-sa was specified. -.B -sA +.B \-sA is the default. -.BR -sa ", " -sp ", " -sk ", " -su " and " -sr +.BR \-sa ", " \-sp ", " \-sk ", " \-su " and " \-sr will not overwrite existing tarfiles or directories. If this is desired then -.BR -sA ", " -sP ", " -sK ", " -sU " and " -sR +.BR \-sA ", " \-sP ", " \-sK ", " \-sU " and " \-sR should be used instead. .TP -.BR -sp , -su , -sn " with " -x +.BR \-sp , \-su , \-sn " with " \-x In all cases any existing original source tree will be removed. If -.B -sp +.B \-sp is used when extracting then the original source (if any) will be left as a tarfile. If it is not already located in the current directory or if an existing but different file is there it will be copied there. This is the default. -.B -su +.B \-su unpacks the original source tree. -.B -sn +.B \-sn ensures that the original source is neither copied to the current directory nor unpacked. Any original source tree that was in the current directory is still removed. -.SH DPKG-GENCONTROL OPTIONS -.B dpkg-gencontrol +.SH dpkg\-GENCONTROL OPTIONS +.B dpkg\-gencontrol does not take any non-option arguments. .TP -.BI -p package +.BI \-p package Generate information for the binary package .IR package . If the source control file lists only one binary package then this option may be omitted; otherwise it is essential to select which binary package's information to generate. .TP -.BI -n filename +.BI \-n filename Assume the filename of the package will be .I filename instead of the normal package_version_arch.deb filename. .TP -.BR -is ", " -ip ", " -isp +.BR \-is ", " \-ip ", " \-isp Include the .BR Section " and " Priority fields for this package from the main source control file in the @@ -439,53 +439,53 @@ binary package control file being generated. Usually this information is not included here, but only in the .B .changes file. -.B -isp +.B \-isp includes both fields, -.BR -is " only the " Section " and " -ip " only the " Priority . +.BR \-is " only the " Section " and " \-ip " only the " Priority . .TP -.BI -P packagebuilddir +.BI \-P packagebuilddir Tells -.B dpkg-source +.B dpkg\-source that the package is being built in .I packagebuilddir instead of .BR debian/tmp . This value is used to find the default value of the -.B Installed-Size +.B Installed\-Size substitution variable and control file field (using .BR du ), and for the default location of the output file. .TP -.B -O +.B \-O Causes the control file to be printed to standard output, rather than to .B debian/tmp/DEBIAN/control (or .IB packagebuilddir /DEBIAN/control if -.B -P +.B \-P was used). -.SH DPKG-SHLIBDEPS OPTIONS -.B dpkg-shlibdeps +.SH dpkg\-SHLIBDEPS OPTIONS +.B dpkg\-shlibdeps interprets non-option arguments as executable names, just as if they'd been supplied as -.BI -e executable\fR. +.BI \-e executable\fR. .TP -.BI -e executable +.BI \-e executable Include dependencies appropriate for the shared libraries required by .IR executable . .TP -.BI -d dependencyfield +.BI \-d dependencyfield Add dependencies to be added to the control file dependency field .IR dependencyfield . (The dependencies for this field are placed in the variable .BI shlibs: dependencyfield\fR.) The -.BI -d dependencyfield +.BI \-d dependencyfield option takes effect for all executables after the option, until the next -.BI -d dependencyfield\fR. +.BI \-d dependencyfield\fR. The default .I dependencyfield is @@ -493,13 +493,13 @@ is If the same dependency entry (or set of alternatives) appears in more than one of the recognised dependency field names -.BR Pre-Depends ", " Depends ", " Recommends ", " Enhances " or " Suggests +.BR Pre\-Depends ", " Depends ", " Recommends ", " Enhances " or " Suggests then -.B dpkg-shlibdeps +.B dpkg\-shlibdeps will automatically remove the dependency from all fields except the one representing the most important dependencies. .TP -.BI -p varnameprefix +.BI \-p varnameprefix Causes substitution variables to start with .IB varnameprefix : instead of @@ -510,51 +510,51 @@ Likewise, any existing substitution variables starting with .BR shlibs: ) are removed from the the substitution variables file. .TP -.BI -L localshlibsfile +.BI \-L localshlibsfile Causes -.B dpkg-shlibs +.B dpkg\-shlibs to read overriding shared library dependency information from .I localshlibsfile instead of .BR debian/shlibs.local . .TP -.B -O +.B \-O Causes the substitution variable settings to be printed to standard output, rather than being added to the substitution variables file .RB ( debian/substvars by default). -.SH DPKG-GENCHANGES OPTIONS -.B dpkg-genchanges +.SH dpkg\-GENCHANGES OPTIONS +.B dpkg\-genchanges does not take any non-option arguments. .TP -.BI -u uploadfilesdir +.BI \-u uploadfilesdir Look for the files to be uploaded in .I uploadfilesdir rather than .B .. -.RB ( dpkg-genchanges +.RB ( dpkg\-genchanges needs to find these files so that it can include their sizes and checksums in the .B .changes file). .TP -.B -q +.B \-q Usually -.B dpkg-genchanges +.B dpkg\-genchanges will produce informative messages on standard error, for example about how many of the package's source files are being uploaded. -.B -q +.B \-q suppresses these messages. -.SH DPKG-BUILDPACKAGE OPTIONS -.B dpkg-buildpackage +.SH dpkg\-BUILDPACKAGE OPTIONS +.B dpkg\-buildpackage does not take any non-option arguments. .TP -.BI -k key-id +.BI \-k key-id Specify a key-ID to use when signing packages. .TP -.BI -r gain-root-command +.BI \-r gain-root-command When -.B dpkg-buildpackage +.B dpkg\-buildpackage needs to execute part of the build process as root, it prefixes the command it executes with .I gain-root-command @@ -572,15 +572,15 @@ might typically be .BR fakeroot ", " sudo ", " super " or " really . .B su is not suitable, since it requires a -.B -c +.B \-c option to run a command and even then it can only invoke the user's shell with -.B -c +.B \-c instead of passing arguments individually to the command to be run. .TP -.BI -p sign-command +.BI \-p sign-command When -.B dpkg-buildpackage +.B dpkg\-buildpackage needs to execute GPG or PGP to sign a source control .RB ( .dsc ) file or a @@ -598,68 +598,68 @@ would have gotten. If .I sign-command takes its arguments in GPG rather than PGP style, you should give the -.B -sgpg +.B \-sgpg option. .I sign-command should not contain spaces or any other shell metacharacters. .TP -.B -tc +.B \-tc Clean the source tree (using .I gain-root-command .BR "debian/rules clean" ) after the package has been built. .TP -.BR -us ", " -uc +.BR \-us ", " \-uc Do not sign the source package or the .changes file, respectively. .TP -.BI -a architecture +.BI \-a architecture Specify the Debian architecture we build for. The architecture of the machine we build on is determined automatically, and is also the default for the host machine. .TP -.B -i[] +.B \-i[] Passed unchanged to -.BR dpkg-source . +.BR dpkg\-source . .TP -.B -I +.B \-I Passed unchanged to -.BR dpkg-source . +.BR dpkg\-source . May be repeated multiple times. .TP -.B -D +.B \-D Check build dependencies and conflicts; abort if unsatisfied. .TP -.B -d +.B \-d Do not check build dependencies and conflicts. .TP -.B -nc -Do not clean the source tree(implies -b). -.SH DPKG-DISTADDFILE ARGUMENTS -.B dpkg-distaddfile +.B \-nc +Do not clean the source tree(implies \-b). +.SH dpkg\-DISTADDFILE ARGUMENTS +.B dpkg\-distaddfile does not take any non-common options. It takes three non-option arguments, the filename and the section and priority for the .B .changes file. The filename should be specified relative to the directory where -.B dpkg-genchanges +.B dpkg\-genchanges will expect to find the files, usually .BR .. , rather than being a pathname relative to the current directory when -.B dpkg-distaddfile +.B dpkg\-distaddfile is run. -.SH DPKG-PARSECHANGELOG ARGUMENTS -.B dpkg-parsechangelog +.SH dpkg\-PARSECHANGELOG ARGUMENTS +.B dpkg\-parsechangelog does not take any non-common options or non-option arguments. .SH VARIABLE SUBSTITUTION Before -.BR dpkg-source ", " dpkg-gencontrol " and " dpkg-genchanges +.BR dpkg\-source ", " dpkg\-gencontrol " and " dpkg\-genchanges write their control information (to the source control file .B .dsc for -.B dpkg-source +.B dpkg\-source and to standard output for -.BR dpkg-gencontrol " and " dpkg-genchanges ) +.BR dpkg\-gencontrol " and " dpkg\-genchanges ) they perform some variable substitutions on the output file. A variable substitution has the form @@ -677,11 +677,11 @@ string sign. Variables can be set using the -.B -V +.B \-V common option. They can be also specified in the file .B debian/substvars (or whatever other file is specified using the -.B -T +.B \-T option). This file consists of lines of the form .IB name = value\fR. Trailing whitespace on each line, blank lines, and @@ -693,27 +693,27 @@ Additionally, the following standard variables are available: .TP .BI Arch The current build architecture (from -.BR "dpkg \-\-print-architecture" ). +.BR "dpkg \-\-print\-architecture" ). .TP -.B Source-Version +.B Source\-Version The source package version (from the changelog file). .TP -.B Installed-Size +.B Installed\-Size The total size of the package's installed files. This value is copied into the corresponding control file field; setting it will modify the value of that field. If this variable isn't set -.B dpkg-gencontrol +.B dpkg\-gencontrol will use -.B du -k debian/tmp +.B du \-k debian/tmp to find the default value. .TP -.B Extra-Size +.B Extra\-Size Additional disk space used when the package is installed. If this variable is set its value is added to that of the -.B Installed-Size +.B Installed\-Size variable (whether set explicitly or using the default value) before it is copied into the -.B Installed-Size +.B Installed\-Size control file field. .TP .BI F: fieldname @@ -738,7 +738,7 @@ These variables each hold the corresponding character. .TP .BI shlibs: dependencyfield Variable settings with names of this form are generated by -.B dpkg-shlibdeps +.B dpkg\-shlibdeps - see above. .LP If a variable is referred to but not defined it generates a warning @@ -759,12 +759,12 @@ number itself. .B debian/files The list of generated files which are part of the upload being prepared. -.B dpkg-gencontrol +.B dpkg\-gencontrol adds the presumed filenames of binary packages whose control files it generates here; -.B dpkg-distaddfile +.B dpkg\-distaddfile can be used to add additional files. -.B dpkg-genchanges +.B dpkg\-genchanges reads the data here when producing a .B .changes file. @@ -815,5 +815,5 @@ This is free software; see the GNU General Public Licence version 2 or later for copying conditions. There is NO WARRANTY. See .B /usr/share/doc/dpkg/copyright and -.B /usr/share/common-licenses/GPL +.B /usr/share/common\-licenses/GPL for details. diff --git a/scripts/dpkg-statoverride.8 b/scripts/dpkg-statoverride.8 index c784d386..386eab56 100644 --- a/scripts/dpkg-statoverride.8 +++ b/scripts/dpkg-statoverride.8 @@ -1,55 +1,59 @@ .TH DPKG-STATOVERRIDE 8 "November 2000" "Debian project" "dpkg utililties" .SH NAME -dpkg-statoverride -- override ownership and mode of files +dpkg\-statoverride - override ownership and mode of files .SH SYNOPSIS -\fBdpkg-statoverride\fR [options] --add \fI\fR +\fBdpkg\-statoverride\fR [options] \-\-add \fI\fR .br -\fBdpkg-statoverride\fR [options] --remove \fI\fR +\fBdpkg\-statoverride\fR [options] \-\-remove \fI\fR .br -\fBdpkg-statoverride\fR [options] --list \fI[]\fR +\fBdpkg\-statoverride\fR [options] \-\-list \fI[]\fR .SH DESCRIPTION `\fBstat overrides\fR' are a way to tell dpkg to use a different owner or mode for a file when a package is installed. (note: I use the word `file' here, but in reality this can be any filesystem object that dpkg handles, including directories, devices, etc.). This can be used to -force programs that are normall setuid to be install without a setuid +force programs that are normally setuid to be install without a setuid flag, or only executable by a certain group. .P -\fBdpkg-statoverride\fR is a utility to manage the list of stat +\fBdpkg\-statoverride\fR is a utility to manage the list of stat overrides. It has three basic functions: adding, removing and listing overrides. .SH OPTIONS .TP -.I --add +.I \-\-add Add an override for \fB\fR. \fB\fR does not need to exist when this command is used; the override will be stored and used later. Users and groups can be specified by their name (for example \fBroot\fR or \fBnobody\fR), or by their number by prepending the number with a -`\fB#\fR' (for example \fB#0\fR or \fB#65534\fR). +\fB#\fR' (for example \fB#0\fR or \fB#65534\fR). + +If \-\-update is specified and \fB\fR exists, it is immediately +set to the new owner and mode. .TP -.I --remove -Remove an override for \fB\fR. +.I \-\-remove +Remove an override for \fB\fR, the status of \fB] +.I \-\-list [] List all overrides. If a glob pattern is specified restrict the output to overrides which match the glob. If there are no overrides or none -match the glob \fBdpkg-statoverride\fR will exit with an exitcode of 1. +match the glob \fBdpkg\-statoverride\fR will exit with an exitcode of 1. .TP -.I --force +.I \-\-force Force an action, even if a sanity check would otherwise prohibit it. This is necessary to override an existing override. .TP -.I --update +.I \-\-update Immediately try to change the file to the new owner and mode if it -exists. This is only done for \fI--add\fR. +exists. .TP -.I --quiet +.I \-\-quiet Be less verbose about what we do. .TP -.I --help +.I \-\-help Show version, copyright and usage information. .TP -.I --admindir +.I \-\-admindir Change the directory of the dpkg database where the statoverride file is also stored. Defaults to /var/lib/dpkg. .SH FILES @@ -59,7 +63,7 @@ File which contains the current list of stat overrides of the system. It is located in the dpkg administration directory, along with other files important to dpkg, such as `status' or `available'. .br -Note: dpkg-statoverride preserves the old copy of this file, with +Note: dpkg\-statoverride preserves the old copy of this file, with extension "-old", before replacing it with the new one. .SH SEE ALSO .BR dpkg (8) diff --git a/scripts/install-info.8 b/scripts/install-info.8 index 3ab1ae50..d34c2691 100644 --- a/scripts/install-info.8 +++ b/scripts/install-info.8 @@ -2,19 +2,19 @@ .\" .\" This is free software; see the GNU General Public Licence version 2 .\" or later for copying conditions. There is NO warranty. -.TH INSTALL-INFO 8 "29th November 1995" "Debian Project" "dpkg utilities" +.TH INSTALL\-INFO 8 "29th November 1995" "Debian Project" "dpkg utilities" .SH NAME -install\-info \- create or update entry in Info directory +install\-info - create or update entry in Info directory .SH SYNOPSIS .B install\-info [\-\-version] [\-\-help] [\-\-debug] [\-\-maxwidth=nnn] [\-\-section regexp title] [\-\-infodir=xxx] [\-\-align=nnn] [\-\-quiet] [\-\-menuentry=xxx] [\-\-description=xxx] -[\-\-remove | \-\-remove-exactly ] +[\-\-remove | \-\-remove\-exactly ] [\-\-] filename .SH DESCRIPTION .PP -.B install-info +.B install\-info makes, updates or removes entries in the Info directory, the .B dir file. When updating or creating entries, if no description is @@ -32,10 +32,10 @@ file. .BI "[\-\-] " filename Gives the filename of the Info file whose menu entry is to be created, updated or removed. If -.B \-\-remove-exactly +.B \-\-remove\-exactly is specified, then .I filename -should be the exact entry name to be removed (i.e. "emacs-20/emacs" or +should be the exact entry name to be removed (i.e. "emacs\-20/emacs" or "gcc"), otherwise the basename of this filename is used as the referent of the menu entry which is created, unless there's an overriding START-INFO-DIR entry inside the given file. This file must @@ -92,7 +92,7 @@ is specified the .BR \-\-maxwidth ", " \-\-align " and " \-\-calign formatting options are silently ignored. .TP -.B \-\-remove-exactly +.B \-\-remove\-exactly This option is essentially the same as .B \-\-remove except that @@ -100,15 +100,15 @@ except that is taken as the exact entry to be removed, rather than as the name of an existing file. This can be important when trying to remove entries that refer to info files in subdirectories -(i.e. "emacs-20/emacs") because +(i.e. "emacs\-20/emacs") because .B \-\-remove will operate on the basename of the given .I filename rather than the exact name given. (i.e. .B \-\-remove -"emacs-20/emacs" would cause -.B install-info -to look for "emacs", not "emacs-20/emacs"). +"emacs\-20/emacs" would cause +.B install\-info +to look for "emacs", not "emacs\-20/emacs"). .TP .BI "\-\-section " "regexp title" Specifies that, if a new entry is to be made, it should be placed in a @@ -125,7 +125,7 @@ menu delimited by blank lines; the first line is assumed to be the title. If a new entry is to be created -.B install-info +.B install\-info will attempt to insert it within the section according in alphabetic order; if the entries in the section aren't already sorted the new location within the section will be unpredictable. The order of @@ -145,7 +145,7 @@ ignored and a warning is issued. If a section is requested when adding an entry but the file contains no section headings at all then -.B install-info +.B install\-info will create both the requested section and a Miscellaneous section at the end of the file. .TP @@ -186,12 +186,12 @@ of existing entries and the creation and deletion of sections. .TP .B \-\-help Causes -.B install-info +.B install\-info to display its usage information and exit. .TP .B \-\-version Causes -.B install-info +.B install\-info to display its version and copyright information and exit. .TP .BI \-\-description= xxx diff --git a/scripts/update-alternatives.8 b/scripts/update-alternatives.8 index 3ee9e6c9..4792bb7c 100644 --- a/scripts/update-alternatives.8 +++ b/scripts/update-alternatives.8 @@ -1,62 +1,62 @@ -.\" update-alternatives.8 +.\" update\-alternatives.8 .\" This man page is copyright 1997 Charles Briscoe-Smith .\" This is free documentation; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published .\" by the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. There is NO WARRANTY. You can .\" find the GNU GPL in /usr/share/common-licenses/GPL on any Debian system. -.TH UPDATE-ALTERNATIVES 8 "19 January 1998" "Debian Project" "dpkg utilities" +.TH UPDATE\-ALTERNATIVES 8 "19 January 1998" "Debian Project" "dpkg utilities" .SH NAME -update-alternatives \- maintain symbolic links determining default commands +update\-alternatives - maintain symbolic links determining default commands .SH SYNOPSIS -.B update-alternatives +.B update\-alternatives .RI [ options ] -.B --install +.B \-\-install .I link name path priority -.RB [ --slave +.RB [ \-\-slave .I link name .IR path ]... .PP -.B update-alternatives +.B update\-alternatives .RI [ options ] -.B --remove +.B \-\-remove .I name path .PP -.B update-alternatives +.B update\-alternatives .RI [ options ] -.B --remove-all +.B \-\-remove\-all .I name .PP -.B update-alternatives +.B update\-alternatives .RI [ options ] -.B --all +.B \-\-all .PP -.B update-alternatives +.B update\-alternatives .RI [ options ] -.B --auto +.B \-\-auto .I name .PP -.B update-alternatives +.B update\-alternatives .RI [ options ] -.B --display +.B \-\-display .I name .PP -.B update-alternatives +.B update\-alternatives .RI [ options ] -.B --list +.B \-\-list .I name .PP -.B update-alternatives +.B update\-alternatives .RI [ options ] -.B --config +.B \-\-config .I name .PP -.B update-alternatives +.B update\-alternatives .RI [ options ] -.B --set +.B \-\-set .I name path .SH DESCRIPTION -.B update-alternatives +.B update\-alternatives creates, removes, maintains and displays information about the symbolic links comprising the Debian alternatives system. .PP @@ -103,9 +103,9 @@ directory: the FHS (q.v.) gives reasons why this is a Good Thing. When each package providing a file with a particular functionality is installed, changed or removed, -.B update-alternatives +.B update\-alternatives is called to update information about that file in the alternatives system. -.B update-alternatives +.B update\-alternatives is usually called from the .B postinst or @@ -120,7 +120,7 @@ editor are installed, the man page referenced by .I /usr/share/man/man1/vi.1 should correspond to the executable referenced by .IR /usr/bin/vi . -.B update-alternatives +.B update\-alternatives handles this by means of .I master and @@ -144,7 +144,7 @@ the system. If the system administrator makes changes to the system's automatic settings, this will be noticed the next time -.B update-alternatives +.B update\-alternatives is run on the changed link's group, and the group will automatically be switched to manual mode. .PP @@ -156,9 +156,9 @@ the alternatives pointed to by members of the group will be those which have the highest priority. .PP When using the -.I --config +.I \-\-config option, -.B update-alternatives +.B update\-alternatives will list all of the choices for the link group of which given .I name @@ -168,15 +168,15 @@ for the link group. Once you make a change, the link group will no longer be in .I auto mode. You will need to use the -.I --auto +.I \-\-auto option in order to return to the automatic state. .PP If you want to configure non-interactivily you can use the -.I --set +.I \-\-set option instead (see below). .SH TERMINOLOGY Since the activities of -.B update-alternatives +.B update\-alternatives are quite involved, some specific terms will help to explain its operation. .TP @@ -204,7 +204,7 @@ administrative directory A directory, by default .IR /var/lib/dpkg/alternatives , containing -.BR update-alternatives ' +.BR update\-alternatives ' state information. .TP link group @@ -243,11 +243,11 @@ which includes links for the program itself and the associated manpage. To display the available packages which provide .B vi and the current setting for it, use the -.I --display +.I \-\-display action: .RS .PP -update-alternatives --display vi +update\-alternatives \-\-display vi .RE .PP To choose a particular @@ -256,7 +256,7 @@ implementation, use this command as root and then select a number from the list: .RS .PP -update-alternatives --config vi +update\-alternatives \-\-config vi .RE .PP To go back to having the @@ -264,65 +264,65 @@ To go back to having the implementation chosen automatically, do this as root: .RS .PP -update-alternatives --auto vi +update\-alternatives \-\-auto vi .RE .SH OPTIONS Exactly one action must be specified if -.B update-alternatives +.B update\-alternatives is to perform any meaningful task. Any number of the common options may be specified together with any action. .SS "COMMON OPTIONS" .TP -.B --verbose +.B \-\-verbose Generate more comments about what -.B update-alternatives +.B update\-alternatives is doing. .TP -.B --quiet +.B \-\-quiet Don't generate any comments unless errors occur. This option is not yet implemented. .TP -.B --test +.B \-\-test Don't actually do anything, just say what would be done. This option is not yet implemented. .TP -.B --help +.B \-\-help Give some usage information (and say which version of -.B update-alternatives +.B update\-alternatives this is). .TP -.B --version +.B \-\-version Tell which version of -.B update-alternatives +.B update\-alternatives this is (and give some usage information). .TP -\fB--altdir\fR \fIdirectory\fR +\fB\-\-altdir\fR \fIdirectory\fR Specifies the alternatives directory, when this is to be different from the default. .TP -\fB--admindir\fR \fIdirectory\fR +\fB\-\-admindir\fR \fIdirectory\fR Specifies the administrative directory, when this is to be different from the default. .SS ACTIONS .\" The names of the arguments should be identical with the ones .\" in SYNOPSIS section. .TP -\fB--install\fR \fIlink gen path pri\fR [\fB--slave\fR \fIslink sgen spath\fR] ... +\fB\-\-install\fR \fIgen link alt pri\fR [\fB\-\-slave\fR \fIsgen slink salt\fR] ... Add a group of alternatives to the system. .I gen is the generic name for the master link, .I link -is the name of its symlink, and -.I path +is the name of its symlink in the alternatives directory, and +.I alt is the alternative being introduced for the master link. .IR sgen , .I slink and -.I spath -are the generic name, symlink name and alternative +.I salt +are the generic name, symlink name in the alternatives directory and alternative for a slave link. Zero or more -.B --slave +.B \-\-slave options, each followed by three arguments, may be specified. .IP @@ -337,16 +337,16 @@ and the newly added alternatives' priority is higher than any other installed alternatives for this group, the symlinks will be updated to point to the newly added alternatives. .TP -\fB--set\fR \fIname path\fR +\fB\-\-set\fR \fIname path\fR Set the program .I path as alternative for .I name. This is equivalent to -.IB --config +.IB \-\-config but is non-interactive and thus scriptable. .TP -\fB--remove\fR \fIname path\fR +\fB\-\-remove\fR \fIname path\fR Remove an alternative and all of its associated slave links. .I name is a name in the alternatives directory, and @@ -366,22 +366,22 @@ If the link is not currently pointing to no links are changed; only the information about the alternative is removed. .TP -\fB--remove-all\fR \fIname\fR +\fB\-\-remove\-all\fR \fIname\fR Remove all alternatives and all of their associated slave links. .I name is a name in the alternatives directory. .TP -.B --all -Call \fB--config\fP on all alternatives. +.B \-\-all +Call \fB\-\-config\fP on all alternatives. .TP -\fB--auto\fR \fIlink\fR +\fB\-\-auto\fR \fIlink\fR Switch the master symlink .I link to automatic mode. In the process, this symlink and its slaves are updated to point to the highest priority installed alternatives. .TP -\fB--display\fR \fIlink\fR +\fB\-\-display\fR \fIlink\fR Display information about the link group of which .I link is the master link. @@ -392,10 +392,10 @@ what other alternatives are available (and their corresponding slave alternatives), and the highest priority alternative currently installed. .TP -\fB--list\fR \fIlink\fR +\fB\-\-list\fR \fIlink\fR Display all targets of the link group. .TP -\fB--config\fR \fIlink\fR +\fB\-\-config\fR \fIlink\fR Show available alternatives for a link group and allow the user to interactively select which one to use. The link group is updated and taken out of @@ -406,13 +406,13 @@ mode. .I /etc/alternatives/ The default alternatives directory. Can be overridden by the -.B --altdir +.B \-\-altdir option. .TP .I /var/lib/dpkg/alternatives/ The default administration directory. Can be overridden by the -.B --admindir +.B \-\-admindir option. .SH "EXIT STATUS" .IP 0 @@ -421,10 +421,10 @@ The requested action was successfully performed. Problems were encountered whilst parsing the command line or performing the action. .SH DIAGNOSTICS -.B update-alternatives +.B update\-alternatives chatters incessantly about its activities on its standard output channel. If problems occur, -.B update-alternatives +.B update\-alternatives outputs error messages on its standard error channel and returns an exit status of 2. These diagnostics should be self-explanatory; @@ -434,11 +434,11 @@ If you find a bug, please report it using the Debian bug-tracking system, or, if that is not possible, email the author directly. .PP If you find any discrepancy between the operation of -.B update-alternatives +.B update\-alternatives and this manual page, it is a bug, either in the implementation or the documentation; please report it. .SH AUTHOR -Debian update-alternatives is copyright 1995 +Debian update\-alternatives is copyright 1995 Ian Jackson. It is free software; see the GNU General Public Licence version 2 or later for copying conditions. There is NO warranty. .PP @@ -446,7 +446,7 @@ This manual page is copyright 1997/98 Charles Briscoe-Smith. This is free documentation; see the GNU General Public Licence version 2 or later for copying conditions. There is NO WARRANTY. .PP -You can find the GNU GPL in /usr/share/common-licenses/GPL on any Debian system. +You can find the GNU GPL in /usr/share/common\-licenses/GPL on any Debian system. .SH "SEE ALSO" .BR ln (1), FHS, the Filesystem Hierarchy Standard. diff --git a/split/dpkg-split.8 b/split/dpkg-split.8 index e5702577..ad7aba75 100644 --- a/split/dpkg-split.8 +++ b/split/dpkg-split.8 @@ -1,53 +1,53 @@ .\" Authors: Ian Jackson -.TH dpkg-split 1 "23rd June 1996" "Debian Project" "dpkg utilities" +.TH dpkg\-split 1 "23rd June 1996" "Debian Project" "dpkg utilities" .SH NAME dpkg\-split \- Debian package archive split/join tool .SH SYNOPSIS -.B dpkg-split -.BR -s | --split -.IR complete\-archive " [" prefix ] +.B dpkg\-split +.BR \-s | \-\-split +.IR complete-archive " [" prefix ] .br -.B dpkg-split -.BR -j | --join +.B dpkg\-split +.BR \-j | \-\-join .IR "part part " ... .br -.B dpkg-split -.BR -I | --info +.B dpkg\-split +.BR \-I | \-\-info .IR "part part " ... .br -.B dpkg-split -.BR -a | --auto -.BI -o " complete\-output part" +.B dpkg\-split +.BR \-a | \-\-auto +.BI \-o " complete-output part" .br -.B dpkg-split -.BR -l | --listq +.B dpkg\-split +.BR \-l | \-\-listq .br -.B dpkg-split -.BR -d | --discard +.B dpkg\-split +.BR \-d | \-\-discard .RI [ "package package " ...] .SH DESCRIPTION -.B dpkg-split +.B dpkg\-split splits Debian binary package files into smaller parts and reassembles them again, to support the storage of large package files on small media such as floppy disks. It can be operated manually using the -.BR --split ", " --join " and " --info +.BR \-\-split ", " \-\-join " and " \-\-info options. It also has an automatic mode, invoked using the -.B --auto +.B \-\-auto option, where it maintains a queue of parts seen but not yet reassembled and reassembles a package file when it has seen all of its parts. The -.BR --listq " and " --discard +.BR \-\-listq " and " \-\-discard options allow the management of the queue. All splitting, joining and queueing operations produce informative messages on standard output; these may safely be ignored. .SH ACTION OPTIONS .TP -.BR --split ", " -s +.BR \-\-split ", " \-s Splits a single Debian binary package into several parts. The parts are named @@ -61,12 +61,12 @@ is the total number of parts (both in decimal). If no .I prefix is supplied then the -.I complete\-archive +.I complete-archive filename is taken, including directory, with any trailing .B .deb removed. .TP -.BR --join ", " -j +.BR \-\-join ", " \-j Joins the parts of a package file together, reassembling the original file as it was before it was split. @@ -77,20 +77,20 @@ argument list, though the parts to not need to be listed in order. The parts must of course all have been generated with the same part size specified at split time, which means that they must usually have been generated by the same invocation of -.BR "dpkg-split --split" . +.BR "dpkg\-split \-\-split" . The parts' filenames are not significant for the reassembly process. By default the output file is called -.IB package - version .deb\fR. +.IB package \- version .deb\fR. .TP -.BR --info ", " -I +.BR \-\-info ", " \-I Prints information, in a human-readable format, about the part file(s) specified. Arguments which are not binary package parts produce a message saying so instead (but still on standard output). .TP -.BR --auto ", " -a +.BR \-\-auto ", " \-a Automatically queue parts and reassemble a package if possible. The @@ -101,14 +101,14 @@ package (if any) in the queue of packages file parts. If all parts of the package file of which .I part is a part are available then the package is reassembled and written to -.I complete\-output +.I complete-output (which should not usually already exist, though this is not an error). If not then the .I part is copied into the queue and -.I complete\-output +.I complete-output is not created. If @@ -119,20 +119,20 @@ will exit with status 1; if some other trouble occurs then it will exit with status 2. The -.BR --output " or " -o +.BR \-\-output " or " \-o option must be supplied when using -.BR --auto . +.BR \-\-auto . (If this were not mandatory the calling program would not know what output file to expect.) .TP -.BR --listq ", " -l +.BR \-\-listq ", " \-l Lists the contents of the queue of packages to be reassembled. For each package file of which parts are in the queue the output gives the name of the package, the parts in the queue, and the total number of bytes stored in the queue. .TP -.BR --discard ", " -d +.BR \-\-discard ", " \-d This discards parts from the queue of those waiting for the remaining parts of their packages. @@ -141,17 +141,17 @@ If no is specified then the queue is cleared completely; if any are specified then only parts of the relevant package(s) are deleted. .TP -.BR --help ", " -h +.BR \-\-help ", " \-h Prints .BR dpkg\-split 's usage message, giving a summary of its options and their uses. .TP -.BR --version +.BR \-\-version Prints .BR dpkg\-split 's version number. .TP -.BR --licence +.BR \-\-licence Prints information about .BR dpkg\-split 's copyright licensing and lack of warranty. (The American spelling @@ -159,16 +159,16 @@ copyright licensing and lack of warranty. (The American spelling is also supported.) .SH OTHER OPTIONS .TP -.BI --depotdir " directory" +.BI \-\-depotdir " directory" Specifies an alternative directory for the queue of parts awaiting automatic reassembly. The default is .BR /var/lib/dpkg . .TP -.BI --partsize\fR|\fB-S " kbytes" +.BI \-\-partsize\fR|\fB\-S " kbytes" Specifies the maximum part size when splitting, in kilobytes (1024 bytes). The default is 450Kb. .TP -.BI --output\fR|\fB-O " complete\-output" +.BI \-\-output\fR|\fB\-O " complete-output" Specifies the output file name for a reassembly. This overrides the default for a manual reassembly @@ -176,7 +176,7 @@ This overrides the default for a manual reassembly and is mandatory for an automatic queue-or-reassemble .RB ( \-\-auto ). .TP -.BR --npquiet ", " -Q +.BR \-\-npquiet ", " \-Q When doing automatic queue-or-reassembly .B dpkg\-split usually prints a message if it is given a @@ -187,7 +187,7 @@ message, to allow programs such as to cope with both split and unsplit packages without producing spurious messages. .TP -.BR --msdos +.BR \-\-msdos Forces the output filenames generated by .B \-\-split to be msdos-compatible. @@ -255,5 +255,5 @@ by him and released under the GNU General Public Licence; there is NO WARRANTY. See .B /usr/share/dpkg/copyright and -.B /usr/share/common-licenses/GPL +.B /usr/share/common\-licenses/GPL for details. diff --git a/utils/md5sum.1 b/utils/md5sum.1 index ed125b72..f11a7966 100644 --- a/utils/md5sum.1 +++ b/utils/md5sum.1 @@ -5,7 +5,7 @@ md5sum \- generates or checks MD5 message digests .SH SYNOPSIS .B md5sum -[-bv] [-c [file]] | [file...] +[\-bv] [\-c [file]] | [file...] .SH DESCRIPTION .B md5sum @@ -18,21 +18,21 @@ Normally .B md5sum generates checksums of all files given to it as a parameter and prints the checksums followed by the filenames. If, however, -.B -c +.B \-c is specified, only one filename parameter is allowed. This file should contain checksums and filenames to which these checksums refer to, and the files listed in that file are checked against the checksums listed there. See option -.B -c +.B \-c for more information. .SS OPTIONS .TP -.B -b +.B \-b Use binary mode. In unix environment, only difference between this and the normal mode is an asterix preceding the filename in the output. .TP -.B -c +.B \-c Check md5sum of all files listed in .I file against the checksum listed in the same file. The actual format of that @@ -45,16 +45,16 @@ That is, each line in the file describes a file. A line looks like: So, for example, if a file was created and its message digest calculated like so: -.B echo foo > md5-test-file; md5sum md5-test-file +.B echo foo > md5\-test\-file; md5sum md5\-test\-file .B md5sum would report: -.B d3b07384d113edec49eaa6238ad5ff00\ md5-test-file +.B d3b07384d113edec49eaa6238ad5ff00\ md5\-test\-file .TP -.B -v -Be more verbose. Print filenames when checking (with -c). +.B \-v +Be more verbose. Print filenames when checking (with \-c). .SH BUGS The related MD4 message digest algorithm was broken in October 1995. @@ -65,7 +65,7 @@ with other manpages. .B md5sum does not accept standard options like -.BR --help . +.BR \-\-help . .SH AUTHOR diff --git a/utils/start-stop-daemon.8 b/utils/start-stop-daemon.8 index 005b1930..f55c9318 100644 --- a/utils/start-stop-daemon.8 +++ b/utils/start-stop-daemon.8 @@ -2,105 +2,124 @@ .SH NAME start\-stop\-daemon \- start and stop system daemon programs .SH SYNOPSIS -.B start-stop-daemon -.BR -S | --start +.B start\-stop\-daemon +.BR \-S | \-\-start .IR options .RB [ \-\- ] .IR arguments .HP -.B start-stop-daemon -.BR -K | --stop +.B start\-stop\-daemon +.BR \-K | \-\-stop .IR options .HP -.B start-stop-daemon -.BR -H | --help +.B start\-stop\-daemon +.BR \-H | \-\-help .HP -.B start-stop-daemon -.BR -V | --version +.B start\-stop\-daemon +.BR \-V | \-\-version .SH DESCRIPTION .B start\-stop\-daemon is used to control the creation and termination of system-level processes. Using the -.BR --exec ", " --pidfile ", " --user ", and " --name " options," +.BR \-\-exec ", " \-\-pidfile ", " \-\-user ", and " \-\-name " options," .B start\-stop\-daemon can be configured to find existing instances of a running process. With -.BR --start , +.BR \-\-start , .B start\-stop\-daemon checks for the existence of a specified process. If such a process exists, .B start\-stop\-daemon does nothing, and exits with error status 1 (0 if -.BR --oknodo +.BR \-\-oknodo is specified). If such a process does not exist, it starts an instance, using either the executable specified by -.BR --exec , +.BR \-\-exec , (or, if specified, by -.BR --startas ). +.BR \-\-startas ). Any arguments given after -.BR -- +.BR \-\- on the command line are passed unmodified to the program being started. With -.BR --stop , +.BR \-\-stop , .B start\-stop\-daemon also checks for the existence of a specified process. If such a process exists, .B start\-stop\-daemon sends it the signal specified by -.BR --signal , +.BR \-\-signal , and exits with error status 0. If such a process does not exist, .B start\-stop\-daemon exits with error status 1 (0 if -.BR --oknodo +.BR \-\-oknodo is specified). If -.B --retry +.B \-\-retry is specified then -.B start-stop-daemon +.B start\-stop\-daemon will check that the process(es) have terminated. +Note that unless +.BR \-\-pidfile , +is specified, then +.B start\-stop\-daemon +behaves similarly to +.B killall(1). +.B start\-stop\-daemon +will scan the process table looking for any processes which +match the process name, uid, and/or gid (if specified). Any +matching process will prevent +.BR \-\-start +from starting the daemon. All matching processes will be +sent the KILL signal if +.BR \-\-stop +is specified. For daemons which have long-lived children +which need to live through a +.BR \-\-stop +you must specify a pidfile. + .SH OPTIONS .TP -\fB-x\fP|\fB--exec\fP \fIexecutable\fP +\fB\-x\fP|\fB\-\-exec\fP \fIexecutable\fP Check for processes that are instances of this executable (according to .B /proc/\fIpid\fB/exe\fP ). .TP -\fB-p\fP|\fB--pidfile\fP \fIpid-file\fP -Check for processes whose process-id is specified in +\fB\-p\fP|\fB\-\-pidfile\fP \fIpid-file\fP +Check whether a process has created the file .IR pid-file . .TP -\fB-u\fP|\fB--user\fP \fIusername\fP|\fIuid\fP +\fB\-u\fP|\fB\-\-user\fP \fIusername\fP|\fIuid\fP Check for processes owned by the user specified by .I username or .IR uid . .TP -\fB-g\fP|\fB--group\fP \fIgroup\fP|\fIgid\fP +\fB\-g\fP|\fB\-\-group\fP \fIgroup\fP|\fIgid\fP Change to \fIgroup\fP or \fIgid\fP when starting the process. .TP -\fB-n\fP|\fB--name\fP \fIprocess-name\fP +\fB\-n\fP|\fB\-\-name\fP \fIprocess-name\fP Check for processes with the name .I process-name (according to .BR /proc/\fIpid\fB/stat\fP ). .TP -\fB-s\fP|\fB--signal\fP \fIsignal\fP +\fB\-s\fP|\fB\-\-signal\fP \fIsignal\fP With -.BR --stop , +.BR \-\-stop , specifies the signal to send to processes being stopped (default 15). .TP -\fB-R\fP|\fB--retry\fP \fItimeout\fP|\fIschedule\fP +\fB\-R\fP|\fB\-\-retry\fP \fItimeout\fP|\fIschedule\fP With -.BR --stop , +.BR \-\-stop , specifies that -.B start-stop-daemon +.B start\-stop\-daemon is to check whether the process(es) do finish. It will check repeatedly whether any matching processes are running, until none are. If the processes do not exit it will @@ -115,13 +134,13 @@ then the schedule is used, where .I signal is the signal specified with -.BR --signal . +.BR \-\-signal . .I schedule is a list of at least two items separated by slashes .RB ( / ); each item may be -.BI - signal-number +.BI \- signal-number or [\fB\-\fP]\fIsignal-name\fP, which means to send that signal, or @@ -136,32 +155,32 @@ necessary. If the end of the schedule is reached and .BR forever is not specified, then -.B start-stop-daemon +.B start\-stop\-daemon exits with error status 2. If a schedule is specified, then any signal specified with -.B --signal +.B \-\-signal is ignored. .TP -\fB-a\fP|\fB--startas\fP \fIpathname\fP +\fB\-a\fP|\fB\-\-startas\fP \fIpathname\fP With -.BR --start , +.BR \-\-start , start the process specified by .IR pathname . If not specified, defaults to the argument given to -.BR --exec . +.BR \-\-exec . .TP -.BR -t | --test +.BR \-t | \-\-test Print actions that would be taken and set appropriate return value, but take no action. .TP -.BR -o | --oknodo +.BR \-o | \-\-oknodo Return exit status 0 instead of 1 if no actions are (would be) taken. .TP -.BR -q | --quiet +.BR \-q | \-\-quiet Do not print informational messages; only display error messages. .TP -\fB-c\fP|\fB--chuid\fP \fIusername\fR|\fIuid\fP +\fB\-c\fP|\fB\-\-chuid\fP \fIusername\fR|\fIuid\fP Change to this username/uid before starting the process. You can also specify a group by appending a .BR : , @@ -170,63 +189,65 @@ as you would for the `chown' command (\fIuser\fP\fB:\fP\fIgroup\fP). When using this option you must realize that the primary and supplemental groups are set as well, even if the -.B --group +.B \-\-group option is not specified. The -.B --group +.B \-\-group option is only for groups that the user isn't normally a member of (like adding per/process group membership for generic users like .BR nobody ). .TP -\fB-r\fP|\fB--chroot\fP \fIroot\fP +\fB\-r\fP|\fB\-\-chroot\fP \fIroot\fP Chdir and chroot to .I root before starting the process. Please note that the pidfile is also written after the chroot. .TP -\fB-d\fP|\fB--chdir\fP \fIpath\fP +\fB\-d\fP|\fB\-\-chdir\fP \fIpath\fP Chdir to .I path before starting the process. This is done after the chroot if the -\fB-r\fP|\fB--chroot\fP option is set. +\fB\-r\fP|\fB\-\-chroot\fP option is set. When not specified, +start\-stop\-daemon will chdir to the root directory before starting +the process. .TP -.BR -b | --background +.BR \-b | \-\-background Typically used with programs that don't detach on their own. This option will force -.B start-stop-daemon +.B start\-stop\-daemon to fork before starting the process, and force it into the background. -.B WARNING: start-stop-daemon +.B WARNING: start\-stop\-daemon cannot check the exit status if the process fails to execute for .B any reason. This is a last resort, and is only meant for programs that either make no sense forking on their own, or where it's not feasible to add the code for it to do this itself. .TP -\fB-N\fP|\fB--nicelevel\fP \fIint\fP +\fB\-N\fP|\fB\-\-nicelevel\fP \fIint\fP This alters the prority of the process before starting it. .TP -.BR -m | --make-pidfile +.BR \-m | \-\-make\-pidfile Used when starting a program that does not create its own pid file. This option will make -.B start-stop-daemon +.B start\-stop\-daemon create the file referenced with -.B --pidfile +.B \-\-pidfile and place the pid into it just before executing the process. Note, it will not be removed when stopping the program. .B NOTE: This feature may not work in all cases. Most notably when the program being executed forks from its main process. Because of this it is usually only useful when combined with the -.B --background +.B \-\-background option. .TP -.BR -v | --verbose +.BR \-v | \-\-verbose Print verbose informational messages. .TP -.BR -H | --help +.BR \-H | \-\-help Print help information; then exit. .TP -.BR -V | --version +.BR \-V | \-\-version Print version information; then exit. .SH AUTHORS diff --git a/utils/start-stop-daemon.c b/utils/start-stop-daemon.c index 8d0ea76f..2ffe7230 100644 --- a/utils/start-stop-daemon.c +++ b/utils/start-stop-daemon.c @@ -1204,7 +1204,7 @@ main(int argc, char **argv) if (background) { /* ok, we need to detach this process */ int i; if (quietmode < 0) - printf("Detatching to start %s...", startas); + printf("Detaching to start %s...", startas); i = fork(); if (i<0) { fatal("Unable to fork.\n"); -- 2.39.5