Minor changes to the documentation.
This commit is contained in:
parent
03f8cad872
commit
0a0cd42682
@ -227,7 +227,7 @@ To update a single package:
|
||||
|
||||
$ xbps-install -u <package expression>
|
||||
|
||||
To update all packages (also known as dist-upgrade in debian/ubuntu):
|
||||
To update all packages (also known as dist-upgrade in Debian/Ubuntu):
|
||||
|
||||
$ xbps-install -u
|
||||
|
||||
@ -276,7 +276,7 @@ To put a package on hold mode (won't be upgraded in dist-upgrade mode):
|
||||
|
||||
$ xbps-pkgdb -m hold <package name>
|
||||
|
||||
To unput a package from hold mode:
|
||||
To remove a package from hold mode:
|
||||
|
||||
$ xbps-pkgdb -m unhold <package name>
|
||||
|
||||
@ -304,7 +304,7 @@ This command only has 3 operation modes:
|
||||
|
||||
> The `-f, --force` option can be used to forcefully register a package into the repository index, even if the same version is already registered.
|
||||
|
||||
* Clean [-c, --clean]: cleans the index of the specified repository removing outdated or invalid entries (unexistent packages, unmatched hashes, etc):
|
||||
* Clean [-c, --clean]: cleans the index of the specified repository by removing outdated or invalid entries (nonexistent packages, unmatched hashes, etc):
|
||||
|
||||
$ xbps-rindex -c /path/to/repository
|
||||
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-checkvers
|
||||
.Nd XBPS utility to check for outdated packages
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-checkvers
|
||||
.Op OPTIONS
|
||||
.Op FILES...
|
||||
@ -34,7 +34,7 @@ Specifies a full path to the void-packages repository. By default set to
|
||||
.It Fl d, Fl -debug
|
||||
Enables extra debugging shown to stderr.
|
||||
.It Fl h, Fl -help
|
||||
Show the help usage.
|
||||
Show the help message.
|
||||
.It Fl i, Fl -installed
|
||||
Check for outdated installed packages rather than in repositories.
|
||||
.It Fl R, Fl -repository=uri
|
||||
@ -46,7 +46,7 @@ Shows missing binary packages comparing against the
|
||||
.Nm void-packages
|
||||
tree.
|
||||
.It Fl V, Fl -version
|
||||
Shows the XBPS version.
|
||||
Show the version information.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr xbps-create 1 ,
|
||||
@ -67,4 +67,4 @@ Shows the XBPS version.
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-create
|
||||
.Nd XBPS utility to create binary packages
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-create
|
||||
.Op OPTIONS
|
||||
.Ar destdir
|
||||
@ -30,14 +30,14 @@ by whitespaces. Example:
|
||||
A list of package patterns this package depends on, separated by whitespaces. Example:
|
||||
.Ar 'foo>=1.0 blah-1.0_1' .
|
||||
.It Fl F, Fl -config-files Ar list
|
||||
A list of configuration files this package provides, separated whitepaces.
|
||||
A list of configuration files this package provides, separated by whitespace.
|
||||
.It Fl G, Fl --source-revisions Ar string
|
||||
This justs sets a string with the git revisions of the sourcepkg that
|
||||
This sets a string with the git revisions of the sourcepkg that
|
||||
was used to build this binary package. It is set automatically by xbps-src.
|
||||
.It Fl H, Fl -homepage Ar string
|
||||
The package homepage string.
|
||||
.It Fl h, Fl -help
|
||||
Show help message.
|
||||
Show the help message.
|
||||
.It Fl l, Fl -license Ar string
|
||||
The package license.
|
||||
.It Fl M, Fl -mutable-files Ar list
|
||||
@ -68,7 +68,7 @@ A short description for this package, one line with less than 80 characters.
|
||||
A list of tags (categories) this package should be part of, separated by whitespaces. Example:
|
||||
.Ar 'development nonfree' .
|
||||
.It Fl V, Fl -version
|
||||
Shows the XBPS version.
|
||||
Show the version information.
|
||||
.It Fl -build-options Ar string
|
||||
A string containing the build options used in package.
|
||||
.It Fl -compression Ar gzip | bzip2 | xz
|
||||
@ -100,4 +100,4 @@ A list of required shared libraries, separated by whitespaces. Example:
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-dgraph
|
||||
.Nd XBPS utility to generate package dot(1) graphs
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-dgraph
|
||||
.Op OPTIONS
|
||||
.Ar MODE
|
||||
@ -66,7 +66,7 @@ of the generated graphs.
|
||||
.It Fl d, Fl -debug
|
||||
Enables extra debugging shown to stderr.
|
||||
.It Fl h, Fl -help
|
||||
Show the help usage.
|
||||
Show the help message.
|
||||
.It Fl M, Fl -memory-sync
|
||||
For remote repositories, the data is fetched and stored in memory for the current
|
||||
operation. This ignores the existing on-disk repository archives in rootdir.
|
||||
@ -76,7 +76,7 @@ than looking in the target root directory.
|
||||
.It Fl r, Fl -rootdir Ar dir
|
||||
Specifies a full path for the target root directory.
|
||||
.It Fl V, Fl -version
|
||||
Shows the XBPS version.
|
||||
Show the version information.
|
||||
.El
|
||||
.Sh MODE
|
||||
Only one of the following modes can be used at a time.
|
||||
@ -140,4 +140,4 @@ Default cache directory to store downloaded binary packages.
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-fbulk
|
||||
.Nd XBPS utility to perform a fast bulk build of void-packages
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-fbulk
|
||||
.Op OPTIONS
|
||||
.Ar /path/to/void-packages
|
||||
@ -38,11 +38,11 @@ Set the log directory. By default set to `log.<pid>`.
|
||||
.It Fl d, Fl -debug
|
||||
Enables extra debugging shown to stderr.
|
||||
.It Fl h, Fl -help
|
||||
Show the help usage.
|
||||
Show the help message.
|
||||
.It Fl v, Fl -verbose
|
||||
Enables verbose messages.
|
||||
.It Fl V, Fl -version
|
||||
Shows the XBPS version.
|
||||
Show the version information.
|
||||
.El
|
||||
.Sh FILES
|
||||
.Bl -tag -width logdir/skipped
|
||||
@ -111,4 +111,4 @@ adapted it for xbps and added some new features.
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-install
|
||||
.Nd XBPS utility to (re)install and update packages
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-install
|
||||
.Op OPTIONS
|
||||
.Op PKG...
|
||||
@ -80,7 +80,7 @@ If
|
||||
is specified twice all files will be unpacked, even
|
||||
.Em configuration files .
|
||||
.It Fl h, Fl -help
|
||||
Show the help usage.
|
||||
Show the help message.
|
||||
.It Fl i, Fl -ignore-conf-repos
|
||||
Ignore repositories defined in configuration files.
|
||||
Only repositories specified in the command line via
|
||||
@ -117,7 +117,7 @@ Enables verbose messages.
|
||||
.It Fl y, Fl -yes
|
||||
Assume yes to all questions and avoid interactive questions.
|
||||
.It Fl V, Fl -version
|
||||
Shows the XBPS version.
|
||||
Show the version information.
|
||||
.El
|
||||
.Sh ENVIRONMENT
|
||||
.Bl -tag -width XBPS_TARGET_ARCH
|
||||
@ -165,4 +165,4 @@ Default cache directory to store downloaded binary packages.
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-pkgdb
|
||||
.Nd XBPS utility to report/fix issues and modify the package database (pkgdb)
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-pkgdb
|
||||
.Op OPTIONS
|
||||
.Op PKGNAME...
|
||||
@ -46,7 +46,7 @@ If the first character is not '\/' then it's a relative path of
|
||||
.It Fl d, Fl -debug
|
||||
Enables extra debugging shown to stderr.
|
||||
.It Fl h, Fl -help
|
||||
Show the help usage.
|
||||
Show the help message.
|
||||
.It Fl m, Fl -mode Ar auto|manual|hold|unhold|repolock|repounlock
|
||||
Switches
|
||||
.Ar PKGNAME
|
||||
@ -73,7 +73,7 @@ automatically. Usually this is needed only in rare circumstances.
|
||||
.It Fl v, Fl -verbose
|
||||
Enables verbose messages.
|
||||
.It Fl V, Fl -version
|
||||
Shows the XBPS version.
|
||||
Show the version information.
|
||||
.El
|
||||
.Sh FILES
|
||||
.Bl -tag -width /var/db/xbps/.<pkgname>-files.plist
|
||||
@ -107,4 +107,4 @@ Default cache directory to store downloaded binary packages.
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-query
|
||||
.Nd XBPS utility to query for package and repository information
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-query
|
||||
.Op OPTIONS
|
||||
.Ar MODE
|
||||
@ -64,7 +64,7 @@ If the first character is not '\/' then it's a relative path of
|
||||
.It Fl d, Fl -debug
|
||||
Enables extra debugging shown to stderr.
|
||||
.It Fl h, Fl -help
|
||||
Show the help usage.
|
||||
Show the help message.
|
||||
.It Fl i, Fl -ignore-conf-repos
|
||||
Ignore repositories defined in configuration files.
|
||||
Only repositories specified in the command line via
|
||||
@ -101,7 +101,7 @@ Specifies a full path for the target root directory.
|
||||
.It Fl v, Fl -verbose
|
||||
Enables verbose messages.
|
||||
.It Fl V, Fl -version
|
||||
Shows the XBPS version.
|
||||
Show the version information.
|
||||
.El
|
||||
.Sh MODE
|
||||
Only one of the following modes can be used at a time.
|
||||
@ -281,4 +281,4 @@ Default cache directory to store downloaded binary packages.
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-reconfigure
|
||||
.Nd XBPS utility to configure installed packages
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-reconfigure
|
||||
.Op OPTIONS
|
||||
.Op PKGNAME...
|
||||
@ -44,7 +44,7 @@ Enables extra debugging shown to stderr.
|
||||
.It Fl f, Fl -force
|
||||
Forcefully reconfigure package even if it was configured previously.
|
||||
.It Fl h, Fl -help
|
||||
Show the help usage.
|
||||
Show the help message.
|
||||
.It Fl i, Fl -ignore Ar PKG
|
||||
Ignore
|
||||
.Ar PKG
|
||||
@ -59,7 +59,7 @@ Specifies a path for the target root directory.
|
||||
.It Fl v, Fl -verbose
|
||||
Enables verbose messages.
|
||||
.It Fl V, Fl -version
|
||||
Shows the XBPS version.
|
||||
Show the version information.
|
||||
.El
|
||||
.Sh FILES
|
||||
.Bl -tag -width /var/db/xbps/.<pkgname>-files.plist
|
||||
@ -93,4 +93,4 @@ Default cache directory to store downloaded binary packages.
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-remove
|
||||
.Nd XBPS utility to remove packages
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-remove
|
||||
.Op OPTIONS
|
||||
.Op PKGNAME...
|
||||
@ -74,7 +74,7 @@ shared libraries (DANGEROUS!).
|
||||
.It Fl f, Fl -force
|
||||
Forcefully remove package files even if they have been modified.
|
||||
.It Fl h, Fl -help
|
||||
Show the help usage.
|
||||
Show the help message.
|
||||
.It Fl n, Fl -dry-run
|
||||
Dry-run mode. Show what actions would be done but don't do anything. The current output
|
||||
prints 6 arguments: "<pkgver> <action> <arch> <repository> <installedsize> <downloadsize>".
|
||||
@ -94,7 +94,7 @@ Enables verbose messages.
|
||||
.It Fl y, Fl -yes
|
||||
Assume yes to all questions and avoid interactive questions.
|
||||
.It Fl V, Fl -version
|
||||
Shows the XBPS version.
|
||||
Show the version information.
|
||||
.El
|
||||
.Sh FILES
|
||||
.Bl -tag -width /var/db/xbps/.<pkgname>-files.plist
|
||||
@ -128,4 +128,4 @@ Default cache directory to store downloaded binary packages.
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps-rindex
|
||||
.Nd XBPS utility to manage local binary package repositories
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-rindex
|
||||
.Op OPTIONS
|
||||
.Ar MODE
|
||||
@ -26,9 +26,9 @@ or
|
||||
.Em sign-pkg
|
||||
modes.
|
||||
.It Fl h -help
|
||||
Show the help usage.
|
||||
Show the help message.
|
||||
.It Fl V -version
|
||||
Show the XBPS version.
|
||||
Show the version information.
|
||||
.It Sy --signedby Ar string
|
||||
This is required to sign a repository, a description of the person signing the repository, i.e name and email.
|
||||
.It Sy --privkey Ar key
|
||||
@ -106,4 +106,4 @@ a repository. Otherwise it will ask you to enter the passphrase on the terminal.
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -2,8 +2,8 @@
|
||||
.Dt XBPS-UCHROOT 1
|
||||
.Sh NAME
|
||||
.Nm xbps-uchroot
|
||||
.Nd XBPS utility to chroot and bind mount with linux namespaces
|
||||
.Sh SYNOPSYS
|
||||
.Nd XBPS utility to chroot and bind mount with Linux namespaces
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-uchroot
|
||||
.Op OPTIONS
|
||||
.Ar CHROOTDIR
|
||||
@ -89,4 +89,4 @@ other Operating Systems. The following kernel options must be enabled:
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -2,8 +2,8 @@
|
||||
.Dt XBPS-UUNSHARE 1
|
||||
.Sh NAME
|
||||
.Nm xbps-uunshare
|
||||
.Nd XBPS utility to chroot and bind mount with linux user namespaces
|
||||
.Sh SYNOPSYS
|
||||
.Nd XBPS utility to chroot and bind mount with Linux user namespaces
|
||||
.Sh SYNOPSIS
|
||||
.Nm xbps-uunshare
|
||||
.Op OPTIONS
|
||||
.Ar CHROOTDIR
|
||||
@ -68,4 +68,4 @@ other Operating Systems. The following kernel options must be enabled:
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
@ -3,7 +3,7 @@
|
||||
.Sh NAME
|
||||
.Nm xbps.d
|
||||
.Nd XBPS configuration directory
|
||||
.Sh SYNOPSYS
|
||||
.Sh SYNOPSIS
|
||||
.Bl -item -compact
|
||||
.It
|
||||
/etc/xbps.d/*.conf
|
||||
@ -49,7 +49,7 @@ Overrides the native machine architecture, as reported by
|
||||
.Xr uname 2 .
|
||||
.It Sy bestmatching=true|false
|
||||
When this keyword is enabled, a package with the greatest version available in
|
||||
all registered repositories will be choosen.
|
||||
all registered repositories will be chosen.
|
||||
This will be applied to dependencies as well.
|
||||
.It Sy cachedir=path
|
||||
Sets the default cache directory to store downloaded binary packages from
|
||||
@ -145,6 +145,6 @@ Default cache directory to store downloaded binary packages.
|
||||
.An Juan Romero Pardines <xtraeme@gmail.com>
|
||||
.Sh BUGS
|
||||
Probably, but I try to make this not happen. Use it under your own
|
||||
responsability and enjoy your life.
|
||||
responsibility and enjoy your life.
|
||||
.Pp
|
||||
Report bugs in https://github.com/voidlinux/xbps/issues
|
||||
Report bugs at https://github.com/voidlinux/xbps/issues
|
||||
|
Loading…
Reference in New Issue
Block a user