From bed8857b779b9896f6a3b54336feddb41c0a5b5a Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Tue, 7 Jul 2009 13:10:07 +0200 Subject: pkg: Recommend to postfix manuals in man/ with .pod --- man/5/pkg.conf | 114 ----------------------------------------------------- man/5/pkg.conf.pod | 108 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 108 insertions(+), 114 deletions(-) delete mode 100644 man/5/pkg.conf create mode 100644 man/5/pkg.conf.pod (limited to 'man/5') diff --git a/man/5/pkg.conf b/man/5/pkg.conf deleted file mode 100644 index 9bb918a..0000000 --- a/man/5/pkg.conf +++ /dev/null @@ -1,114 +0,0 @@ -=pod - -=head1 NAME - -~/.pkg.conf - L(1) configuration - -=head1 DESCRIPTION - -Contains configuration variables for L(1) - -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. - -With the exception of B, all variables are optional as they have -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=I (--packageroot I) - -the package root path. -I may either be of the form C or C. - -=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] - -path for the local package tree - -=item B=(I) (--checklinks-options I) [-q] - -Options to invoke L(1) with - -=item B=I (--colours) [1] - -Colorize the output (cyan for info messages, red for errors/warnings) - -=item B=I (--progress) [1] - -Show a progress bar when performing tasks on all packages - -=item B=I (--quiet) [0] - -Operate in silent mode. If B<1>, it also sets PROGRESS=0 - -=item B=I (--debug) [0] - -Operate in debug mode if 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] - -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. - -If you regularly change your PKG_ROOT, are too lazy to properly configure your -git repos or whatever, set this to 0. Then, pkg will always call git pull/push -with both the remote repo and the branch as arguments. - -=item BI {I} - -Define the global hook I, its I will be executed -together with pkg's global hooks; the name of the package for which the hook is -being executed will be given as first parameter and is accessible throug B<$1>. -The hook is just a zsh function, so you can use any valid syntax you want, -including newlines. -See zsh(1) for more. - -Valid I names are: post-add, pre-update, post-update, pre-remove. -Note that post-add automatically executes post-update. - -Example: function pkg_hook_post-update {clear_line; echo "Hello from package $1!"} - -=back - -=head2 COLOURS - -Colours are defined in the same way as options. They take an ANSI escape code -as argument. - -=over - -=item B=I (C<$'\e[0;36m'>) - -Colour for informational messages (default: cyan) - -=item B=I (C<$'\e[0;31m'>) - -Colour for warning and error messages (default: red) - -=back - -=head1 SEE ALSO - -L(1), L(1) - -=cut - -vim:ft=pod diff --git a/man/5/pkg.conf.pod b/man/5/pkg.conf.pod new file mode 100644 index 0000000..d690c4f --- /dev/null +++ b/man/5/pkg.conf.pod @@ -0,0 +1,108 @@ +=head1 NAME + +~/.pkg.conf - L(1) configuration + +=head1 DESCRIPTION + +Contains configuration variables for L(1) + +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. + +With the exception of B, all variables are optional as they have +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=I (--packageroot I) + +the package root path. +I may either be of the form C or C. + +=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] + +path for the local package tree + +=item B=(I) (--checklinks-options I) [-q] + +Options to invoke L(1) with + +=item B=I (--colours) [1] + +Colorize the output (cyan for info messages, red for errors/warnings) + +=item B=I (--progress) [1] + +Show a progress bar when performing tasks on all packages + +=item B=I (--quiet) [0] + +Operate in silent mode. If B<1>, it also sets PROGRESS=0 + +=item B=I (--debug) [0] + +Operate in debug mode if 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] + +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. + +If you regularly change your PKG_ROOT, are too lazy to properly configure your +git repos or whatever, set this to 0. Then, pkg will always call git pull/push +with both the remote repo and the branch as arguments. + +=item BI {I} + +Define the global hook I, its I will be executed +together with pkg's global hooks; the name of the package for which the hook is +being executed will be given as first parameter and is accessible throug B<$1>. +The hook is just a zsh function, so you can use any valid syntax you want, +including newlines. +See zsh(1) for more. + +Valid I names are: post-add, pre-update, post-update, pre-remove. +Note that post-add automatically executes post-update. + +Example: function pkg_hook_post-update {clear_line; echo "Hello from package $1!"} + +=back + +=head2 COLOURS + +Colours are defined in the same way as options. They take an ANSI escape code +as argument. + +=over + +=item B=I (C<$'\e[0;36m'>) + +Colour for informational messages (default: cyan) + +=item B=I (C<$'\e[0;31m'>) + +Colour for warning and error messages (default: red) + +=back + +=head1 SEE ALSO + +L(1), L(1) -- cgit v1.2.3