added manual for pkg.conf

3 files changed, 59 insertions, 36 deletions

diff --git a/doc/bootstrap b/man/1/bootstrap
index 1b58727..1b58727 100644
--- a/doc/bootstrap
+++ b/man/1/bootstrap
diff --git a/doc/pkg b/man/1/pkg
index 3c72578..8c976f1 100644
--- a/doc/pkg
+++ b/man/1/pkg
@@ -76,48 +76,16 @@ If no argument is given, updates all installed packages
 
 Contains configuration vars
 
-syntax: VAR='argument'.
-comments with "#" are supported
-
-=back
-
-=head2 VARIABLES
-
-=over
-
-=item PKG_ROOT
-
-the package root path.
-Default: ssh://derf.homelinux.org/var/packages_root
-
-=item PDIR
-
-path for the local package tree.
-Default: $HOME/packages
-
-WARNING: changing this will break everything. Don't do it.
-
-=item VCS_CMD
-
-Command to invoke the vcs.
-Default: hg
-
-=item VCS_OPTIONS
-
-global options to invoke VCS_CMD with.
-Default: --quiet
-
-=item CL_OPTIONS
-
-Options to invoke checklinks with.
-Default: -q
-
 =back
 
 =head1 AUTHOR
 
 Daniel Friesel <derf@derf.homelinux.org>
 
+=head1 SEE ALSO
+
+L<pkg.conf>(5)
+
 =cut
 
 vim:ft=pod
diff --git a/man/5/pkg.conf b/man/5/pkg.conf
new file mode 100644
index 0000000..1446e19
--- /dev/null
+++ b/man/5/pkg.conf
@@ -0,0 +1,55 @@
+=pod
+
+=head1 NAME
+
+pkg.conf - L<pkg>(1) configuration
+
+=head1 DESCRIPTION
+
+Contains configuration variables for L<pkg>(1)
+
+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.
+
+=head1 OPTIONS
+
+=over
+
+=item B<PKG_ROOT>=I<url>
+
+the package root path.
+Default: ssh://derf.homelinux.org/var/packages_root
+
+=item B<PDIR>=I<path>
+
+path for the local package tree.
+Default: $HOME/packages
+
+WARNING: changing this will break everything. Don't do it.
+
+=item B<VCS_CMD>=I<command>
+
+Command to invoke the vcs.
+Default: hg
+
+=item B<VCS_OPTIONS>=I<options>
+
+global options to invoke VCS_CMD with.
+Default: --quiet
+
+=item B<CL_OPTIONS>=I<options>
+
+Options to invoke L<checklinks>(1) with.
+Default: -q
+
+=back
+
+=head1 SEE ALSO
+
+L<pkg>(1), L<checklinks>(1)
+
+=cut
+
+vim:ft=pod