729295b8cf8ae825d58032d9ceaa387c3b73033e
[update-motd.git] / update-motd.1
1 .IX Title "UPDATE-MOTD 1"
2 .TH UPDATE-MOTD 1 "2008-09-17" update-motd update-motd
3
4 .SH "NAME"
5 update\-motd \- Automatically update the message-of-the-day (MOTD)
6
7 .SH "SYNOPSIS"
8 .IX Header "SYNOPSIS"
9 update\-motd [\-\-disable|\-\-enable|\-\-force]
10
11 .SH "OPTIONS"
12 .IX Header "OPTIONS"
13 .TP
14 \fB\-\-disable\fP
15 Prevent update-motd from running. This is useful for temporarily disabling automatic updates of \fI/etc/motd\fP by the \fI/etc/cron.d/update-motd\fP cronjob.  Note that this regenerates a base MOTD without the update-motd additions, and then exits.
16 .TP
17 \fB\-\-enable\fP
18 Allow update-motd to run.  This is useful for enabling automatic updates of \fI/etc/motd\fP through the \fI/etc/cron.d/update-motd\fP cronjob.  Note that this updates the MOTD immediately.
19 .TP
20 \fB\-\-force\fP
21 Override a disabled update-motd for a single, immediate update of \fI/etc/motd\fP.
22
23
24 .SH "DESCRIPTION"
25 .IX Header "DESCRIPTION"
26 This script executes each script in \fI/etc/update-motd.d/\fP in lexical order, concatenating the status with \fI/etc/motd.tail\fP, and writing the output to \fI/var/lib/motd\fP, which is usually a symbolic link to \fI/etc/motd\fP.
27
28 Users and/or packages should add symlinks to \fI/etc/update-motd.d/\fP, prepended with a two-digit number to define the execution order, as obeyed by \fBrun-parts(8)\fP.
29
30 The update-motd script will not execute if the file \fI/var/lib/update-motd/disabled\fP exists.  One can override this using the \fB--force\fP option.  To permanently enable/disable \fBupdate-motd\fP, use:
31     $ sudo update-motd --enable
32     $ sudo update-motd --disable
33
34 If enabled, timestamp of the last \fBupdate-motd\fP run will be written to \fI/var/run/update-motd.lastrun\fP.
35
36 .SH FILES
37 \fI/etc/cron.d/update-motd\fP, \fI/etc/update-motd.d/\fP, \fI/etc/motd.tail\fP, \fI/var/run/motd\fP, \fI/var/lib/update-motd/disabled\fP, \fI/var/run/update-motd.lastrun\fP
38
39 .SH "AUTHOR"
40 .IX Header "AUTHOR"
41 Dustin Kirkland <kirkland@canonical.com>
42
43 .SH "LICENSE"
44 .IX Header "LICENSE"
45 This manpage and the \fBupdate-motd\fP utility  was  written  by Dustin Kirkland <kirkland@canonical.com> for Ubuntu systems (but may be used by others).  Permission is granted to copy, distribute and/or modify  this  document  under the terms of the GNU General Public License, Version 3 or any later version published by the Free  Software  Foundation.
46
47 On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL-3.