=pod

=head1 NAME

pkg - Package maintenance utility

=head1 SYNOPSIS

B<pkg> [I<options>] I<action> [I<arguments>]

=head1 DESCRIPTION

B<pkg> is the basic script for maintaining packages

I<action> may be one of:

=over

=item B<add>|B<install> I<package>

fetch given I<package> from the package_root and install it

=item B<delete>|B<remove> I<package>

Remove I<package> from the local packages tree

=item B<eval> I<expression>

Evauluate I<expression>. See the 'Examples' section and pkg(7)

=item B<info> I<package>

Show information on I<package>, like dependencies, version, etc

=item B<list>

List all installed packages

=item B<list-all>

List all available (both installed and not installed packages

Hint: `diff <(pkg list) <(pkg list-all)` will show all packages
that are currently not installed

=item B<local-update>

Update the local package list

=item B<log> I<package>

Show commit history for package

=item B<push> [ I<package> ]

push new local versions to PKG_ROOT.
If no argument is given, pushes all installed packages

=item B<refresh> [ I<package> ]

Check prereqs and update symlinks of I<package>.
If no argument is given, refreshs all installed packages

=item B<remote-update>

Update remote package list

=item B<status> [ I<package> ]

Check for local changes to the I<package>'s files.
If no arguments is given, checks all installed packages

=item B<update>

Update local and remote package list

=item B<upgrade>|B<pull> [ I<package> ]

retrieve and install newest available version of I<package>.
If no argument is given, updates all installed packages

=back

=head1 OPTIONS

B<pkg> accepts both long and short options.
Options marked as [boolean] may be negated,
the short options by using '+' instead of '-' as prefix (like '+au'),
the long options by prepending a 'no', like '--no-auto-update'.

Options always override the configuration file and the environment variables.

=over

=item B<-q>, B<--quiet>  [boolean]

Enable quiet mode, don't print progress. Useful for scripting

=item B<-d>, B<--debug>  [boolean]

Enable debug mode

=item B<-au>, B<--auto-update>  [boolean]

Automatically update the package list before doing certain actions

=item B<-co>, B<--checklinks-options> I<option>

Append I<option> to the options checklinks is invoked with.
Only one option is allowed. To append more options, repeat the argument

=item B<-p>, B<--package-dir> I<directory>

Use I<directory> as local package directory

=back

=head1 FILES

=over

=item F<~/.pkg.conf>

Contains configuration vars

=back

=head1 WARNING

This is early-beta software. No backwards compatibility guaranteed.
Please refer to pkg(7)

=head1 EXAMPLES

=over

=item * B<pkg remote-update; pkg upgrade>

Get new stuff from the packages_root.
Note: If you haven't disabled AUTOUPDATE, B<pkg upgrade> will suffice here

=item * B<pkg local-update; pkg push>

Push local changes to the packages_root.
Note: If you haven't disabled AUTOUPDATE, B<pkg push> will suffice here

=item * B<pkg refresh core>

'Fake-Upgrade'. Execute the appropiate commands as if the core package had been
upgraded (useful when you change something but don't want to commit/push yet)

=back

=head1 AUTHOR

Daniel Friesel <derf@derf.homelinux.org>

=head1 CREDITS

=over

=item * Lars Stoltenow (penma)

for pointing out various bugs and design mistakes

=item * Maximilian Gass (mxey)

many ideas and suggestions

=back

=head1 SEE ALSO

L<pkg.conf>(5), pkg(7)

=cut

vim:ft=pod