summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/1/bootstrap34
-rw-r--r--man/1/pkg91
-rw-r--r--man/5/pkg.conf55
3 files changed, 180 insertions, 0 deletions
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 <derf@derf.homelinux.org>
+
+=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<pkg> 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<changelog> I<package>
+
+Show I<package>'s changelog (if available)
+
+=item B<changeroot> I<source>
+
+Change the default source on all packages to I<source>
+
+Example: `changeroot ssh://kraftwerk/var/packages_root` will change
+the source of core to 'ssh://kraftwerk/var/packages_root/core'
+
+=item B<delete>, B<remove> I<package>
+
+Remove I<package> from the local packages tree
+Note: This does not yet remove the symlinks
+
+=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<log> I<package>
+
+Show commit history for package
+
+=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> [ I<package> ]
+
+retrieve and install newest available version of I<package>.
+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 <derf@derf.homelinux.org>
+
+=head1 SEE ALSO
+
+L<pkg.conf>(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<pkg>(1) configuration
+
+=head1 DESCRIPTION
+
+Contains configuration variables for L<pkg>(1)
+
+The file consists of multiple lines of the form I<variable>=I<value>.
+
+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<PKG_ROOT>=I<url>
+
+the package root path.
+Default: ssh://derf.homelinux.org/var/packages_root
+
+=item B<PDIR>=I<path>
+
+path for the local package tree.
+Default: $HOME/packages
+
+WARNING: changing this will break everything. Don't do it.
+
+=item B<VCS_CMD>=I<command>
+
+Command to invoke the vcs.
+Default: hg
+
+=item B<VCS_OPTIONS>=I<options>
+
+global options to invoke VCS_CMD with.
+Default: --quiet
+
+=item B<CL_OPTIONS>=I<options>
+
+Options to invoke L<checklinks>(1) with.
+Default: -q
+
+=back
+
+=head1 SEE ALSO
+
+L<pkg>(1), L<checklinks>(1)
+
+=cut
+
+vim:ft=pod