-
Notifications
You must be signed in to change notification settings - Fork 0
/
rcd.conf.5
159 lines (127 loc) · 8.47 KB
/
rcd.conf.5
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
.\" To report problems with this software, visit http://bugzilla.ximian.com
.TH "rcd.config" "5" "1.0" "Ximian, Inc. 2002\-2004" "RCD Configuration File"
.SH "NAME"
rcd.conf \- Red Carpet Daemon (rcd) configuration file.
.SH "DESCRIPTION"
The Red Carpet Daemon, rcd, uses a system\-wide configuration file for setting various options related to its operation. You may edit the configuration file directly, or set options using one of the rcd clients. The most obvious mechanism for doing so is the \fIrug set\fR command. See the \fIrug\fR man page for more information.
.SH "CONFIGURATION FILE FORMAT"
.LP
The configuration file is in the GNOME config file format, similar to Windows .ini files. Entries are grouped into sections. A section begins with the line:
.LP
.I [Section]
.LP
and continues until the next section. Entries in sections are specified in token\-value pairs, in the form:
.LP
.I entry=value
.LP
Neither
.I entry
nor
.I value
should be enclosed in double quotes.
.SH "SUPPORTED SECTIONS AND ENTRIES"
.LP
Additional rcd clients or Red Carpet Enterprise modules can add their own sections and entry/value pairs. The basic list of sections and entries is as follows. Note that the lines in the file do not always correspond exactly to the names of tokens set with the \fBrug set\fR command. For example, \fBrug set proxy\-url\fR is used to set the token "proxy" in the [Network] section. Use \fBrug get\fR to see the names of tokens you can set.
.TP
\fB[Cache]\fR
This section contains settings related to rcd download caches.
.IP
\fBenabled=[true | false]\fR
.br
Specifies whether rcd should cache downloaded data. This defaults to true.
\fBdirectory=[directory]\fR
Specifies the parent directory where rcd should store cached downloaded data. This defaults to /var/cache/rcd. This token can be set through rcd's preferences mechanism.
.TP
\fB[MagicProxy]\fR
This section holds the settings for the dispatcher ("middleman" or "magic proxy") tool used to work within complex and restrictive firewall situations. It has one token/value pair:
.IP
\fBmiddleman\-host=[host]\fR
.br
The host value should be the hostname of the system acting as the middleman. If you are configuring the middleman system itself, then this value should be the host name of the local system. This is a bare hostname, not a URL, and does not begin with a protocol.
.TP
\fB[ModuleServerPoll]\fR
This section is used only with Red Carpet Enterprise and the rcd\-modules package. It sets the interval at which the daemon checks the server\-side queue for recurring transactions or requested updates. It has a single token/value pair:
.IP
\fBinterval=[seconds]\fR
.br
The interval, in seconds, between updates of the transaction queue. Use the command \fBrug get server\-poll\-interval\fR to change this value, and \fBrug get server\-poll\-interval\fR to display it.
.TP
\fB[Network]\fR
This section contains settings for rcd's network options, including what server to connect to, what proxy to use, and how many concurrent downloads are permitted.
.IP
\fBhost=[url]\fR
.br
Deprecated in rcd 1.5 and later. This value is read in only once, for upgrade purposes, and only if the file /var/lib/rcd/services.xml does not exist. All servers are now stored in that file, and if it exists, changes to this value do nothing. Instead of changing this value, use the command \fBrug service\-add\fR or \fBrug service\-delete\fR.
\fBorg\-id=[organization id]\fR
.br
When using a Red Carpet Enterprise server, this value can be used to register the machine with the server, instead of using an activation key. This is unset and ignored by default.
\fBproxy=[url]\fR
.br
The URL for a proxy. This should always begin with the protocol https://, http://, socks4://, or socks5://, and end with a colon and port number. For example, if you're running squid on your local machine, you'll want to set this to http://localhost:3128. This is unset and ignored by default.
\fBproxy\-user=[username]\fR
.br
For proxies requiring authentication, this is the username used. This is unset and ignored by default; this token has no effect if \fBproxy\fR is not set.
\fBproxy\-password=[password]\fR
.br
For proxies requiring authentication, this is the password used. This is unset and ignored by default; this token has no effect if \fBproxy\fR is not set.
\fBhttp10=[true | false]\fR
.br
This option determines whether or not rcd uses HTTP 1.0 or 1.1 to connect to servers. This setting may be helpful with some uncooperative proxies. This defaults to false.
\fBmax\-downloads=[number]\fR
.br
This option specifies how many concurrent package downloads rcd may start. Users on slower connections will want to decrease this, whereas users with high bandwidth connections may want to increase this. If set to 0, there is no limit and rcd will make as many connections as needed. This defaults to 5.
.TP
\fB[Server]\fR
This section contains settings related to rcd's server.
.IP
\fBremote\-enabled=[true | false]\fR
.br
Specifies whether rcd should listen to remote (TCP) connections. This defaults to true.
\fBport=[number]\fR
.br
Specifies the port rcd should listen on for remote (TCP) connections. This defaults to 505.
\fBbind\-ip=[ip\-address]\fR
.br
Applicable only to systems which can be addressed by more than one IP address. If this value is not set, rcd will bind to all IP addresses served by the system. If you wish to have rcd available on only one IP (in addition to localhost, where it is always available), set this token to that address.
.TP
\fB[System]
This section contains settings related to rcd behavior.
.IP
\fBcache\-age\-in\-days=[number]\fR
.br
Specifies the number of days a package may be in the cache before it is removed. This defaults to 30. It has no effect if \fBcache\-cleanup\fR is not set.
\fBcache\-cleanup=[true | false]\fR
.br
Specifies whether the package cache should be cleaned up. If this is off and caching is enabled, packages will accumulate in the cache directory until it is cleared manually. This defaults to true.
\fBcache\-size\-in\-mb=[number]\fR
.br
Specifies the total size in megabytes that the package cache may be before it is cleaned up. This defaults to 300. It has no effect if \fBcache\-cleanup\fR is not set.
\fBdebug\-level=[number]\fR
.br
The level at which to log to standard error. This can range from 0 to 6, where 6 is extremely verbose. This setting defaults to 4.
\fBheartbeat=[number]\fR
.br
Specifies the interval at which rcd downloads new channel and package metadata. This defaults to 7200 (2 hours). If the heartbeat is set to 0, the daemon will not refresh unless told to do so with the "rug refresh" command. Note that this is not necessarily the same as the server\-poll\-interval value.
\fBrollback=[true | false]\fR
.br
Stores detailed package history information, enabling the "rug rollback" software reversion command (see rug(1) for more information). This option causes rcd to take additional time and disk space for upgrade and removal transactions, although not as much as storing archives of old packages themselves. Rollback only works on RPM\-based systems, and packages to which you downgrade must be available on the Red Carpet server.
\fBrequire\-signatures=[true | false]\fR
.br
Specifies whether packages being installed must pass a GPG signature check. Packages which are inconclusive for whatever reason (gpg not installed, public key unavailable, etc.) are not installed. Note that rcd will never install packages in which a gpg signature explicitly fails. This defaults to true.
\fBserver\-poll\-interval=[number]\fR
.br
Specifies the interval at which rcd checks the server for new transaction information. This is only relevant if you are using Red Carpet Enterprise and have the rcd\-modules package installed. The default value is 3600 (1 hour).
\fBsyslog\-level=[number]\fR
.br
The level at which to log to syslog. This can range from 0 to 6,
where 6 is extremely verbose. This defaults to 4.
.SH "AUTHORS"
.LP
Copyright Ximian, Inc. 2002\-2004
http://www.ximian.com
.SH "SEE ALSO"
.LP
rcd(8), rug(1), rcman(1), rcreports(1), rce\-dump, rce\-restore, rcmirror(1)
.LP
The graphical Red Carpet client, red\-carpet, has a manual accessible through the GNOME help system; select items from the Help menu within the application to read it. Visit http://ximian.com for more information about rcd and the full family of Ximian Red Carpet products and servies, as well as Evolution and other software from Ximian.
To report problems with this software or its documentation, visit http://bugzilla.ximian.com