summaryrefslogtreecommitdiff
path: root/man/5/pkg.conf
blob: b508807f6dabc23190aab82b42df0c476e7bb9de (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
=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.

With the exception of B<PKG_ROOT>, all variables are optional as they have
reasonable (so I hope) defaults.

=head1 OPTIONS

=over

=item B<PKG_ROOT>=I<url>

the package root path

=item B<PDIR>=I<path> ($HOME/packages)

path for the local package tree

=item B<CL_OPTIONS>=I<options> (-q)

Options to invoke L<checklinks>(1) with

=item B<SILENT>=I<boolean> (0)

Operate in silent mode if 1

=item B<DEBUG>=I<boolean> (0)

Operate in debug mode if 1

=item B<AUTOUPDATE>=I<boolean> (1)

If 1, automatically execute 'pkg update' before 'pkg push'
and 'pkg remote-update' before 'pkg upgrade'

=back

=head1 SEE ALSO

L<pkg>(1), L<checklinks>(1)

=cut

vim:ft=pod