Radish alpha
H
rad:z3QDZAW2FAfuLvihrhiyDC9fAD8G9
HardenedBSD Package Manager
Radicle
Git
Merge pull request #131 from yuripankov/master
Baptiste Daroussin committed 14 years ago
commit 819e0206fe9a9894de0838f44a1c5846e73478f4
parent dd1a3a0
16 files changed +157 -139
modified pkg/pkg-add.1
@@ -42,7 +42,7 @@ The following options are supported by
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
@@ -50,9 +50,8 @@ for further description.
.It Ev HANDLE_RC_SCRIPTS
.It Ev PKG_DBDIR
.El
-
.P
.Sh FILES
-
See 
+
See
.Xr pkg.conf 5 .
.Sh SEE ALSO
.Xr pkg 1 ,
modified pkg/pkg-autoremove.1
@@ -38,7 +38,7 @@ Assume yes when asked for confirmation before package autoremoval.
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-backup.1
@@ -52,7 +52,7 @@ This option is currently not implemented.
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-create.1
@@ -16,8 +16,8 @@
.\" $FreeBSD$
.\"
.Dd January 24, 2012
-
.Os
.Dt PKG-CREATE 1
+
.Os
.\" ---------------------------------------------------------------------------
.Sh NAME
.Nm "pkg create"
@@ -170,7 +170,7 @@ entry but for directories.
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-delete.1
@@ -29,7 +29,7 @@
.Ar <pkg-name> <...>
.Sh DESCRIPTION
.Nm
-
is used for deleting previously installed packages and removes them from the 
+
is used for deleting previously installed packages and removes them from the
database.
.Sh OPTIONS
The following options are supported by
@@ -51,7 +51,7 @@ Treat the package names as extended regular expressions.
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-info.1
@@ -40,19 +40,18 @@ The following options are supported by
.Nm :
.Bl -tag -width F1
.It Fl a
-
Displays all installed packages
+
Display all installed packages.
.It Fl f
-
Displays full information about the packages
-
matching
-
.Ar <pkg-name>
+
Display full information about the packages matching
+
.Ar <pkg-name> .
.It Fl R
Display the full yaml (raw) about the packages matching
-
.Ar <pkg-name>
+
.Ar <pkg-name> .
.It Fl e
-
Returns 0 if
+
If
.Ar <pkg-name>
-
is installed and is registered in the database, otherwise returns 1.
-
Useful for checking if a package is installed or not.
+
is installed and registered in the database, return 0, otherwise return 1.
+
Useful for checking whether the package is installed.
.It Fl g
Treat
.Ar <pkg-name>
@@ -66,45 +65,43 @@ Treat
.Ar <pkg-name>
as an extended regular expression.
.It Fl d
-
Displays the dependencies of package
-
.Ar <pkg-name>
+
Display the list of packages which depend on
+
.Ar <pkg-name> .
.It Fl r
-
Displays a list of packages on which
-
.Ar <pkg-name>
-
depends.
+
Display the list of packages required by
+
.Ar <pkg-name> .
.It Fl l
-
Displays all files installed by
-
.Ar <pkg-name>
+
Display all files installed by
+
.Ar <pkg-name> .
.It Fl s
-
Displays the total size of files installed by
+
Display the total size of files installed by
.Ar <pkg-name>
.It Fl q
-
Be ``quiet''. Prints only the requested information
-
without displaying many hints.
+
Be
+
.Dq quiet .
+
Prints only the requested information without displaying many hints.
.It Fl O
Search is done by the
.Ar <pkg-name>
origin. Added only for Ports compatibility.
.Pp
.It Fl E
-
Currently not implemented. Added only for Ports
-
compatibility
+
Currently not implemented. Added only for Ports compatibility.
.It Fl o
-
Displays
+
Display
.Ar <pkg-name>
-
origin
+
origin.
.It Fl p
-
Displays the installation prefix for each package
-
matching
-
.Ar <pkg-name>
+
Display the installation prefix for each package matching
+
.Ar <pkg-name> .
.It Fl F Ar <pkg-file>
Displays information from the package archive
-
.Ar <pkg-file>
+
.Ar <pkg-file> .
.El
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-install.1
@@ -28,21 +28,25 @@
.Sh DESCRIPTION
.Nm
is used for installation of packages from a remote package
-
repository database. It can install multiple packages 
+
repository database. It can install multiple packages
specified on the command-line from multiple repositories.
.Pp
-
If a package is found to exists in more than one package 
+
If a package is found to exists in more than one package
repository the first matching repository is the one that the
-
package will be first tried to be fetched from. 
+
package will be first tried to be fetched from.
.Pp
If fetching from the repository fails for some reason the next
repository, which the package is found to exist is the one that is
tried until the package is fetched, or all repositories are tried.
.Pp
Multiple package repositories is activated only when the environment
-
variable \fBPACKAGESITE\fP is not defined.
+
variable
+
.Ev PACKAGESITE
+
is not defined.
.Pp
-
If \fBPACKAGESITE\fP is defined then only the repository to which it
+
If
+
.Ev PACKAGESITE
+
is defined then only the repository to which it
points is the one that is used during the package installations.
.Pp
It is always good to update your package repositories first before
@@ -68,7 +72,7 @@ Treat the package names as extended regular expressions.
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
@@ -80,9 +84,8 @@ for further description.
.It Ev PKG_MULTIREPOS
.El
.Sh FILES
-
See 
+
See
.Xr pkg.conf 5 .
-
.El
.Sh SEE ALSO
.Xr pkg 1 ,
.Xr pkg-add 1 ,
modified pkg/pkg-query.1
@@ -27,7 +27,7 @@
.Nm
.Fl f Ao pkg-name Ac Ao query-format Ac
.Nm
-
.Op Fl gxX 
+
.Op Fl gxX
.Ao query-format Ac Ao pattern Ac Ao ... Ac
.Sh DESCRIPTION
.Nm
@@ -59,82 +59,100 @@ There are two type of keyword for the query format: the multiline and the normal
one. Only one type of multiline pattern is accepted for a given query.
.Ss Normal patterns:
.Bl -tag -width F1
-
.It \fB%n\fB
+
.It Cm %n
Name of the matched package
-
.It \fB%v\fB
+
.It Cm %v
Version of the matched package
-
.It \fB%o\fB
+
.It Cm %o
Origin of the matched package
-
.It \fB%p\fB
+
.It Cm %p
Prefix of the matched package
-
.It \fB%m\fB
+
.It Cm %m
Maintainer of the matched package
-
.It \fB%c\fB
+
.It Cm %c
Comment of the matched package
-
.It \fB%w\fB
+
.It Cm %w
Home page of the matched package
-
.It \fB%l\fB
+
.It Cm %l
license logic of the matched package - nothing for single, & for AND, and | for OR
-
.It \fB%sh\fB
+
.It Cm %sh
The flat size in human readable format of the matched package
-
.It \fB%sb\fB
+
.It Cm %sb
The flat size in bytes of the matched package
-
.It \fB%a\fB
+
.It Cm %a
Returns 1 if the matched package is an orphan package and can be pkg-autoremove(1)'d, 0 otherwise
-
.It \fB%?[drCFIDLUG]\fB
+
.It Cm %? Ns Op drCFIDLUG
Returns 0 if the list is empty and 1 if the list has information to display
.Bl -tag -width indent
-
.It \fBd\fB
+
.It Cm d
for dependencies
-
.It \fBr\fB
+
.It Cm r
for reverse dependencies
-
.It \fBC\fB
+
.It Cm C
for categories
-
.It \fBF\fB
+
.It Cm F
for files
-
.It \fBO\fB
+
.It Cm O
for options
-
.It \fBD\fB
+
.It Cm D
for directories
-
.It \fBL\fB
+
.It Cm L
for licenses
-
.It \fBU\fB
+
.It Cm U
for users
-
.It \fBG\fB
+
.It Cm G
for groups
.El
+
.El
.Ss Multiline patterns:
.Bl -tag -width F1
-
.It \fB%d[nov]\fB
-
Expands to the list of dependencies for the matched package, where \fBn\fP stand for the package name,
-
\fBo\fP for the package origin, and \fBv\fP for the package version.
-
.It \fB%r[nov]\fB
-
Expands to the list of reverse dependencies for the matched package, where \fBn\fP stand for the
-
package name, \fBo\fP for the package origin, and \fBv\fP for the package version.
-
.It \fB%C\fB
+
.It Cm %d Ns Op nov
+
Expands to the list of dependencies for the matched package, where
+
.Cm n
+
stands for the package name,
+
.Cm o
+
for the package origin, and
+
.Cm v
+
for the package version.
+
.It Cm %r Ns Op nov
+
Expands to the list of reverse dependencies for the matched package, where
+
.Cm n
+
stands for the package name,
+
.Cm o
+
for the package origin, and
+
.Cm v
+
for the package version.
+
.It Cm %C
Expands to the list of categories the matched package belongs to.
-
.It \fB%F[ps]\fB
-
Expands to the list of files of the matched package, where \fBp\fP stand for path, and \fBs\fP for sum.
-
.It \fB%O[kv]\fB
-
Expands to the list of options of the matched package, where \fBk\fP stand for option key,
-
and \fBv\fP for option value.
-
.It \fB%L\fB
+
.It Cm %F Ns Op ps
+
Expands to the list of files of the matched package, where
+
.Cm p
+
stands for path, and
+
.Cm s
+
for sum.
+
.It Cm %O Ns Op kv
+
Expands to the list of options of the matched package, where
+
.Cm k
+
stands for option key, and
+
.Cm v
+
for option value.
+
.It Cm %L
Expands to the list of license(s) for the matched package.
-
.It \fB%U\fB
+
.It Cm %U
Expands to the list of users needed by the matched package.
-
.It \fB%G\fB
+
.It Cm %G
Expands to the list of groups needed by the matched package.
-
.It \fB%S\fB
+
.It Cm %S
Expands to the list of scripts for the matching packages - install, deinstall, etc.
.El
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
-
.IT PKG_DBDIR
+
.It Ev PKG_DBDIR
.El
.Sh FILES
See
modified pkg/pkg-register.1
@@ -58,7 +58,7 @@ Specifies the package input path.
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-repo.1
@@ -50,7 +50,7 @@ The following options are supported by
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-search.1
@@ -45,7 +45,7 @@ file.
The following options are supported by
.Nm :
.Bl -tag -width F1
-
.It Fl g 
+
.It Fl g
Treat
.Ar pattern
as a shell glob pattern.
@@ -54,7 +54,7 @@ Treat
.Ar pattern
as a regular expression.
.It Fl X
-
Treat 
+
Treat
.Ar pattern
as an extended regular expression.
.It Fl c
@@ -86,7 +86,7 @@ Displays the installation prefix for each package matching
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-update.1
@@ -44,7 +44,7 @@ The following options are supported by
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-upgrade.1
@@ -30,7 +30,7 @@ is used for upgrading of package software distributions.
.Pp
Currently only one remote package repository database can be
used during package upgrades as defined by the environment variable
-
\fBPACKAGESITE\fP.
+
.Ev PACKAGESITE .
.Pp
Soon enough
.Nm
@@ -45,7 +45,7 @@ Assume yes when asked for confirmation before package installation.
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-version.1
@@ -27,7 +27,7 @@
.Op Fl l Ar limchar
.Op Fl L Ar limchar
.Oo
-
.Op Fl X 
+
.Op Fl X
.Fl s Ar string
.Oc
.Op Fl O Ar origin
@@ -38,7 +38,8 @@
.Fl T Ar <pkgname> Ar <pattern>
.Sh DESCRIPTION
.Nm
-
is used for generating a report of packages installed by \fBpkg(1)\fP
+
is used for generating a report of packages installed by
+
.Xr pkg 1 .
.Pp
< To be completed >
.Sh OPTIONS
@@ -64,7 +65,7 @@ Does the opposite of
flag. Displays the packages which status flag does not match the one
specified by
.Ar limchar
-
.It Fl X 
+
.It Fl X
Treat
.Ar string
as an extended regular expression.
@@ -89,7 +90,7 @@ with matching package names/patterns are echoed to standard output.
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg-which.1
@@ -36,7 +36,7 @@ The following commands are supported by
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm .
-
See 
+
See
.Xr pkg.conf 5
for further description.
.Bl -tag -width ".Ev NO_DESCRIPTIONS"
modified pkg/pkg.1
@@ -21,7 +21,7 @@
.\" ---------------------------------------------------------------------------
.Sh NAME
.Nm pkg
-
.Nd a utility for manipulating packages 
+
.Nd a utility for manipulating packages
.\" ---------------------------------------------------------------------------
.Sh SYNOPSIS
.Nm
@@ -36,7 +36,7 @@ adding, removing and upgrading of packages.
.\" ---------------------------------------------------------------------------
.Sh OPTIONS
The following options are supported by
-
.Nm:
+
.Nm :
.Bl -tag -width indent
.It Fl v
Displays the current version of
@@ -59,71 +59,71 @@ Environment
The following commands are supported by
.Nm :
.Bl -tag -width indent
-
.It \fBhelp\fP Ar <command>
-
Displays usage information of the specified command.
-
.It \fBadd\fP
-
Installs a package from either a local source or a remote one.
+
.It Ic help Ar <command>
+
Display usage information of the specified command.
+
.It Ic add
+
Install a package from either a local source or a remote one.
.Pp
When installing from remote source you need to specify the
protocol to use when fetching the package.
.Pp
Currently supported protocols are FTP, HTTP and HTTPS.
-
.It \fBaudit\fP
+
.It Ic audit
< To be added >
-
.It \fBautoremove\fP
-
Deletes packages not depended on by anyother packages and that were
-
automatically installed.
-
.It \fBbackup\fP
-
Dumps the local package database to a file specified on the command-line.
-
.It \fBcheck\fP
+
.It Ic autoremove
+
Delete packages which were automatically installed as dependencies and are not
+
required anymore.
+
.It Ic backup
+
Dump the local package database to a file specified on the command-line.
+
.It Ic check
< To be added >
-
.It \fBclean\fP
+
.It Ic clean
< To be added >
-
.It \fBcreate\fP
-
Creates a package
-
.It \fBdelete\fP
-
Deletes a package from the database and the system.
-
.It \fBinfo\fP
-
Displays information about installed packages.
-
.It \fBinstall\fP
-
Installs a package from a remote package repository.
-
If a package is found in more than one remote repositories,
+
.It Ic create
+
Create a package
+
.It Ic delete
+
Delete a package from the database and the system.
+
.It Ic info
+
Display information about installed packages.
+
.It Ic install
+
Install a package from a remote package repository.
+
If a package is found in more than one remote repository,
then installation happens from the first one. If a package
-
fails to fetch from the remote repository the next one in
+
fails to fetch from the remote repository, the next one in
the list is tried, until the package is fetched.
-
.It \fBquery\fP
-
Is used for displaying information about packages.
-
.It \fBregister\fP
-
Registers a package in the database.
-
.It \fBrepo\fP
-
Creates a package repository.
+
.It Ic query
+
Query information about installed packages.
+
.It Ic register
+
Register a package in the database.
+
.It Ic repo
+
Create a package repository.
.Pp
< To be completed >
-
.It \fBsearch\fP
-
Will search for the given pattern in the remote package
+
.It Ic search
+
Search for the given pattern in the remote package
repositories.
-
.It \fBupdate\fP
+
.It Ic update
Update the available remote repositories as listed in
.Xr pkg.conf 5 .
-
.It \fBupdating\fP
+
.It Ic updating
< To be added >
-
.It \fBupgrade\fP
-
Upgrades a package to a newer version.
-
.It \fBversion\fP
+
.It Ic upgrade
+
Upgrade a package to a newer version.
+
.It Ic version
< To be added >
-
.It \fBwhich\fP
-
Queries the database for package(s) that installed a specific
+
.It Ic which
+
Query the database for package(s) that installed a specific
file.
.El
.\" ---------------------------------------------------------------------------
.Sh ENVIRONMENT
The list of environment variables that affect the execution of
-
.Nm 
-
is in 
+
.Nm
+
is in
.Xr pkg.conf 5 .
.\" ---------------------------------------------------------------------------
.Sh FILES
-
See 
+
See
.Xr pkg.conf 5 .
.\" ---------------------------------------------------------------------------
.Sh SEE ALSO