manpages: tweaks.

This commit is contained in:
Juan RP 2012-11-05 09:39:10 +01:00
parent 603b0249f1
commit 0a7e917d49
4 changed files with 51 additions and 52 deletions

View File

@ -1,67 +1,67 @@
.Dd October 2, 2012 .Dd November 5, 2012
.Os Void GNU/Linux .Os Void GNU/Linux
.Dt xbps-create 8 .Dt xbps-create 8
.Sh NAME .Sh NAME
.Nm xbps-create .Nm xbps-create
.Nd XBPS command to create binary packages .Nd XBPS utility to create binary packages
.Sh SYNOPSYS .Sh SYNOPSYS
.Nm xbps-create .Nm xbps-create
.Op options .Op OPTIONS
.Ar destdir .Ar destdir
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
command creates XBPS binary packages from files stored in a directory. utility creates XBPS binary packages from files stored in a directory.
The files must have correct permissions and location within this directory. The files must have correct permissions and location within this directory.
The behaviour of resulting package is changed by using multiple values in The behaviour of resulting package is changed by using multiple values in
the options. the options.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Fl .Bl -tag -width Fl
.It Fl A Fl -architecture Ar string .It Fl A, Fl -architecture Ar string
The target architecture for this package (required). Use The target architecture for this package (required). Use
.Ar noarch .Ar noarch
if package doesn't contain any arch-dependent file. if package doesn't contain any arch-dependent file.
.It Fl B Fl -built-with Ar string .It Fl B, Fl -built-with Ar string
The package builder string, free form. The package builder string, free form.
.It Fl C Fl -conflicts Ar list .It Fl C, Fl -conflicts Ar list
A list of package patterns that this package should conflict with, separated A list of package patterns that this package should conflict with, separated
by a single blank. Example: by a single blank. Example:
.Ar 'foo>=1.0 blah<1.0' . .Ar 'foo>=1.0 blah<1.0' .
.It Fl D Fl -dependencies Ar list .It Fl D, Fl -dependencies Ar list
A list of package patterns this package depends on, separated by a single A list of package patterns this package depends on, separated by a single
blank. Example: blank. Example:
.Ar 'foo>=1.0 blah-1.0_1' . .Ar 'foo>=1.0 blah-1.0_1' .
.It Fl F Fl -config-files Ar list .It Fl F, Fl -config-files Ar list
A list of configuration files this package provides, separated by a single A list of configuration files this package provides, separated by a single
blank. blank.
.It Fl H Fl -homepage Ar string .It Fl H, Fl -homepage Ar string
The package homepage string. The package homepage string.
.It Fl h Fl -help .It Fl h, Fl -help
Show help message. Show help message.
.It Fl l Fl -license Ar string .It Fl l, Fl -license Ar string
The package license. The package license.
.It Fl M Fl -mutable-files Ar list .It Fl M, Fl -mutable-files Ar list
A list of mutable files this package provides, separated by a single blank. A list of mutable files this package provides, separated by a single blank.
.It Fl m Fl -maintainer Ar string .It Fl m, Fl -maintainer Ar string
The package maintainer name and/or email contact. The package maintainer name and/or email contact.
.It Fl n Fl -pkgver Ar string .It Fl n, Fl -pkgver Ar string
The package name/version tuple, e.g: The package name/version tuple, e.g:
.Ar 'foo-1.0_1' . .Ar 'foo-1.0_1' .
.It Fl P Fl -provides Ar list .It Fl P, Fl -provides Ar list
A list of virtual packages this package provides, separated by a single blank. Example: A list of virtual packages this package provides, separated by a single blank. Example:
.Ar 'virtualpkg-9999 virtualpkg2-1.0_1' . .Ar 'virtualpkg-9999 virtualpkg2-1.0_1' .
.It Fl p Fl -preserve .It Fl p, Fl -preserve
If set the package files will be preserved after being updated. If set the package files will be preserved after being updated.
.It Fl q Fl -quiet .It Fl q, Fl -quiet
Enable quiet operation. Enable quiet operation.
.It Fl R Fl -replaces Ar list .It Fl R, Fl -replaces Ar list
A list of package patterns this package replaces, separated by a single blank. Example: A list of package patterns this package replaces, separated by a single blank. Example:
.Ar 'foo>=1.0 blah>=2.0' . .Ar 'foo>=1.0 blah>=2.0' .
.It Fl S Fl -long-desc Ar string .It Fl S, Fl -long-desc Ar string
A long description for this package. A long description for this package.
.It Fl s Fl -desc Ar string .It Fl s, Fl -desc Ar string
A short description for this package, one line with less than 80 characters. A short description for this package, one line with less than 80 characters.
.It Fl V Fl -version .It Fl V, Fl -version
Shows the XBPS version. Shows the XBPS version.
.Sh SEE ALSO .Sh SEE ALSO
.Xr xbps-bin 8 , .Xr xbps-bin 8 ,

View File

@ -1,4 +1,4 @@
.Dd November 3, 2012 .Dd November 5, 2012
.Os Void GNU/Linux .Os Void GNU/Linux
.Dt xbps-reconfigure 8 .Dt xbps-reconfigure 8
.Sh NAME .Sh NAME
@ -11,7 +11,7 @@
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
command configures packages in target root directory. Configuration utility configures packages in target root directory. Configuration
involves two steps: involves two steps:
.Pp .Pp
.Sy * .Sy *
@ -32,21 +32,21 @@ unless the
option is specified. option is specified.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width xxxxxxxxxxxxxxxxxxxxxxx .Bl -tag -width xxxxxxxxxxxxxxxxxxxxxxx
.It Fl a, -all .It Fl a, Fl -all
Configures all packages. Configures all packages.
.It Fl C, -config Ar file .It Fl C, Fl -config Ar file
Specifies a full path to the XBPS configuration file. Specifies a full path to the XBPS configuration file.
.It Fl d, -debug .It Fl d, Fl -debug
Enables extra debugging shown to stderr. Enables extra debugging shown to stderr.
.It Fl f, -force .It Fl f, Fl -force
Forcefully reconfigure package even if it was configured previously. Forcefully reconfigure package even if it was configured previously.
.It Fl h, -help .It Fl h, Fl -help
Show the help usage. Show the help usage.
.It Fl r, -rootdir Ar dir .It Fl r, Fl -rootdir Ar dir
Specifies a full path for the target root directory. Specifies a full path for the target root directory.
.It Fl v, -verbose .It Fl v, Fl -verbose
Enables verbose messages. Enables verbose messages.
.It Fl V, -version .It Fl V, Fl -version
Shows the XBPS version. Shows the XBPS version.
.Sh SEE ALSO .Sh SEE ALSO
.Xr xbps-create 8 , .Xr xbps-create 8 ,

View File

@ -1,4 +1,4 @@
.Dd November 3, 2012 .Dd November 5, 2012
.Os Void GNU/Linux .Os Void GNU/Linux
.Dt xbps-remove 8 .Dt xbps-remove 8
.Sh NAME .Sh NAME
@ -11,7 +11,7 @@
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
command removes installed packages in the target root directory. utility removes installed packages in the target root directory.
Removing a package involves some steps: Removing a package involves some steps:
.Pp .Pp
.Sy * .Sy *
@ -53,44 +53,43 @@ Package is unregistered from package database.
.Pp .Pp
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width -XXXXXXXX .Bl -tag -width -XXXXXXXX
.It Fl C, -config Ar file .It Fl C, Fl -config Ar file
Specifies a full path to the XBPS configuration file. Specifies a full path to the XBPS configuration file.
.It Fl c, -cachedir Ar dir .It Fl c, Fl -cachedir Ar dir
Specifies a full path to the cache directory, where binary packages are stored. Specifies a full path to the cache directory, where binary packages are stored.
.It Fl d, -debug .It Fl d, Fl -debug
Enables extra debugging shown to stderr. Enables extra debugging shown to stderr.
.It Fl f, -force .It Fl f, Fl -force
Forcefully remove package files even if they have been modified. Forcefully remove package files even if they have been modified.
.It Fl h, -help .It Fl h, Fl -help
Show the help usage. Show the help usage.
.It Fl i, -ignore-revdeps .It Fl i, Fl -ignore-revdeps
Ignore reverse dependencies when removing packages. Ignore reverse dependencies when removing packages.
.It Fl n, -dry-run .It Fl n, Fl -dry-run
Dry-run mode. Show what actions would be done but don't remove anything. Dry-run mode. Show what actions would be done but don't remove anything.
.It Fl O, -clean-cache .It Fl O, Fl -clean-cache
Cleans cache directory removing obsolete binary packages. Cleans cache directory removing obsolete binary packages.
.It Fl o, -remove-orphans .It Fl o, Fl -remove-orphans
Removes installed package orphans that were installed automatically Removes installed package orphans that were installed automatically
(as dependencies) and are not currently dependencies of any installed package. (as dependencies) and are not currently dependencies of any installed package.
.It Fl p, -print-format Ar fmt .It Fl p, Fl -print-format Ar fmt
Specifies the Specifies the
.Xr printf 3 .Xr printf 3
format used by the format used by the
.Ar dry-run .Ar dry-run
mode. mode.
.It Fl R, -recursive .It Fl R, Fl -recursive
Recursively remove packages that were installed by Recursively remove packages that were installed by
.Ar PKGNAME .Ar PKGNAME
and aren't required by other installed packages. and aren't required by other installed packages.
.It Fl r, -rootdir Ar dir .It Fl r, Fl -rootdir Ar dir
Specifies a full path for the target root directory. Specifies a full path for the target root directory.
.It Fl v, -verbose .It Fl v, Fl -verbose
Enables verbose messages. Enables verbose messages.
.It Fl y, -yes .It Fl y, Fl -yes
Assume yes to all questions and avoid interactive questions. Assume yes to all questions and avoid interactive questions.
.It Fl V, -version .It Fl V, Fl -version
Shows the XBPS version. Shows the XBPS version.
be removed.
.Sh FILES .Sh FILES
.Bl -tag -width xxxxxxxxxxxxxxxxxxxx .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
.It Ar /etc/xbps/xbps.conf .It Ar /etc/xbps/xbps.conf

View File

@ -1,4 +1,4 @@
.Dd November 3, 2012 .Dd November 5, 2012
.Os Void GNU/Linux .Os Void GNU/Linux
.Dt xbps-rindex 8 .Dt xbps-rindex 8
.Sh NAME .Sh NAME
@ -12,7 +12,7 @@
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
command creates, updates and removes obsolete binary packages stored utility creates, updates and removes obsolete binary packages stored
in local repositories. in local repositories.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width -versionXXXXXXXX .Bl -tag -width -versionXXXXXXXX