summaryrefslogtreecommitdiff
path: root/doc/pkg
blob: 3c725784828b22741343529dcb2aa156b0379231 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
=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

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 <derf@derf.homelinux.org>

=cut

vim:ft=pod