Radish alpha
H
HardenedBSD-pkg
rad:z3QDZAW2FAfuLvihrhiyDC9fAD8G9
HardenedBSD Package Manager
Radicle
Git
Commits › baeb6a4
Document long options
Matthew Seaman committed 11 years ago
commit baeb6a460dd8243211b642a336d0cd527197b4f6
parent 9f43c41
1 file changed +25 -10
modified docs/pkg.8
@@ -15,7 +15,7 @@
.\"     @(#)pkg.8

.\" $FreeBSD$

.\"
- 
.Dd February 26, 2014
+ 
.Dd May 26, 2014

.Dt PKG 8

.Os

.\" ---------------------------------------------------------------------------
@@ -34,6 +34,16 @@
.Op Fl C Ao configuration file Ac

.Op Fl R Ao repository configuration directory Ac

.Ao command Ac Ao Ar flags Ac
+ 
.Pp
+ 
.Nm
+ 
.Op Cm --version
+ 
.Op Cm --debug
+ 
.Op Cm --list
+ 
.Op Cm --check-activationN
+ 
.Op Cm --jail Ao jail name or id Ac | Cm --chroot Ao chroot path Ac
+ 
.Op Cm --config Ao configuration file Ac
+ 
.Op Cm --repo-conf-dir Ao repository configuration directory Ac
+ 
.Ao command Ac Ao Ar flags Ac

.\" ---------------------------------------------------------------------------

.Sh DESCRIPTION

provides an interface for manipulating packages - registering,
@@ -52,12 +62,12 @@ for details.
The following options are supported by

.Nm :

.Bl -tag -width indent
- 
.It Fl v
+ 
.It Fl v , Cm --version

Displays the current version of

.Nm
- 
.It Fl d
+ 
.It Fl d , Cm --debug

Show debug information
- 
.It Fl l
+ 
.It Fl l , Cm --list

List all the available command names, and exit without performing any

other action.

The
@@ -67,12 +77,12 @@ option takes precedence over
but

.Fl l

will override any other command line arguments.
- 
.It Fl o Ao option=value Ac
+ 
.It Fl o Ao option=value Ac , Cm --option Ao option=value Ac

Set configuration option for

.Nm

from the command line. Options that are set from the environment are

redefined. It is permitted to specify this option multiple times.
- 
.It Fl N
+ 
.It Fl N , Cm --check-activation

Activation status check mode.

Prevent

.Nm
@@ -97,6 +107,11 @@ The exit status should be a reliable indication of whether a system
is configured to use

.Nm

as its package management system or not.
+ 
Since
+ 
.Xr pkg 7
+ 
does not support long options, it is recommended to always use the short
+ 
.Fl N
+ 
form.

.Pp

Example usage:

.Bd -literal -offset indent
@@ -131,7 +146,7 @@ is installed and activated:
    # pkg_install-specifics

  fi

.Ed
- 
.It Fl j Ao jail name or id Ac
+ 
.It Fl j Ao jail name or id Ac , Cm --jail Ao jail name or id Ac

.Nm

will execute in the given

.Ao jail name or id Ac ,
@@ -147,15 +162,15 @@ See
.Xr jail 8

and

.Xr jls 8 .
- 
.It Fl c Ao chroot path Ac
+ 
.It Fl c Ao chroot path Ac , Cm --chroot Ao chroot path Ac

.Nm

will chroot in the

.Ao chroot path Ac

Environment
- 
.It Fl C Ao configuration file Ac
+ 
.It Fl C Ao configuration file Ac , Cm --config Ao configuration file Ac

.Nm

will use the specified file as a configuration file
- 
.It Fl R Ao repository configuration directory Ac
+ 
.It Fl R Ao repo conf dir Ac , Cm --repo-conf-dir Ao repo conf dir Ac

.Nm

will search the directory for per-repository configuration files.

This overrides any value of