Package: devscripts Version: 2.10.71 Severity: minor Tags: patch Hi,
The following patch provides some more stylish improvements I spotted after having a closer look to ten random pages. I'll try to provide a more complete review when I'll update the French translation. Cheers David *** 0001-Partial-manual-pages-convention-review.patch >From 5c1d770515ac31f0b033c651ebe27c6cf74eb8fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Pr=C3=A9vot?= <da...@tilapin.org> Date: Sat, 5 Mar 2011 23:15:40 -0400 Subject: [PATCH 1/2] Partial manual pages convention review --- scripts/checkbashisms.1 | 12 ++++---- scripts/cowpoke.1 | 46 ++++++++++++++++---------------- scripts/debchange.1 | 62 +++++++++++++++++++++--------------------- scripts/debcheckout.pl | 50 +++++++++++++++++----------------- scripts/licensecheck.pl | 8 +++--- scripts/plotchangelog.1 | 6 ++-- scripts/transition-check.pl | 6 ++-- 7 files changed, 95 insertions(+), 95 deletions(-) diff --git a/scripts/checkbashisms.1 b/scripts/checkbashisms.1 index 2e8eb82..a180766 100644 --- a/scripts/checkbashisms.1 +++ b/scripts/checkbashisms.1 @@ -26,11 +26,11 @@ options for stricter checking. Show a summary of options. .TP .BR \-\-newline ", " \-n -Check for "echo \-n" usage (non POSIX but required by Debian Policy 10.4.) +Check for "\fBecho \-n\fR" usage (non POSIX but required by Debian Policy 10.4.) .TP .BR \-\-posix ", " \-p Check for issues which are non POSIX but required to be supported by Debian -Policy 10.4 (implies \-n). +Policy 10.4 (implies \fB\-n\fR). .TP .BR \-\-force ", " \-f Force each script to be checked, even if it would normally not be (for @@ -41,8 +41,8 @@ shell wrapper). Highlight lines which, whilst they do not contain bashisms, may be useful in determining whether a particular issue is a false positive which may be ignored. -For example, the use of "$BASH_ENV" may be preceded by checking -whether "$BASH" is set. +For example, the use of "\fB$BASH_ENV\fR" may be preceded by checking +whether "\fB$BASH\fR" is set. .TP .BR \-\-version ", " \-v Show version and copyright information. @@ -61,5 +61,5 @@ unreadable or not found. The warning message will give details. .BR lintian (1). .SH AUTHOR \fBcheckbashisms\fR was originally written as a shell script by Yann Dirson -<dir...@debian.org> and rewritten in Perl with many more features by -Julian Gilbey <j...@debian.org>. +<\fidir...@debian.org\fR> and rewritten in Perl with many more features by +Julian Gilbey <\fi...@debian.org\fR>. diff --git a/scripts/cowpoke.1 b/scripts/cowpoke.1 index d99db4c..758d628 100644 --- a/scripts/cowpoke.1 +++ b/scripts/cowpoke.1 @@ -31,23 +31,23 @@ The following options are available: .TP .BI \-\-arch= arch -Specify the Debian architecture(s) to build for. A space separated list of +Specify the Debian \fIarch\fPitecture(s) to build for. A space separated list of architectures may be used to build for all of them in a single pass. Valid arch names are those returned by \fBdpkg-architecture\fP(1) for \fBDEB_BUILD_ARCH\fP. .TP .BI \-\-dist= dist -Specify the Debian distribution(s) to build for. A space separated list of +Specify the Debian \fIdist\fPribution(s) to build for. A space separated list of distributions may be used to build for all of them in a single pass. Either -codenames (such as sid, or lenny) or distribution names (such as unstable, or -experimental) may be used, but you should usually stick to using one or the +codenames (such as \fBsid\fP, or \fBsqueeze\fP) or distribution names (such as \fBunstable\fP, or +\fBexperimental\fP) may be used, but you should usually stick to using one or the other consistently as this name may be used in file paths and to locate old packages for comparison reporting. .TP .BI \-\-buildd= host -Specify the remote host to build on. +Specify the remote \fIhost\fP to build on. .TP .BI \-\-buildd\-user= name @@ -60,20 +60,20 @@ is not passed it is an error for the specified \fB\-\-dist\fP or \fB\-\-arch\fP to not have an existing cowbuilder root in the expected location. .TP -.BI \-\-return= [path] +.BR \-\-return= [ \fIpath ] Copy results of the build to \fIpath\fP. If path is not specified, then return them to the current directory. The given path must exist, it will not be created. .TP .B \-\-no\-return -Do not copy results of the build to RETURN_DIR (overriding a path set for it in +Do not copy results of the build to \fBRETURN_DIR\fP (overriding a path set for it in the config files). .TP .BI \-\-dpkg\-opts= "'opt1 opt2 ...'" Specify additional options to be passed to \fBdpkg-buildpackage\fP(1). Multiple options are delimited with spaces. This will override any options specified in -DEBBUILDOPTS in the build host's pbuilderrc. +\fBDEBBUILDOPTS\fP in the build host's \fIpbuilderrc\fP. .TP .B \-\-help @@ -87,7 +87,7 @@ Display the current version information. .SH CONFIGURATION OPTIONS When \fBcowpoke\fP is run the following configuration options are read from global, per\-user, and per\-project configuration files if present. File paths -may be absolute or relative, the latter being relative to the BUILDD_USER's +may be absolute or relative, the latter being relative to the \fBBUILDD_USER\fR's home directory. Since the paths are typically quoted when used, tilde expansion will \fBnot\fP be performed on them. @@ -102,7 +102,7 @@ This may be overridden by the \fB\-\-buildd\fP command line option. .B BUILDD_USER The unprivileged user name for operations on the build machine. This defaults to the local name of the user executing \fBcowpoke\fP (or to a username that is -specified in your ssh config for BUILDD_HOST), and may be overridden by the +specified in your ssh config for \fBBUILDD_HOST\fR), and may be overridden by the \fB\-\-buildd\-user\fP command line option. .TP .B BUILDD_ARCH @@ -158,7 +158,7 @@ youruser ALL = NOPASSWD: /usr/sbin/cowbuilder .TP .B " " Alternatively you could use ssh with a forwarded key, or whatever other -mechanism suits your local access policy. su \-c isn't really suitable +mechanism suits your local access policy. \fBsu \-c\fR isn't really suitable here due to its quoting requirements being different from all the rest. .TP @@ -171,18 +171,18 @@ The utility to use when creating a new build root. Alternatives are If set, package files resulting from the build will be copied to the path (local or remote) that this is set to, after the build completes. The path must exist, it will not be created. This option is unset by default and can -be overridden with --return or --no-return. +be overridden with \fB\-\-return\fR or \fB\-\-no-return\fR. .SS Arch and dist specific options -These are variables of the form: $arch_$dist_VAR which apply only for a +These are variables of the form: \fI$arch\fB_\fI$dist\fB_VAR\fR which apply only for a particular target arch/dist build. .TP -.RB arch _ dist _RESULT_DIR +.IB $arch _ $dist _RESULT_DIR The directory path on the build machine where the resulting packages (source and binary) will be found, and where older versions of the package that were built -previously may be found. If any such older packages exist, debdiff will be used +previously may be found. If any such older packages exist, \fBdebdiff\fP will be used to compare the new package with the previous version after the build is complete, and the result will be included in the build log. Files in it must be readable by the \fBBUILDD_USER\fP for sanity checking with \fBlintian\fP(1) and @@ -191,7 +191,7 @@ specified for some arch and dist combination then it will default to .I $PBUILDER_BASE/$arch/$dist/result .TP -.RB arch _ dist _BASE_PATH +.IB $arch _ $dist _BASE_PATH The directory where the COW master files are to be found (or created if the \fB\-\-create\fP command line option was passed). If this option is not specified for some arch or dist then it will default to @@ -218,21 +218,21 @@ explicitly on the command line override all configuration files. .SH COWBUILDER CONFIGURATION There is nothing particularly special required to configure a cowbuilder instance for use with \fBcowpoke\fP. Simply create them in the flavour you require with -`cowbuilder \-\-create` according to the cowbuilder documentation, then configure +`\fBcowbuilder \-\-create\fP` according to the cowbuilder documentation, then configure \fBcowpoke\fP with the user, arch, and path information required to access it, on the machines you wish to invoke it from (or alternatively configure \fBcowpoke\fP with the path, arch and distribution information and pass the \fB\-\-create\fP option to it on the first invocation). The build host running cowbuilder does not require \fBcowpoke\fP installed locally. -The build machine should have the lintian and devscripts packages installed for +The build machine should have the \fBlintian\fP and \fBdevscripts\fR packages installed for post-build sanity checking. Upon completion, the build log and the results of automated checks will be recorded in the \fBINCOMING_DIR\fP. If you wish to upload signed packages the build machine will also need \fBdput\fP(1) installed -and configured to use the 'host' alias specified by \fBUPLOAD_QUEUE\fP. +and configured to use the '\fIhost\fP' alias specified by \fBUPLOAD_QUEUE\fP. If \fBrsync\fP(1) is available on both the local and build machine, then it will be used to transfer the source package (this may save on some transfers of the -orig.tar.* when building subsequent debian revisions). +\fIorig.tar.*\fP when building subsequent Debian revisions). The user executing \fBcowpoke\fP must have ssh access to the build machine as the \fBBUILDD_USER\fP. That user must be able to invoke cowbuilder as root by @@ -249,9 +249,9 @@ output of cowbuilder during the update (or creation) of the build root. .SH NOTES -Since cowbuilder creates a chroot, and to do that you need root, \fBcowpoke\fP +Since \fBcowbuilder\fP creates a chroot, and to do that you need root, \fBcowpoke\fP also requires some degree of root access. So all the horrible things that can -go wrong with that may well one day rain down upon you. cowbuilder has been +go wrong with that may well one day rain down upon you. \fBcowbuilder\fR has been known to accidentally wipe out bind-mounted filesystems outside the chroot, and worse than that can easily happen. So be careful, keep good backups of things you don't want to lose on your build machine, and use \fBcowpoke\fP to keep all @@ -266,5 +266,5 @@ of uncommitted work. .SH AUTHOR .B cowpoke -was written by Ron <r...@debian.org>. +was written by Ron <\fi...@debian.org\fP>. diff --git a/scripts/debchange.1 b/scripts/debchange.1 index 6cb0bca..18582e6 100644 --- a/scripts/debchange.1 +++ b/scripts/debchange.1 @@ -23,7 +23,7 @@ temporary file, \fBdebchange\fR will exit without touching the existing changelog. \fBNote that the changelog is assumed to be encoded with the UTF-8 encoding. If it is not, problems may occur.\fR Please see the \fBiconv\fR(1) manpage to find out how to convert -changelogs from legacy encodings. Finally, a changelog or NEWS +changelogs from legacy encodings. Finally, a \fIchangelog\fR or \fINEWS\fR file can be created from scratch using the \fB\-\-create\fR option described below. .PP @@ -56,9 +56,9 @@ directory. A warning will be issued if the log file is found but a successful upload is not recorded. This may be because the previous upload was performed with a version of \fBdupload\fR prior to 2.1 or because the upload failed. The alternate \fIchangelog\fR heuristic assumes the package has -been released unless its changelog contains \fIUNRELEASED\fR in the +been released unless its changelog contains \fBUNRELEASED\fR in the distribution field. If this heuristic is enabled then the distribution will -default to \fIUNRELEASED\fR in new changelog entries, and the +default to \fBUNRELEASED\fR in new changelog entries, and the \fB\-\-mainttrailer\fR option described below will be automatically enabled. This can be useful if a package can be released by different maintainers, or if you do not keep the upload logs. @@ -111,11 +111,11 @@ causing potential problems, it will examine the name of the parent directory once it finds the \fIdebian/changelog\fR file, and check that the directory name corresponds to the package name. Precisely how it does this is controlled by two configuration file variables -DEVSCRIPTS_CHECK_DIRNAME_LEVEL and DEVSCRIPTS_CHECK_DIRNAME_REGEX, and +\fBDEVSCRIPTS_CHECK_DIRNAME_LEVEL\fR and \fBDEVSCRIPTS_CHECK_DIRNAME_REGEX\fR, and their corresponding command-line options \fB\-\-check-dirname-level\fR and \fB\-\-check-dirname-regex\fR. .PP -DEVSCRIPTS_CHECK_DIRNAME_LEVEL can take the following values: +\fBDEVSCRIPTS_CHECK_DIRNAME_LEVEL\fR can take the following values: .TP .B 0 Never check the directory name. @@ -129,20 +129,20 @@ Always check the directory name. .PP The directory name is checked by testing whether the current directory name (as determined by \fBpwd\fR(1)) matches the regex given by the -configuration file option DEVSCRIPTS_CHECK_DIRNAME_REGEX or by the +configuration file option \fBDEVSCRIPTS_CHECK_DIRNAME_REGEX\fR or by the command line option \fB\-\-check-dirname-regex\fR \fIregex\fR. Here \fIregex\fR is a Perl regex (see \fBperlre\fR(3perl)), which will be -anchored at the beginning and the end. If \fIregex\fR contains a '/', +anchored at the beginning and the end. If \fIregex\fR contains a '\fB/\fR', then it must match the full directory path. If not, then it must match the full directory name. If \fIregex\fR contains the string -\'PACKAGE', this will be replaced by the source package name, as +\'\fBPACKAGE\fR', this will be replaced by the source package name, as determined from the changelog. The default value for the regex is: -\'PACKAGE(-.+)?', thus matching directory names such as PACKAGE and -PACKAGE-version. +\'\fBPACKAGE(-.+)?\fR', thus matching directory names such as \fBPACKAGE\fR and +\fBPACKAGE-\fIversion\fR. .PP The default changelog to be edited is \fIdebian/changelog\fR; however, this can be changed using the \fB\-\-changelog\fR or \fB\-\-news\fR -options or the CHANGELOG environment variable, as described below. +options or the \fBCHANGELOG\fR environment variable, as described below. .SH OPTIONS .TP .BR \-\-append ", " \-a @@ -167,13 +167,13 @@ Edit the changelog in an editor. .BR \-\-release ", " \-r Finalize the changelog for a release. Update the changelog timestamp. If the distribution is set to -\fIUNRELEASED\fR, change it to the distribution from the previous changelog entry +\fBUNRELEASED\fR, change it to the distribution from the previous changelog entry (or another distribution as specified by \fB\-\-distribution\fR). If there are no previous changelog entries and an explicit distribution has not been -specified, \fIunstable\fR will be used. +specified, \fBunstable\fR will be used. .TP .BR \-\-force\-save\-on\-release -When \-\-release is used and an editor opened to allow inspection +When \fB\-\-release\fR is used and an editor opened to allow inspection of the changelog, require the user to save the changelog their editor opened. Otherwise, the original changelog will not be modified. (default) .TP @@ -190,14 +190,14 @@ directory to use this; no directory name checking will be performed. The package name and version can either be specified using the \fB\-\-package\fR and \fB\-\-newversion\fR options, determined from the directory name using the \fB\-\-fromdirname\fR option or entered -manually into the generated changelog file. The maintainer name is +manually into the generated \fIchangelog\fR file. The maintainer name is determined from the environment if this is possible, and the distribution is specified either using the \fB\-\-distribution\fR -option or in the generated changelog file. +option or in the generated \fIchangelog\fR file. .TP .BR \-\-empty When used in combination with \fB\-\-create\fR, suppress the automatic -addition of an "initial release" changelog entry (so that the next +addition of an "\fBinitial release\fR" changelog entry (so that the next invocation of \fBdebchange\fR adds the first entry). Note that this will cause a \fBdpkg\-parsechangelog\fR warning on the next invocation due to the lack of changes. @@ -209,8 +209,8 @@ may only be used in conjunction with the \fB\-\-create\fR, \fB\-\-increment\fR a .TP .BR \-\-nmu ", " \-n Increment the Debian release number for a non-maintainer upload by -either appending a ".1" to a non-NMU version number (unless the package -is Debian native, in which case "+nmu1" is appended) or by incrementing +either appending a "\fB.1\fR" to a non-NMU version number (unless the package +is Debian native, in which case "\fB+nmu1\fR" is appended) or by incrementing an NMU version number, and add an NMU changelog comment. This happens automatically if the packager is neither in the Maintainer nor the Uploaders field in \fIdebian/control\fR, unless \fBDEBCHANGE_AUTO_NMU\fR is set to @@ -218,19 +218,19 @@ field in \fIdebian/control\fR, unless \fBDEBCHANGE_AUTO_NMU\fR is set to .TP .BR \-\-bin\-nmu Increment the Debian release number for a binary non-maintainer upload -by either appending a "+b1" to a non-binNMU version number or by +by either appending a "\fB+b1\fR" to a non-binNMU version number or by incrementing a binNMU version number, and add a binNMU changelog comment. .TP .BR \-\-qa ", " \-q Increment the Debian release number for a Debian QA Team upload, and -add a QA upload changelog comment. +add a \fBQA upload\fR changelog comment. .TP .BR \-\-security ", " \-s Increment the Debian release number for a Debian Security Team non-maintainer -upload, and add a Security Team upload changelog comment. +upload, and add a \fBSecurity Team upload\fR changelog comment. .TP .B \-\-team -Increment the Debian release number for a team upload, and add a team upload +Increment the Debian release number for a team upload, and add a \fRTeam upload\fR changelog comment. .TP .B \-\-bpo @@ -262,10 +262,10 @@ Disable automatic NMU detection. Equivalent to setting .TP .BR \-\-fromdirname ", " \-d This will take the upstream version number from the directory name, -which should be of the form \fIpackage\fR-\fIversion\fR. If the +which should be of the form \fIpackage\fB-\fIversion\fR. If the upstream version number has increased from the most recent changelog entry, then a new entry will be made with version number -\fIversion\fR-1 (or \fIversion\fR if the package is Debian native), +\fIversion\fB-1\fR (or \fIversion\fR if the package is Debian native), with the same epoch as the previous package version. If the upstream version number is the same, this option will behave in the same way as \fB\-i\fR. @@ -294,12 +294,12 @@ entries or the existing value for existing entries. .TP \fB\-\-urgency \fIurgency\fR, \fB\-u \fIurgency\fR Use the specified urgency in the changelog entry being edited, -instead of using the default "low" for new entries or the existing +instead of using the default "\fBlow\fR" for new entries or the existing value for existing entries. .TP \fB\-\-changelog \fIfile\fR, \fB\-c \fIfile\fR This will edit the changelog \fIfile\fR instead of the standard -\fIdebian/changelog\fR. This option overrides any CHANGELOG +\fIdebian/changelog\fR. This option overrides any \fBCHANGELOG\fR environment variable setting. Also, no directory traversing or checking will be performed when this option is used. .TP @@ -338,11 +338,11 @@ trailer. See also the \fBDEBCHANGE_MAINTTRAILER\fR configuration file option below. .TP \fB\-\-check-dirname-level\fR \fIN\fR -See the above section "Directory name checking" for an explanation of +See the above section "\fBDirectory name checking\fR" for an explanation of this option. .TP \fB\-\-check-dirname-regex\fR \fIregex\fR -See the above section "Directory name checking" for an explanation of +See the above section "\fBDirectory name checking\fR" for an explanation of this option. .TP \fB\-\-no-conf\fR, \fB\-\-noconf\fR @@ -375,7 +375,7 @@ If this is set to \fIno\fR, then it is the same as the \fB\-\-noquery\fR command line parameter being used. .TP .BR DEVSCRIPTS_CHECK_DIRNAME_LEVEL ", " DEVSCRIPTS_CHECK_DIRNAME_REGEX -See the above section "Directory name checking" for an explanation of +See the above section "\fBDirectory name checking\fR" for an explanation of these variables. Note that these are package-wide configuration variables, and will therefore affect all \fBdevscripts\fR scripts which check their value, as described in their respective manpages and @@ -403,7 +403,7 @@ If this is set to \fIno\fR, then it is the same as the .TP .BR DEBCHANGE_TZ Use this timezone for changelog entries. Default is the user/system -timezone as shown by `date \-R` and affected by the environment variable TZ. +timezone as shown by `\fBdate \-R\fR` and affected by the environment variable \fBTZ\fR. .TP .BR DEBCHANGE_LOWER_VERSION_PATTERN If this is set, then it is the same as the diff --git a/scripts/debcheckout.pl b/scripts/debcheckout.pl index 3648706..11d7644 100755 --- a/scripts/debcheckout.pl +++ b/scripts/debcheckout.pl @@ -46,10 +46,10 @@ repository. By default the repository is checked out to the I<PACKAGE> directory; this can be overridden by providing the I<DESTDIR> argument. The information about where the repository is available is expected to be found -in B<Vcs-*> fields available in the source package record. For example, the vim -package exposes such information with a field like S<Vcs-Git: -git://git.debian.org/git/pkg-vim/vim.git>, you can see it by grepping through -C<apt-cache showsrc vim>. +in B<Vcs-*> fields available in the source package record. For example, the B<vim> +package exposes such information with a field like S<B<Vcs-Git: +git://git.debian.org/git/pkg-vim/vim.git>>, you can see it by grepping through +B<apt-cache showsrc vim>. If more than one source package record containing B<Vcs-*> fields is available, B<debcheckout> will select the record with the highest version number. @@ -57,13 +57,13 @@ Alternatively, a particular version may be selected from those available by specifying the package name as I<PACKAGE>=I<VERSION>. If you already know the URL of a given repository you can invoke -debcheckout directly on it, but you will probably need to pass the +B<debcheckout> directly on it, but you will probably need to pass the appropriate B<-t> flag. That is, some heuristics are in use to guess the repository type from the URL; if they fail, you might want to override the guessed type using B<-t>. -The currently supported version control systems are: arch, bzr, cvs, -darcs, git, hg, svn. +The currently supported version control systems are: Arch (arch), Bazaar (bzr), CVS (cvs), +Darcs (darcs), Git (git), Nercurial (hg) and Subversion (svn). =head1 OPTIONS @@ -74,11 +74,11 @@ B<GENERAL OPTIONS> =item B<-a>, B<--auth> Work in authenticated mode; this means that for known repositories (mainly those -hosted on S<http://alioth.debian.org>) URL rewriting is attempted before +hosted on S<I<http://alioth.debian.org>>) URL rewriting is attempted before checking out, to ensure that the repository can be committed to. For example, for subversion repositories hosted on alioth this means that -S<svn+ssh://svn.debian.org/...> will be used instead of -S<svn://svn.debian.org/...>. +S<I<svn+ssh://svn.debian.org/...>> will be used instead of +S<I<svn://svn.debian.org/...>>. =item B<-d>, B<--details> @@ -120,7 +120,7 @@ Specify that the named file should be extracted from the repository and placed in the destination directory. May be used more than once to extract mutliple files. -=item B<--source=never|auto|download-only|always> +=item B<--source=never>|B<auto>|B<download-only>|B<always> Some packages only place the debian directory in version control. B<debcheckout> can retrieve the remaining parts of the source using B<apt-get @@ -134,17 +134,17 @@ Only use the repository. =item B<auto> (default) -If the repository only contains the debian directory, retrieve the source -package, unpack it, and also place the .orig.tar.gz file into the current +If the repository only contains the F<debian> directory, retrieve the source +package, unpack it, and also place the F<.orig.tar.gz> file into the current directory. Else, do nothing. =item B<download-only> -Always retrieve the .orig.tar.gz file, but do not unpack it. +Always retrieve the I<.orig.tar.gz> file, but do not unpack it. =item B<always> -Always retrieve the .orig.tar.gz file, and if the repository only contains the +Always retrieve the I<.orig.tar.gz> file, and if the repository only contains the debian directory, unpack it. =back @@ -160,11 +160,11 @@ I<GIT-SPECIFIC OPTIONS> =item B<--git-track> I<BRANCHES> Specify a list of remote branches which will be set up for tracking -(as in S<git branch --track>, see git-branch(1)) after the remote -GIT repository has been cloned. The list should be given as a +(as in S<B<git branch --track>>, see B<git-branch>(1)) after the remote +Git repository has been cloned. The list should be given as a space-separated list of branch names. -As a shorthand, the string "*" can be given to require tracking of all +As a shorthand, the string "B<*>" can be given to require tracking of all remote branches. =back @@ -182,13 +182,13 @@ for this purpose. The currently recognised variables are: =item B<DEBCHECKOUT_AUTH_URLS> This variable should be a space separated list of Perl regular -expressions and replacement texts, which must come in pairs: REGEXP -TEXT REGEXP TEXT ... and so on. Each pair denotes a substitution which +expressions and replacement texts, which must come in pairs: I<REGEXP> +I<TEXT> I<REGEXP> I<TEXT> ... and so on. Each pair denotes a substitution which is applied to repository URLs if other built-in means of building URLs for authenticated mode (see B<-a>) have failed. References to matching substrings in the replacement texts are -allowed as usual in Perl by the means of $1, $2, ... and so on. +allowed as usual in Perl by the means of B<$1>, B<$2>, ... and so on. This setting can be used to enable authenticated mode for most repositories out there. Note that the Debian repositories on S<alioth.debian.org> @@ -210,13 +210,13 @@ this variable. =head1 SEE ALSO -apt-cache(8), Section 6.2.5 of the Debian Developer's Reference (for -more information about Vcs-* fields): S<http://www.debian.org/doc/developers-reference/best-pkging-practices.html#bpp-vcs> +B<apt-cache>(8), Section 6.2.5 of the Debian Developer's Reference (for +more information about B<Vcs-*> fields): S<I<http://www.debian.org/doc/developers-reference/best-pkging-practices.html#bpp-vcs>>. =head1 AUTHOR -debcheckout and this manpage have been written by Stefano Zacchiroli -<z...@debian.org> +B<debcheckout> and this manpage have been written by Stefano Zacchiroli +<I<z...@debian.org>>. =cut diff --git a/scripts/licensecheck.pl b/scripts/licensecheck.pl index dc7c14f..1f7f423 100755 --- a/scripts/licensecheck.pl +++ b/scripts/licensecheck.pl @@ -96,23 +96,23 @@ ignored for this purpose. The currently recognised variables are: =item B<LICENSECHECK_VERBOSE> -If this is set to I<yes>, then it is the same as the --verbose command +If this is set to I<yes>, then it is the same as the B<--verbose> command line parameter being used. The default is I<no>. =item B<LICENSECHECK_PARSELINES> If this is set to a positive number then the specified number of lines at the start of each file will be read whilst attempting to determine -the license(s) in use. This is equivalent to the --lines command line +the license(s) in use. This is equivalent to the B<--lines> command line option. =back =head1 LICENSE -This code is copyright by Adam D. Barratt <a...@adam-barratt.org.uk>, +This code is copyright by Adam D. Barratt <I<a...@adam-barratt.org.uk>>, all rights reserved; based on a script of the same name from the KDE -SDK, which is copyright by <dfa...@kde.org>. +SDK, which is copyright by <I<dfa...@kde.org>>. This program comes with ABSOLUTELY NO WARRANTY. You are free to redistribute this code under the terms of the GNU General Public License, version 2 or later. diff --git a/scripts/plotchangelog.1 b/scripts/plotchangelog.1 index 0a607d6..9c17712 100644 --- a/scripts/plotchangelog.1 +++ b/scripts/plotchangelog.1 @@ -6,7 +6,7 @@ plotchangelog \- graph debian changelogs .I "\fR[\fPoptions\fR]\fP changelog \fR...\fP" .SH "DESCRIPTION" .BR plotchangelog -is a tool to aid in visualizing a Debian changelog. The changelogs are +is a tool to aid in visualizing a Debian \fIchangelog\fR. The changelogs are graphed with .BR gnuplot (1) , with the X axis of the graph denoting time of release and the Y axis @@ -99,8 +99,8 @@ Display version, author and copyright information. .B \-\-noconf\fR, \fP\-\-no-conf Do not read any configuration files (see below). .TP -.B changelog \fR... -The changelog files to graph. If multiple files are specified they will all +.I changelog \fR... +The \fIchangelog\fR files to graph. If multiple files are specified they will all be display on the same graph. The files may be compressed with gzip. Any text in them that is not in Debian changelog format will be ignored. .SH "CONFIGURATION VARIABLES" diff --git a/scripts/transition-check.pl b/scripts/transition-check.pl index 8178743..3554d4f 100755 --- a/scripts/transition-check.pl +++ b/scripts/transition-check.pl @@ -46,7 +46,7 @@ will use the source package name from I<debian/control>. =item B<-f>, B<--filename=>I<filename> Read a source package name from I<filename>, which should be a Debian -package control file or .changes file, and add that package to the list +package control file or I<.changes> file, and add that package to the list of packages to check. =back @@ -71,7 +71,7 @@ At least one package examined is involved in a current transition. =head1 LICENSE -This code is copyright by Adam D. Barratt <a...@adam-barratt.org.uk>, +This code is copyright by Adam D. Barratt <I<a...@adam-barratt.org.uk>>, all rights reserved. This program comes with ABSOLUTELY NO WARRANTY. @@ -80,7 +80,7 @@ General Public License, version 2 or later. =head1 AUTHOR -Adam D. Barratt <a...@adam-barratt.org.uk> +Adam D. Barratt <I<a...@adam-barratt.org.uk>> =cut -- 1.7.4.1 -- To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org
