summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDan McGee <dan@archlinux.org>2011-03-27 21:27:15 -0500
committerDan McGee <dan@archlinux.org>2011-03-27 21:27:15 -0500
commitc3ae209246804e9aebdc04c958548e340ff8998f (patch)
tree3d3eeeef15cf4c8ee631b3f733c382dde049d38c /doc
parentf6c8532fd04f334c35b3e860ee08d2cdee83a07c (diff)
Documentation formatting updates
Be consistent in the Synopsis and Description sections with the use of quotes around command names. Signed-off-by: Dan McGee <dan@archlinux.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/makepkg.8.txt8
-rw-r--r--doc/pacman-key.8.txt4
-rw-r--r--doc/repo-add.8.txt10
3 files changed, 11 insertions, 11 deletions
diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt
index c59800c6..f9e72392 100644
--- a/doc/makepkg.8.txt
+++ b/doc/makepkg.8.txt
@@ -11,24 +11,24 @@ makepkg - package build utility
Synopsis
--------
-makepkg [options]
+'makepkg' [options]
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
for each package you wish to build (known as a PKGBUILD). See
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
-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,
build the package, install the package into a temporary root, make
customizations, generate meta-info, and package the whole thing up for pacman
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
seeking help or for other purposes, you may wish to run "`LC_ALL=C makepkg`" so
your logs and output are not localized.
diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt
index 9bd135ce..8a08480f 100644
--- a/doc/pacman-key.8.txt
+++ b/doc/pacman-key.8.txt
@@ -17,8 +17,8 @@ Synopsis
Description
-----------
-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
+'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
and export keys, fetch keys from keyservers and update the key trust database.
diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt
index 9167a406..24e2fe6c 100644
--- a/doc/repo-add.8.txt
+++ b/doc/repo-add.8.txt
@@ -10,22 +10,22 @@ repo-add - package database maintenance utility
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
-----------
-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].
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
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
can be specified on the command line.