summaryrefslogtreecommitdiff
path: root/man/5/pkg.conf
diff options
context:
space:
mode:
Diffstat (limited to 'man/5/pkg.conf')
-rw-r--r--man/5/pkg.conf25
1 files changed, 16 insertions, 9 deletions
diff --git a/man/5/pkg.conf b/man/5/pkg.conf
index 78d9df0..4b04166 100644
--- a/man/5/pkg.conf
+++ b/man/5/pkg.conf
@@ -13,26 +13,33 @@ The file consists of multiple lines of the form I<variable>=I<value>.
Normal zsh syntax is allowed, which means everything after '#' will be treated
a comment and that there must be no space between the variable and the content.
+With the exception of B<PKG_ROOT>, all variables are optional as they have
+reasonable (so I hope) defaults.
+
=head1 OPTIONS
=over
=item B<PKG_ROOT>=I<url>
-the package root path.
-Default: ssh://derf.homelinux.org/~/var/packages_root
+the package root path
+
+=item B<PDIR>=I<path> ($HOME/packages)
+
+path for the local package tree
+
+=item B<CL_OPTIONS>=I<options> (-q)
-=item B<PDIR>=I<path>
+Options to invoke L<checklinks>(1) with
-path for the local package tree.
-Default: $HOME/packages
+=item B<SILENT>=I<boolean> (0)
-WARNING: changing this will break everything. Don't do it.
+Operate in silent mode if 1
-=item B<CL_OPTIONS>=I<options>
+=item B<AUTOUPDATE>=I<boolean> (1)
-Options to invoke L<checklinks>(1) with.
-Default: -q
+If 1, automatically execute 'pkg update' before 'pkg push'
+and 'pkg remote-update' before 'pkg upgrade'
=back