147be2f74e42af0629cda760d197eccd0942a383
[openafs.git] / src / package / package.8
1 .TH PACKAGE 1 "26 August 1986"
2 .UC 4
3 .SH NAME
4 package \- maintain local disk configuration
5 .SH SYNOPSIS
6 .B /etc/package
7 [
8 .B \-vnsky
9 ]
10 [
11 .B \-c conf
12 ]
13 .SH DESCRIPTION
14 .I Package
15 maintains files and directories on a machine's local disk
16 as specified in a configuration file. Each machine using
17 .I package
18 is assumes to have access to a distributed filesystem such as
19 .I "Vice II"
20 from which master copies of files may be fetched.
21 .I Package
22 uses file modification times to determine when a file is current or not.
23 .PP
24 The format of the configuration file is the following:
25 .PP
26 type file [proto] [username[groupname]] [mode]
27 .PP
28 The type field specifies one of B, C, D, F, L, S standing for
29 block special device, charactor special device, directory, regular file,
30 symbolic link, and socket respectively. Directory type specifications may also
31 have a following X to specify a lost+found directory or an R to specify
32 that any extra files not configured in that directory are to be
33 removed. (Use this
34 option carefully.) Similarly the regular file specification may have a
35 following I to specify that this file is only to be copied into place if
36 the file is not present, likewise a following O specifies that when a file is
37 updated the old copy should be renamed with a suffix of .old.
38 .PP
39 The file field specifies an absolute path of the local file.
40 .PP
41 The proto field specifies a major and minor device number when used in
42 a block or charactor special device entry or the prefix to used to name
43 the master file (or real file in the case of a symbolic link.)
44 If the letter A is appended to update mode then the proto field specifies
45 and absolute path and does not have the file appended to it to form the path.
46 If the letter Q is appended to update mode then when this file is update
47 .I package
48 will exit with the status of 4. (This only works for file modes.)
49 .PP
50 The username, groupname, and mode are all optional and when not specified
51 the permissions of the master file are used.
52 .PP
53 Normally the configuration file is named
54 .I
55 /etc/package.SYS
56 where ``SYS'' reflects the actual system type of the machine,
57 as defined by the
58 .I /usr/andrew/bin/sys
59 program.
60 Other configuration files may be specified by the
61 .I c
62 flag.
63 However, the actual system type will be supplied by
64 .I package
65 and must not be give in the name.
66 .PP
67 Normally
68 .I package
69 prints out what is is doing, unless the
70 .I s
71 flag is given.
72 The
73 .I v
74 flag increases the level of verbosity of the output.
75 .PP
76 The
77 .I n
78 flag is used to tell
79 .I package
80 not to do any actual work but instead just tell what it would do. (This
81 is useful in debugging configuration files.)
82 .PP
83 By default, package will not update a file if it exists and
84 none of the write bits are set.  The
85 .I y
86 flag enables updating of these files.
87 The
88 .I k
89 prohibits updating of these files, and is present for compatibility.
90 .SH FILES
91 .br
92 /etc/package.SYS - default package configuration file