Manual page corrections
Micah Anderson
18 years ago
| 44 | 44 | monitor:</Para> |
| 45 | 45 | <ItemizedList> |
| 46 | 46 | <ListItem> |
| 47 | <Para>one ore more user maintained changelog files, | |
| 47 | <Para>one or more user maintained changelog files, | |
| 48 | 48 | </ListItem> |
| 49 | 49 | <ListItem> |
| 50 | <Para>Debian packages states and versions.</Para> | |
| 50 | <Para>the state of Debian packages and versions.</Para> | |
| 51 | 51 | </ListItem> |
| 52 | 52 | </ItemizedList> |
| 53 | 53 | |
| 54 | <Para>metche should be installed with a cronjob regularly running to | |
| 54 | <Para>metche should be installed with a cronjob that regularly runs to | |
| 55 | 55 | automatically save the system state as needed. These states are saved in a |
| 56 | way looking like the Debian development model:</Para> | |
| 56 | way similar to the Debian development model:</Para> | |
| 57 | 57 | <ItemizedList> |
| 58 | 58 | <ListItem> |
| 59 | 59 | <Para><emphasis>unstable</emphasis> states are saved as soon as |
| 98 | 98 | <VarListEntry><Term><command>report</command></Term> |
| 99 | 99 | <ListItem> |
| 100 | 100 | <Para>When run with the <command>report</command> command, metche |
| 101 | displays a report against a given saved state, if specified, or | |
| 102 | against the latest testing state, otherwise. This is useful when you | |
| 101 | displays a report against the specified saved state, or if unspecified, | |
| 102 | against the latest testing state. This is useful when you | |
| 103 | 103 | have broken your system and want to know which changes have been made |
| 104 | 104 | since a given, known working, system state. |
| 105 | 105 | </ListItem> |
| 107 | 107 | <VarListEntry><Term><command>list</command></Term> |
| 108 | 108 | <ListItem> |
| 109 | 109 | <Para>When run with the <command>list</command> command, metche |
| 110 | displays the full saved states list.</Para> | |
| 110 | displays a list of all the saved states.</Para> | |
| 111 | 111 | </ListItem> |
| 112 | 112 | |
| 113 | 113 | <VarListEntry><Term><command>stabilize</command></Term> |
| 135 | 135 | </Para> |
| 136 | 136 | |
| 137 | 137 | <Para>When configured to monitor one changelog, |
| 138 | <filename><envar>CHANGELOG_FLE</envar></filename> (default | |
| 138 | <filename><envar>CHANGELOG_FILE</envar></filename> (default | |
| 139 | 139 | <filename>/root/Changelog</filename>). |
| 140 | 140 | </Para> |
| 141 | 141 | |
| 145 | 145 | |
| 146 | 146 | <Para>System states are saved in |
| 147 | 147 | <filename><envar>BACKUP_DIR</envar></filename> (default |
| 148 | <filename>/var/lib/metche</filename>.</Para> | |
| 148 | <filename>/var/lib/metche)</filename>.</Para> | |
| 149 | 149 | </refsect1> |
| 150 | 150 | |
| 151 | 151 | <refsect1 id="security"><title>SECURITY</title> |
| 152 | 152 | <Para>metche is able to use GnuPG to encrypt the email it sends, but does |
| 153 | not by default ; just enable the <envar>ENCRYPT_EMAIL</envar> configuration | |
| 153 | not by default; just enable the <envar>ENCRYPT_EMAIL</envar> configuration | |
| 154 | 154 | option, and make sure <envar>EMAIL_ADDRESS</envar>' public key is in root's |
| 155 | 155 | keyring, trusted enough to be used blindly by metche.</Para> |
| 156 | 156 | |
| 170 | 170 | |
| 171 | 171 | <refsect1 id="bugs"><title>BUGS</title> |
| 172 | 172 | <Para>See <ulink url="https://poivron.org/dev/metche/">metche's ticket |
| 173 | system</ulink> to see the bugs, missing features, and development | |
| 173 | system</ulink> for known bugs, missing features, and the development | |
| 174 | 174 | road-map.</Para> |
| 175 | 175 | </refsect1> |
| 176 | 176 | |