doc/pkg: converted to pod

1 files changed, 92 insertions, 52 deletions

diff --git a/doc/pkg b/doc/pkg
index 0e8ca19..fed6512 100644
--- a/doc/pkg
+++ b/doc/pkg
@@ -1,75 +1,115 @@
+=head1 NAME
+
 pkg - Package maintaining utility
 
-Usage: pkg action [ arguments ]
+=head1 SYNOPSIS
+
+B<pkg> I<action> [ I<arguments> ]
+
+=head1 DESCRIPTION
+
+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
 
-action may be one of:
+=over
 
-	add, install package
-		fetch given package from the package_root and install it
+=item F<~/.pkg.conf>
 
-	changelog package
-		Show package's changelog (if available)
+Contains configuration vars
 
-	changeroot source
-		Change the default source on all packages to source
-		Example: `changeroot ssh://kraftwerk/var/packages_root` will change
-		the source of core to 'ssh://kraftwerk/var/packages_root/core'
+syntax: VAR='argument'.
+comments with "#" are supported
 
-	delete, remove package
-		Remove the package from the local packages tree
-		Note: This does not yet remove the symlinks
+=back
 
-	doc command
-		Show documentation on command, if available
-		Note: command must be shipped by a package, of course
+=head2 VARIABLES
 
-	info package
-		Show information on package, like dependencies, version, etc
+=over
 
-	list
-		List all installed packages
+=item PKG_ROOT
 
-	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
+the package root path.
+Default: ssh://derf.homelinux.org/var/packages_root
 
-	log package
-		Show commit history for package
+=item PDIR
 
-	status [ package ]
-		Check for local changes to the packages files
-		If no arguments is given, checks all installed packages
+path for the local package tree.
+Default: $HOME/packages
 
-	update [ package ]
-		retreive and install newest available version of package
-		If no argument is given, updates all installed packages
+WARNING: changing this will break everything. Don't do it.
 
+=item VCS_CMD
 
-~/.pkg.conf:
-	Contains configuration vars
+Command to invoke the vcs.
+Default: hg
 
-	syntax: VAR='argument'
-	comments with "#" are supported
+=item VCS_OPTIONS
 
-	PKG_ROOT
-		the package root path
-		Default: ssh://derf.homelinux.org/var/packages_root
+global options to invoke VCS_CMD with.
+Default: --quiet
 
-	PDIR
-		path for the local package tree
-		WARNING: changing this will break everything. Don't do it.
-		Default: $HOME/packages
+=item CL_OPTIONS
 
-	VCS_CMD
-		Command to invoke the vcs
-		Default: hg
+Options to invoke checklinks with
+Default: -q
 
-	VCS_OPTIONS
-		global options to invoke VCS_CMD with
-		Default: --quiet
+=back
 
-	CL_OPTIONS
-		Options to invoke checklinks with
-		Default: -q
+=head1 AUTHOR
 
+Daniel Friesel <derf@derf.homelinux.org>