Codebase list metche / d966049
trunk: update manpage and usage to reflect the new VServers support. A few minor improvements, too. intrigeri 18 years ago
3 changed file(s) with 29 addition(s) and 31 deletion(s). Raw diff Collapse all Expand all
+1
-1
README less more
2222 | OVERVIEW
2323 `-------------------------------------------------------------------------------
2424
25 metche is a tool meant to facilitate collective system administration. It does
25 metche is a tool meant to ease collective system administration. It does
2626 periodically :
2727 - save the "system state" of
2828 . $WATCHED_DIR (default: /etc)
+6
-6
metche less more
2626 ###
2727
2828 display_usage() {
29 ( echo "Usage: `basename $0` [-h VSERVER] list"
29 ( echo "Usage:"
30 echo " `basename $0` [-h VSERVER] list"
3031 echo " `basename $0` [-h VSERVER] report" \
3132 "[{stable|testing|unstable}-YYYYMMDDHHMM]"
3233 echo " `basename $0` [-h VSERVER] stabilize [testing-YYYYMMDDHHMM]"
33 echo " If -h is specified, `basename $0` only operates on the VSERVER VServer;"
34 echo " else, `basename $0` only operates on the current system."
3534 echo ""
36 echo "Non-interactive usage: `basename $0` cron"
37 echo " '`basename $0` cron' always operates on the current system and on the VServers"
38 echo " optionally listed in the VSNAMES configuration variable."
35 echo " With -h, the VServer VSERVER is operated on instead of the host system."
36 echo ""
37 echo "Non-interactive usage:"
38 echo " `basename $0` cron"
3939 echo ""
4040 ) >&2
4141 }
+22
-24
metche-manpage.sgml less more
1515 <refsynopsisdiv>
1616 <cmdsynopsis>
1717 <command>metche</command>
18 <arg>-h <replaceable>host</replaceable></arg>
18 <arg>-h <replaceable>vserver</replaceable></arg>
1919 <group choice="req">
20 <arg>cron</arg>
21 <arg>report
20 <arg>report
2221 <arg choice="opt">
2322 <group choice="req">
24 <arg>stable</arg>
25 <arg>testing</arg>
26 <arg>unstable</arg>
27 </group>-<replaceable>YYYYMMDDHHMM</replaceable>
23 <arg>stable</arg>
24 <arg>testing</arg>
25 <arg>unstable</arg>
26 </group>-<replaceable>YYYYMMDDHHMM</replaceable>
2827 </arg>
2928 </arg>
30 <arg>list</arg>
31 <arg>stabilize <arg choice="opt">testing-<replaceable>YYYYMMDDHHMM</replaceable></arg></arg>
29 <arg>list</arg>
30 <arg>stabilize <arg choice="opt">testing-<replaceable>YYYYMMDDHHMM</replaceable></arg></arg>
3231 </group>
3332 </cmdsynopsis>
3433 </refsynopsisdiv>
3736
3837 <title>DESCRIPTION</title>
3938
40 <Para>metche is a tool meant to facilitate collective sysadmin by
39 <Para>metche is a tool meant to ease collective system administration by
4140 monitoring changes in the system configuration.</Para>
4241
4342 <Para>metche basic usage is to monitor changes in a directory, usually
9190
9291 <title>OPTIONS</title>
9392
94 <Para>If <command>-h</command> <emphasis>HOST</emphasis> is specified,
95 <filename>/etc/metche/HOST.conf</filename> is used instead of
96 <filename>/etc/metche.conf</filename>. This, along with the
97 <envar>VSERVER_EXEC_PREFIX</envar> option, allows to monitor several
98 vservers running on a system.</Para>
93 <Para>If <command>-h</command> <emphasis>VSERVER</emphasis> is specified,
94 the VServer <emphasis>VSERVER</emphasis> is operated on instead of
95 the host system. This, along with the <envar>VSNAMES</envar> option,
96 allows to monitor several VServers running on the system.</Para>
9997
10098 <Para>One of the following commands must be specified on the
10199 command line:</Para>
130128 <Para>This command should not be called manually, but used from
131129 a cronjob. When called, it can perform various operations like:
132130 saving "unstable", "testing" or "stable" states as needed and
133 sending reports and notification if configured to do so.</Para>
131 sending reports and notification if configured to do so. This command
132 does not support the <command>-h</command> option.</Para>
134133 </ListItem>
135134
136135 </VariableList>
138137 </refsect1>
139138
140139 <refsect1 id="files"><title>FILES</title>
141 <Para><filename>/etc/metche.conf</filename> or
142 <filename>/etc/metche/*.conf</filename> contain metche configuration.
140 <Para><filename>/etc/metche.conf</filename> contains metche configuration.
143141 </Para>
144142
145143 <Para>When configured to monitor one changelog,
146 <filename><envar>CHANGELOG_FILE</envar></filename> (default
144 <filename><envar>CHANGELOG_FILE</envar></filename> (default:
147145 <filename>/root/Changelog</filename>).
148146 </Para>
149147
150148 <Para>When configured to monitor multiple changelogs,
151149 <filename><envar>CHANGELOG_DIR</envar>/*/Changelog</filename>
152 (default : <filename>/root/changelogs</filename>).</Para>
150 (default: <filename>/root/changelogs</filename>).</Para>
153151
154152 <Para>System states are saved in
155 <filename><envar>BACKUP_DIR</envar></filename> (default
153 <filename><envar>BACKUP_DIR</envar></filename> (default:
156154 <filename>/var/lib/metche)</filename>.</Para>
157155 </refsect1>
158156
165163 <Para>In its default setup (<envar>ENCRYPT_EMAIL</envar> configuration
166164 option disabled) metche sends in <emphasis>clear text email</emphasis> the
167165 changes made to the watched directory... either make sure that the
168 <envar>TAR_OPTS</envar> configuration variable prevents it to send sensitive
166 <envar>EXCLUDES</envar> configuration variable prevents it to send sensitive
169167 information, or triple check that secure connections will be used end-to-end
170168 on the email path. If unsure, set <envar>EMAIL_ADDRESS</envar> configuration
171169 variable to a local mailbox.</Para>
183181 </refsect1>
184182
185183 <refsect1 id="author"><title>AUTHOR</title>
186 <Para>This manual page was written by the boum collective
187 <email>boum@anargeek.net</email>.</Para>
184 <Para>metche and this manual page were written by the boum collective
185 <email>metche@lists.riseup.net</email>.</Para>
188186 </refsect1>
189187
190188 </RefEntry>