From 37634d22e501538e5a4b12105a0b56542841e71f Mon Sep 17 00:00:00 2001 From: "Jason St. John" Date: Thu, 7 Aug 2014 00:43:19 -0400 Subject: man: Use uniform line spacing between sections Remove blank lines immediately following section headings. Ensure two blank lines before the start of a new section. Signed-off-by: Jason St. John Signed-off-by: Allan McRae --- doc/PKGBUILD.5.txt | 6 +++++- doc/makepkg-template.1.txt | 5 ++--- doc/makepkg.8.txt | 2 ++ doc/makepkg.conf.5.txt | 1 + doc/pacman-key.8.txt | 1 + doc/pacman.8.txt | 4 ++++ doc/pacman.conf.5.txt | 2 ++ doc/pactree.8.txt | 3 +++ doc/pkgdelta.8.txt | 3 +++ doc/repo-add.8.txt | 4 +++- doc/submitting-patches.txt | 2 +- doc/vercmp.8.txt | 3 +++ 12 files changed, 30 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index 8cab4380..c3365be2 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -322,7 +322,6 @@ underscore and the architecture name e.g., 'replaces_x86_64=()'. Packaging Functions ------------------- - In addition to the above directives, PKGBUILDs require a set of functions that provide instructions to build and install the package. As a minimum, the PKGBUILD must contain a `package()` function which installs all the package's @@ -379,6 +378,7 @@ variables for use during the build and install process: located, which is usually the output of `$(pwd)` when makepkg is started. Use of this variable is deprecated and strongly discouraged. + Package Splitting ----------------- makepkg supports building multiple packages from a single PKGBUILD. This is @@ -401,6 +401,7 @@ An optional global directive is available when building a split package: element in the `pkgname` array is used. The variable is not allowed to begin with a hyphen. + Install/Upgrade/Remove Scripting -------------------------------- Pacman has the ability to store and execute a package-specific script when it @@ -448,6 +449,7 @@ The install script does not need to be specified in the source array. A template install file is available in '{pkgdatadir}' as 'proto.install' for reference with all of the available functions defined. + Using VCS Sources[[VCS]] ------------------------ Building a developmental version of a package using sources from a version @@ -489,6 +491,7 @@ The source URL is divided into three components: *svn*;; revision + Example ------- The following is an example PKGBUILD for the 'patch' package. For more @@ -500,6 +503,7 @@ those using Arch Linux, consult the Arch Build System (ABS) tree. include::PKGBUILD-example.txt[] ------------------------------- + See Also -------- linkman:makepkg[8], linkman:pacman[8], linkman:makepkg.conf[5] diff --git a/doc/makepkg-template.1.txt b/doc/makepkg-template.1.txt index 8fa5c2e1..49eb8fd3 100644 --- a/doc/makepkg-template.1.txt +++ b/doc/makepkg-template.1.txt @@ -16,7 +16,6 @@ Synopsis Description ----------- - 'makepkg-template' is a script to ease the work of maintaining multiple similar PKGBUILDs. It allows you to move most of the code from the PKGBUILD into a template file and uses markers to allow in-place updating of existing PKGBUILDs @@ -60,9 +59,9 @@ resulting PKGBUILD. If you use markers in a template, please set the version you used/tested with in the start/input marker so other people can properly recreate from templates. + Options ------- - *-p, \--input* :: Read the package script `build script` instead of the default. @@ -75,6 +74,7 @@ Options *\--template-dir* :: Change the dir where we are looking for template files. + Example PKGBUILD ---------------- @@ -112,7 +112,6 @@ Example PKGBUILD # template end; - See Also -------- linkman:makepkg[8], linkman:PKGBUILD[5] diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index 16bdc8a4..78e6cb1e 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -33,6 +33,7 @@ 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. + Options ------- *-A, \--ignorearch*:: @@ -262,6 +263,7 @@ Environment Variables Specify a key to use when signing packages, overriding the GPGKEY setting in linkman:makepkg.conf[5] + Configuration ------------- See linkman:makepkg.conf[5] for more details on configuring makepkg using the diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt index 4dc3b388..20d4751b 100644 --- a/doc/makepkg.conf.5.txt +++ b/doc/makepkg.conf.5.txt @@ -261,6 +261,7 @@ Options `.tar.lzo`, `.tar.lrz`, and `.tar.Z`. Do not touch these unless you know what you are doing. + See Also -------- linkman:makepkg[8], linkman:pacman[8], linkman:PKGBUILD[5] diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt index f454074f..a04cbdf0 100644 --- a/doc/pacman-key.8.txt +++ b/doc/pacman-key.8.txt @@ -30,6 +30,7 @@ Invoking pacman-key consists of supplying an operation with any potential options and targets to operate on. Depending on the operation, a 'target' may be a valid key identifier, filename, or directory. + Operations ---------- *-a, \--add*:: diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index 87891401..152b2617 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -13,6 +13,7 @@ Synopsis -------- 'pacman' [options] [targets] + Description ----------- Pacman is a package management utility that tracks installed packages on a Linux @@ -176,6 +177,7 @@ Options Bypass any and all ``Are you sure?'' messages. It's not a good idea to do this unless you want to run pacman from a script. + Transaction Options (apply to '-S', '-R' and '-U') -------------------------------------------------- *-d, \--nodeps*:: @@ -206,6 +208,7 @@ Transaction Options (apply to '-S', '-R' and '-U') operation. The possible attributes are: "%n" for pkgname, "%v" for pkgver, "%l" for location, "%r" for repository, and "%s" for size. Implies '\--print'. + Upgrade Options (apply to '-S' and '-U')[[UO]] -------------------------------------------- *\--force*:: @@ -474,6 +477,7 @@ pacman -Syu gpm:: Update package list, upgrade all packages, and then install gpm if it wasn't already installed. + Configuration ------------- See linkman:pacman.conf[5] for more details on configuring pacman using the diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt index f19311c2..aa80e57f 100644 --- a/doc/pacman.conf.5.txt +++ b/doc/pacman.conf.5.txt @@ -199,6 +199,7 @@ Options Displays name, version and size of target packages formatted as a table for upgrade, sync and remove operations. + Repository Sections ------------------- Each repository section defines a section name and at least one location where @@ -329,6 +330,7 @@ The built-in default is the following: SigLevel = Optional TrustedOnly -------- + Using Your Own Repository ------------------------- If you have numerous custom packages of your own, it is often easier to generate diff --git a/doc/pactree.8.txt b/doc/pactree.8.txt index 6ecaf23e..c99d4f13 100644 --- a/doc/pactree.8.txt +++ b/doc/pactree.8.txt @@ -13,6 +13,7 @@ Synopsis -------- 'pactree' [options] package + Description ----------- Pactree produces a dependency tree for a package. @@ -20,6 +21,7 @@ Pactree produces a dependency tree for a package. By default a tree like output is generated, but with the -g option a graphviz description is generated. + Options ------- *-a, \--ascii*:: @@ -59,6 +61,7 @@ Options *\--config *:: Specify an alternate pacman configuration file. + See Also -------- linkman:pacman[8], linkman:pacman.conf[5], linkman:makepkg[8] diff --git a/doc/pkgdelta.8.txt b/doc/pkgdelta.8.txt index 587320a6..991d58e2 100644 --- a/doc/pkgdelta.8.txt +++ b/doc/pkgdelta.8.txt @@ -25,6 +25,7 @@ significantly. 'pkgdelta' requires linkman:xdelta3[1] to do its job. + Options ------- *--max-delta-size *:: @@ -41,11 +42,13 @@ Options *-q, \--quiet*:: Be quiet. Do not output anything but warnings and errors. + Examples -------- $ pkgdelta libreoffice-3.3.2-1-x86_64.pkg.tar.xz libreoffice-3.3.2-2-x86_64.pkg.tar.xz + See Also -------- linkman:pacman[8], linkman:xdelta3[1] diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt index d44a8a7e..b96668c3 100644 --- a/doc/repo-add.8.txt +++ b/doc/repo-add.8.txt @@ -8,6 +8,7 @@ Name ---- repo-add - package database maintenance utility + Synopsis -------- 'repo-add' [options] [ ...] @@ -82,9 +83,9 @@ repo-add Options Remove old package files from the disk when updating their entry in the database. + Example ------- - 'repo-add' is often invoked twice to create two separate databases; a smaller database used by pacman and a large database containing package file lists for use by other utilities. @@ -95,6 +96,7 @@ use by other utilities. While pacman can use the large database (if given a db.tar* extension), there is currently no additional benefit for the larger download. + See Also -------- linkman:makepkg[8], linkman:pacman[8], linkman:pkgdelta[8] diff --git a/doc/submitting-patches.txt b/doc/submitting-patches.txt index 3ff707ca..7c61dd18 100644 --- a/doc/submitting-patches.txt +++ b/doc/submitting-patches.txt @@ -8,9 +8,9 @@ please try to follow as much as you can. NOTE: Some of this is paraphrased from the kernel documentation's "SubmittingPatches" file. + Getting the most recent source ------------------------------ - Patches need to be submitted in GIT format and are best if they are against the latest version of the code. There are several helpful tutorials for getting started with GIT if you have not worked with it before. diff --git a/doc/vercmp.8.txt b/doc/vercmp.8.txt index 6b94f3e4..033e29fa 100644 --- a/doc/vercmp.8.txt +++ b/doc/vercmp.8.txt @@ -47,6 +47,7 @@ Options Display syntax for the given operation. If no operation was supplied then the general syntax is shown. + Examples -------- @@ -65,10 +66,12 @@ Examples $ vercmp 4.34 1:001 -1 + Configuration ------------- There is none. + See Also -------- linkman:pacman[8], linkman:makepkg[8], linkman:libalpm[3] -- cgit v1.2.3-54-g00ecf