summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorDaniel Friesel <derf@derf.homelinux.org>2009-07-06 11:35:22 +0200
committerDaniel Friesel <derf@derf.homelinux.org>2009-07-06 11:35:22 +0200
commit206705404178245fa5fc5020a8fed2e30441d8ac (patch)
tree839bbdfd694255b5c319adc5e3664f102bd23b12 /man
parentcaf80d71bc1b294933a881d617baa29a231cdafb (diff)
Merged the options in pkg(1) into pkg.conf(5)
Diffstat (limited to 'man')
-rw-r--r--man/1/pkg31
-rw-r--r--man/5/pkg.conf20
2 files changed, 14 insertions, 37 deletions
diff --git a/man/1/pkg b/man/1/pkg
index 7851477..672d012 100644
--- a/man/1/pkg
+++ b/man/1/pkg
@@ -88,35 +88,8 @@ Options marked as [boolean] may be negated
by prepending a 'no', like '--no-auto-update'.
Options always override the configuration file.
-
-=over
-
-=item B<--quiet> [boolean]
-
-Enable quiet mode, don't print progress. Useful for scripting
-
-=item B<--debug> [boolean]
-
-Enable debug mode
-
-=item B<--auto-update> [boolean]
-
-Automatically update the package list before doing certain actions
-
-=item B<--checklinks-options> I<option>
-
-Append I<option> to the options checklinks is invoked with.
-Only one option is allowed. To append more options, repeat the argument
-
-=item B<--packagedir> I<directory>
-
-Use I<directory> as local package directory
-
-=item B<--packageroot> I<URL>
-
-Use I<URL> as package root
-
-=back
+Also, every option refers to a configuration parameter,
+so please see pkg.conf(5) for more information.
=head1 FILES
diff --git a/man/5/pkg.conf b/man/5/pkg.conf
index 074487c..cfa1c9f 100644
--- a/man/5/pkg.conf
+++ b/man/5/pkg.conf
@@ -18,40 +18,44 @@ reasonable (so I hope) defaults.
=head1 OPTIONS
+The text in (braces) refers to the pkg commandline option with which the config
+setting may be overridden (if present).
+The text in [these braces] is the default value.
+
=over
-=item B<PKG_ROOT>=I<url>
+=item B<PKG_ROOT>=I<url> (--packageroot I<url>)
the package root path.
I<url> may either be of the form C<ssh://host/path> or C</path>.
-=item B<PKGLIST_PATH>=I<path> ($PKG_PATH/pkglist)
+=item B<PKGLIST_PATH>=I<path> [$PKG_PATH/pkglist]
path to pkglist on the package root, to generate the package list.
In the default, $PKG_PATH means the path component of $PKG_ROOT.
-=item B<PKG_DIR>=I<path> ($HOME/packages)
+=item B<PKG_DIR>=I<path> (--packagedir I<path>) [$HOME/packages]
path for the local package tree
-=item B<CL_OPTIONS>=(I<options>) (-q)
+=item B<CL_OPTIONS>=(I<options>) (--checklinks-options I<options>) [-q]
Options to invoke L<checklinks>(1) with
-=item B<SILENT>=I<boolean> (0)
+=item B<SILENT>=I<boolean> (--quiet) [0]
Operate in silent mode if 1
-=item B<DEBUG>=I<boolean> (0)
+=item B<DEBUG>=I<boolean> (--debug) [0]
Operate in debug mode if 1
-=item B<AUTOUPDATE>=I<boolean> (1)
+=item B<AUTOUPDATE>=I<boolean> (--auto-update) [1]
If 1, automatically execute 'pkg update' before 'pkg push'
and 'pkg remote-update' before 'pkg upgrade'
-=item B<GIT_USE_ORIGIN>=I<boolean> (1)
+=item B<GIT_USE_ORIGIN>=I<boolean> [1]
By default, pkg will simply issue a git push/pull, so that git will use the
repository's origin to determine where to push/pull.