bryson/pacman
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation formatting updates

Browse source 
Be consistent in the Synopsis and Description sections with the use of
quotes around command names.

Signed-off-by: Dan McGee <dan@archlinux.org>
This commit is contained in:
Dan McGee 2011-03-27 21:27:15 -05:00
parent f6c8532fd0
commit c3ae209246
3 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/makepkg.8.txt
View file

@ -11,24 +11,24 @@ makepkg - package build utility
Synopsis Synopsis
-------- --------
makepkg [options] 'makepkg' [options]
Description Description
----------- -----------
makepkg is a script to automate the building of packages. The requirements for 'makepkg' is a script to automate the building of packages. The requirements for
using the script are a build-capable \*nix platform and a custom build script using the script are a build-capable \*nix platform and a custom build script
for each package you wish to build (known as a PKGBUILD). See for each package you wish to build (known as a PKGBUILD). See
linkman:PKGBUILD[5] for details on creating your own build scripts. linkman:PKGBUILD[5] for details on creating your own build scripts.
The advantage to a script-based build is that the work is only done once. Once The advantage to a script-based build is that the work is only done once. Once
you have the build script for a package, makepkg will do the rest: download and you have the build script for a package, 'makepkg' will do the rest: download and
validate source files, check dependencies, configure the build-time settings, validate source files, check dependencies, configure the build-time settings,
build the package, install the package into a temporary root, make build the package, install the package into a temporary root, make
customizations, generate meta-info, and package the whole thing up for pacman customizations, generate meta-info, and package the whole thing up for pacman
to use. to use.
NOTE: makepkg uses your current locale by default and does not unset it when NOTE: 'makepkg' uses your current locale by default and does not unset it when
building packages. If you wish to share your build output with others when building packages. If you wish to share your build output with others when
seeking help or for other purposes, you may wish to run "`LC_ALL=C makepkg`" so seeking help or for other purposes, you may wish to run "`LC_ALL=C makepkg`" so
your logs and output are not localized. your logs and output are not localized.

4
doc/pacman-key.8.txt
View file

@ -17,8 +17,8 @@ Synopsis
Description Description
----------- -----------
pacman-key is a script used to manage pacman's keyring, which is the collection 'pacman-key' is a script used to manage pacman's keyring, which is the collection
of GnuPG keys used to check signed packages. It provides the ability to import of GnuPG keys used to check signed packages. It provides the ability to import
and export keys, fetch keys from keyservers and update the key trust database. and export keys, fetch keys from keyservers and update the key trust database.

10
doc/repo-add.8.txt
View file

@ -10,22 +10,22 @@ repo-add - package database maintenance utility
Synopsis Synopsis
-------- --------
repo-add [-d] [-f] [-q] [-s] [-v] <path-to-db> <package|delta> [<package|delta> ...] 'repo-add' [-d] [-f] [-q] [-s] [-v] <path-to-db> <package|delta> [<package|delta> ...]
repo-remove [-q] [-s] [-v] <path-to-db> <packagename|delta> [<packagename|delta> ...] 'repo-remove' [-q] [-s] [-v] <path-to-db> <packagename|delta> [<packagename|delta> ...]
Description Description
----------- -----------
repo-add and repo-remove are two scripts to help build a package database for 'repo-add' and 'repo-remove' are two scripts to help build a package database for
packages built with linkman:makepkg[8] and installed with linkman:pacman[8]. packages built with linkman:makepkg[8] and installed with linkman:pacman[8].
They also handle package deltas produced by linkman:pkgdelta[8]. They also handle package deltas produced by linkman:pkgdelta[8].
repo-add will update a package database by reading a built package or package 'repo-add' will update a package database by reading a built package or package
delta file. Multiple packages and/or deltas to add can be specified on the delta file. Multiple packages and/or deltas to add can be specified on the
command line. command line.
repo-remove will update a package database by removing the package name or 'repo-remove' will update a package database by removing the package name or
delta specified on the command line. Multiple packages and/or delta to remove delta specified on the command line. Multiple packages and/or delta to remove
can be specified on the command line. can be specified on the command line.