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/1/pkg | 168 ---------------------------------------------------------- man/1/pkg.pod | 162 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 162 insertions(+), 168 deletions(-) delete mode 100644 man/1/pkg create mode 100644 man/1/pkg.pod (limited to 'man/1') diff --git a/man/1/pkg b/man/1/pkg deleted file mode 100644 index 830fd3e..0000000 --- a/man/1/pkg +++ /dev/null @@ -1,168 +0,0 @@ -=pod - -=head1 NAME - -pkg - distributed dotfile and script manager - -=head1 SYNOPSIS - -B [I] I [I] - -=head1 DESCRIPTION - -B is the basic script for maintaining packages - -I may be one of: - -=over - -=item B I - -fetch given I from the package_root and install it - -=item B I - -Remove I from the local packages tree - -=item B I - -Evauluate I. See pkg(7) - -=item B I - -Show information on I, like dependencies, version, etc - -=item B [I] - -List packages depending on I: - -=over - -=item * B - -show all packages - -=item * B - -show currently installed packages (default) - -=item * B - -show remote packages which are not installed - -=back - -=item B I - -Show commit history for package - -=item B [ I ] - -push new local versions to PKG_ROOT. -If no argument is given, pushes all installed packages - -=item B [ I ] - -Check prereqs and update symlinks of I. -If no argument is given, refreshs all installed packages - -=item B [ I ] - -Check for local changes to the I's files. -If no arguments is given, checks all installed packages - -=item B [ B|B ] - -Update local/remote package list (both if no argument is given) - -=item B [ I ] - -retrieve and install newest available version of I. -If no argument is given, updates all installed packages - -=back - -=head2 SHORT ACTIONS - -Instead of the Is described above, you may also use their short -forms: - - short long form - ----- --------- - a add - e eval - f pull (think "fetch") - i info - l log - ls list - p push - r refresh - rm remove - s status - u update - -=head1 OPTIONS - -Options marked as [boolean] may be negated -by prepending a 'no', like '--no-auto-update'. - -Options always override the configuration file. -Also, every option refers to a configuration parameter, -so please see pkg.conf(5) for more information. - -=head1 FILES - -=over - -=item F<~/.pkg.conf> - -Contains configuration vars - -=back - -=head1 EXAMPLES - -=over - -=item * B - -Get new stuff from the packages_root. -Note: If you haven't disabled AUTOUPDATE, B will suffice here - -=item * B - -Push local changes to the packages_root. -Note: If you haven't disabled AUTOUPDATE, B will suffice here - -=item * B - -'Fake-Upgrade'. Execute the appropiate commands as if the pkg package had been -upgraded (useful when you change something but don't want to commit/push yet) - -=back - -=head1 AUTHOR - -Daniel Friesel Ederf@derf.homelinux.orgE - -=head1 CREDITS - -=over - -=item * Lars Stoltenow (penma) - -for pointing out various bugs and design mistakes - -=item * Maximilian GaE (mxey) - -many ideas and suggestions - -=back - -=head1 SEE ALSO - -L(5), pkg(7) - -=cut - -vim:ft=pod diff --git a/man/1/pkg.pod b/man/1/pkg.pod new file mode 100644 index 0000000..7f207ba --- /dev/null +++ b/man/1/pkg.pod @@ -0,0 +1,162 @@ +=head1 NAME + +pkg - distributed dotfile and script manager + +=head1 SYNOPSIS + +B [I] I [I] + +=head1 DESCRIPTION + +B is the basic script for maintaining packages + +I may be one of: + +=over + +=item B I + +fetch given I from the package_root and install it + +=item B I + +Remove I from the local packages tree + +=item B I + +Evauluate I. See pkg(7) + +=item B I + +Show information on I, like dependencies, version, etc + +=item B [I] + +List packages depending on I: + +=over + +=item * B + +show all packages + +=item * B + +show currently installed packages (default) + +=item * B + +show remote packages which are not installed + +=back + +=item B I + +Show commit history for package + +=item B [ I ] + +push new local versions to PKG_ROOT. +If no argument is given, pushes all installed packages + +=item B [ I ] + +Check prereqs and update symlinks of I. +If no argument is given, refreshs all installed packages + +=item B [ I ] + +Check for local changes to the I's files. +If no arguments is given, checks all installed packages + +=item B [ B|B ] + +Update local/remote package list (both if no argument is given) + +=item B [ I ] + +retrieve and install newest available version of I. +If no argument is given, updates all installed packages + +=back + +=head2 SHORT ACTIONS + +Instead of the Is described above, you may also use their short +forms: + + short long form + ----- --------- + a add + e eval + f pull (think "fetch") + i info + l log + ls list + p push + r refresh + rm remove + s status + u update + +=head1 OPTIONS + +Options marked as [boolean] may be negated +by prepending a 'no', like '--no-auto-update'. + +Options always override the configuration file. +Also, every option refers to a configuration parameter, +so please see pkg.conf(5) for more information. + +=head1 FILES + +=over + +=item F<~/.pkg.conf> + +Contains configuration vars + +=back + +=head1 EXAMPLES + +=over + +=item * B + +Get new stuff from the packages_root. +Note: If you haven't disabled AUTOUPDATE, B will suffice here + +=item * B + +Push local changes to the packages_root. +Note: If you haven't disabled AUTOUPDATE, B will suffice here + +=item * B + +'Fake-Upgrade'. Execute the appropiate commands as if the pkg package had been +upgraded (useful when you change something but don't want to commit/push yet) + +=back + +=head1 AUTHOR + +Daniel Friesel Ederf@derf.homelinux.orgE + +=head1 CREDITS + +=over + +=item * Lars Stoltenow (penma) + +for pointing out various bugs and design mistakes + +=item * Maximilian GaE (mxey) + +many ideas and suggestions + +=back + +=head1 SEE ALSO + +L(5), pkg(7) -- cgit v1.2.3