From f1ff3661cdf480fa035f6b557f61d57c10085d5e Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Tue, 7 Jul 2009 14:51:13 +0200 Subject: Updated/beautified pkg.conf(5) --- man/5/pkg.conf.pod | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'man/5') diff --git a/man/5/pkg.conf.pod b/man/5/pkg.conf.pod index d690c4f..2e3273d 100644 --- a/man/5/pkg.conf.pod +++ b/man/5/pkg.conf.pod @@ -1,17 +1,17 @@ =head1 NAME -~/.pkg.conf - L(1) configuration +~/.config/pkg/pkg.conf - L(1) configuration =head1 DESCRIPTION -Contains configuration variables for L(1) +Contains configuration parameters for L(1) -The file consists of multiple lines of the form I=I. +The file consists of multiple lines of the form I=I. 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. +as comment and that there must be no space between the parameter and the content. -With the exception of B, all variables are optional as they have +With the exception of B, all parameters are optional as they have reasonable (so I hope) defaults. =head1 OPTIONS @@ -22,46 +22,46 @@ The text in [these braces] is the default value. =over -=item B=I (--packageroot I) +=item B=I (--packageroot I) the package root path. I may either be of the form C or C. -=item B=I [$PKG_PATH/pkglist] +=item B=I [$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=I (--packagedir I) [$HOME/packages] +=item B=I (--packagedir I) [$HOME/packages] path for the local package tree -=item B=(I) (--checklinks-options I) [-q] +=item B=(I) (--checklinks-options I) [-q] Options to invoke L(1) with -=item B=I (--colours) [1] +=item B=I (--colours) [1] Colorize the output (cyan for info messages, red for errors/warnings) -=item B=I (--progress) [1] +=item B=I (--progress) [1] Show a progress bar when performing tasks on all packages -=item B=I (--quiet) [0] +=item B=I (--quiet) [0] Operate in silent mode. If B<1>, it also sets PROGRESS=0 -=item B=I (--debug) [0] +=item B=I (--debug) [0] Operate in debug mode if 1 -=item B=I (--auto-update) [1] +=item B=I (--auto-update) [1] If 1, automatically execute 'pkg update' before 'pkg push' and 'pkg remote-update' before 'pkg upgrade' -=item B=I [1] +=item B=I [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. -- cgit v1.2.3