From 8cfb41bc6e5f71086a6faab181c038ae223036a1 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sat, 7 Jun 2008 22:19:10 +0200 Subject: added manual for pkg.conf --- doc/bootstrap | 34 ---------------- doc/pkg | 123 -------------------------------------------------------- man/1/bootstrap | 34 ++++++++++++++++ man/1/pkg | 91 +++++++++++++++++++++++++++++++++++++++++ man/5/pkg.conf | 55 +++++++++++++++++++++++++ 5 files changed, 180 insertions(+), 157 deletions(-) delete mode 100644 doc/bootstrap delete mode 100644 doc/pkg create mode 100644 man/1/bootstrap create mode 100644 man/1/pkg create mode 100644 man/5/pkg.conf diff --git a/doc/bootstrap b/doc/bootstrap deleted file mode 100644 index 1b58727..0000000 --- a/doc/bootstrap +++ /dev/null @@ -1,34 +0,0 @@ -=pod - -=head1 NAME - -bootstrap - install the most essential utilities in $HOME. - -=head1 SYNOPSIS - -B<./bootstrap> - -=head1 DESCRIPTION - -bootstrap will, in this order, do the following: - -=over - -=item * create a basic directory structure - -=item * Check whether python is installed on the machine - -=item * Check whether mercurial is install on the machine. -If not, receives a pre-build one via ssh/tar - -=item * Clone and then install the core repository - -=back - -=head1 AUTHOR - -Daniel Friesel - -=cut - -vim:ft=pod diff --git a/doc/pkg b/doc/pkg deleted file mode 100644 index 3c72578..0000000 --- a/doc/pkg +++ /dev/null @@ -1,123 +0,0 @@ -=pod - -=head1 NAME - -pkg - Package maintenance utility - -=head1 SYNOPSIS - -B I [ I ] - -=head1 DESCRIPTION - -B is the basic script for maintaining packages - -I may be one of: - -=over - -=item B, B I - -fetch given I from the package_root and install it - -=item B I - -Show I's changelog (if available) - -=item B I - -Change the default source on all packages to I - -Example: `changeroot ssh://kraftwerk/var/packages_root` will change -the source of core to 'ssh://kraftwerk/var/packages_root/core' - -=item B, B I - -Remove I from the local packages tree -Note: This does not yet remove the symlinks - -=item B I - -Show information on I, like dependencies, version, etc - -=item B - -List all installed packages - -=item B - -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 I - -Show commit history for package - -=item B [ I ] - - -Check for local changes to the I's files. -If no arguments is given, checks all installed packages - -=item B [ I ] - -retrieve and install newest available version of I. -If no argument is given, updates all installed packages - -=back - -=head1 FILES - -=over - -=item F<~/.pkg.conf> - -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 - -=cut - -vim:ft=pod diff --git a/man/1/bootstrap b/man/1/bootstrap new file mode 100644 index 0000000..1b58727 --- /dev/null +++ b/man/1/bootstrap @@ -0,0 +1,34 @@ +=pod + +=head1 NAME + +bootstrap - install the most essential utilities in $HOME. + +=head1 SYNOPSIS + +B<./bootstrap> + +=head1 DESCRIPTION + +bootstrap will, in this order, do the following: + +=over + +=item * create a basic directory structure + +=item * Check whether python is installed on the machine + +=item * Check whether mercurial is install on the machine. +If not, receives a pre-build one via ssh/tar + +=item * Clone and then install the core repository + +=back + +=head1 AUTHOR + +Daniel Friesel + +=cut + +vim:ft=pod diff --git a/man/1/pkg b/man/1/pkg new file mode 100644 index 0000000..8c976f1 --- /dev/null +++ b/man/1/pkg @@ -0,0 +1,91 @@ +=pod + +=head1 NAME + +pkg - Package maintenance utility + +=head1 SYNOPSIS + +B I [ I ] + +=head1 DESCRIPTION + +B is the basic script for maintaining packages + +I may be one of: + +=over + +=item B, B I + +fetch given I from the package_root and install it + +=item B I + +Show I's changelog (if available) + +=item B I + +Change the default source on all packages to I + +Example: `changeroot ssh://kraftwerk/var/packages_root` will change +the source of core to 'ssh://kraftwerk/var/packages_root/core' + +=item B, B I + +Remove I from the local packages tree +Note: This does not yet remove the symlinks + +=item B I + +Show information on I, like dependencies, version, etc + +=item B + +List all installed packages + +=item B + +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 I + +Show commit history for package + +=item B [ I ] + + +Check for local changes to the I's files. +If no arguments is given, checks all installed packages + +=item B [ I ] + +retrieve and install newest available version of I. +If no argument is given, updates all installed packages + +=back + +=head1 FILES + +=over + +=item F<~/.pkg.conf> + +Contains configuration vars + +=back + +=head1 AUTHOR + +Daniel Friesel + +=head1 SEE ALSO + +L(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(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. + +=head1 OPTIONS + +=over + +=item B=I + +the package root path. +Default: ssh://derf.homelinux.org/var/packages_root + +=item B=I + +path for the local package tree. +Default: $HOME/packages + +WARNING: changing this will break everything. Don't do it. + +=item B=I + +Command to invoke the vcs. +Default: hg + +=item B=I + +global options to invoke VCS_CMD with. +Default: --quiet + +=item B=I + +Options to invoke L(1) with. +Default: -q + +=back + +=head1 SEE ALSO + +L(1), L(1) + +=cut + +vim:ft=pod -- cgit v1.2.3