chiark / gitweb /
Basic man page added
authormatthewv <matthewv>
Mon, 7 Jul 2003 03:36:49 +0000 (03:36 +0000)
committermatthewv <matthewv>
Mon, 7 Jul 2003 03:36:49 +0000 (03:36 +0000)
backup/man/labeltape.1 [new file with mode: 0644]
backup/man/loaded.1 [new file with mode: 0644]
backup/man/takedown.1 [new file with mode: 0644]
backup/man/whatsthis.1 [new file with mode: 0644]

diff --git a/backup/man/labeltape.1 b/backup/man/labeltape.1
new file mode 100644 (file)
index 0000000..a1906fb
--- /dev/null
@@ -0,0 +1,34 @@
+.TH BACKUP-LABELTAPE "1" "July 2003" "Debian" "Chiark-backup"
+.SH NAME
+backup-labeltape \- display or change tape label
+.SH SYNOPSIS
+.B backup-labeltape
+.I [-force] TAPEID
+.br
+.SH DESCRIPTION
+`backup-labeltape' will display the tape label; it will also label the
+tape with TAPEID unless the tape already has a label (the -force
+option will over-write the current label)
+`test' option
+.SH OPTIONS
+.TP
+.BR -force
+Over-write an existing tape label
+.TP
+.BR TAPEID
+The new label to write to the tape
+.SH FILES
+.TP
+.I /etc/chiark-backup/settings.pl
+Configuration file for the whole of chiark-backup
+.P
+.SH AUTHOR
+This Manual page was written by Matthew Vernon <matthew@debian.org> but 
+may be used by anyone.
+.SH COPYRIGHT
+Copyright \(c0 1997-1998,2000-2001 Ian Jackson <ian@chiark.greenend.org.uk>
+.br
+Copyright \(c0 1999 Peter Maydell <pmaydell@chiark.greenend.org.uk>
+.br
+This is free software; see the source for copying conditions.  There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/backup/man/loaded.1 b/backup/man/loaded.1
new file mode 100644 (file)
index 0000000..01ae9c0
--- /dev/null
@@ -0,0 +1,41 @@
+.TH BACKUP-LOADED "1" "July 2003" "Debian" "Chiark-backup"
+.SH NAME
+backup-loaded \- tell the chiark-backup system what to do with a new tape
+.SH SYNOPSIS
+.B backup-loaded
+.I [TAPEID]
+.br
+.SH DESCRIPTION
+backup-loaded: this tells the scripts that a currently unlabelled tape
+should be treated as tape X: eg:
+.br
+\fBbackup-loaded b3\fP
+.br
+will cause it to treat it as tape `b3'.  NB: this won't override the
+TAPEID label written on the tape; it's just for use with previously
+unused tapes.  This applies only to the next time the backup scripts
+are invoked.  You can say just
+.br
+\fBbackup-loaded\fP
+.br
+to go back to the default behaviour, which is to fail if the tape has
+no TAPEID.
+.SH OPTIONS
+.TP
+.BR TAPEID
+Treat the tape as label TAPEID
+.SH FILES
+.TP
+.I /etc/chiark-backup/settings.pl
+Configuration file for the whole of chiark-backup
+.P
+.SH AUTHOR
+This Manual page was written by Matthew Vernon <matthew@debian.org> but 
+may be used by anyone.
+.SH COPYRIGHT
+Copyright \(c0 1997-1998,2000-2001 Ian Jackson <ian@chiark.greenend.org.uk>
+.br
+Copyright \(c0 1999 Peter Maydell <pmaydell@chiark.greenend.org.uk>
+.br
+This is free software; see the source for copying conditions.  There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/backup/man/takedown.1 b/backup/man/takedown.1
new file mode 100644 (file)
index 0000000..41e589d
--- /dev/null
@@ -0,0 +1,35 @@
+.TH BACKUP-TAKEDOWN "1" "July 2003" "Debian" "Chiark-backup"
+.SH NAME
+backup-takedown \- Bring some system services down for backups
+.SH SYNOPSIS
+.B backup-takedown
+.I [freq]
+.br
+.SH DESCRIPTION
+`backup-takedown' is for running a reduced level of system
+services during backups. To use this command you need to configure
+init by setting up runlevel 5 to provide the level of services you
+want, and to run backup-driver automatically on entering runlevel 5.
+.SH OPTIONS
+.TP
+.BR freq
+`freq' may be `now', `soon' or nothing depending on the number of
+warning messages desired - these correspond to warnings.* files.
+.SH FILES
+.TP
+.I /etc/chiark-backup/warnings.*
+Files specifying what number and frequency of warnings will be produced.
+.TP
+.I /etc/chiark-backup/settings.pl
+Configuration file for the whole of chiark-backup
+.P
+.SH AUTHOR
+This Manual page was written by Matthew Vernon <matthew@debian.org> but 
+may be used by anyone.
+.SH COPYRIGHT
+Copyright \(c0 1997-1998,2000-2001 Ian Jackson <ian@chiark.greenend.org.uk>
+.br
+Copyright \(c0 1999 Peter Maydell <pmaydell@chiark.greenend.org.uk>
+.br
+This is free software; see the source for copying conditions.  There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/backup/man/whatsthis.1 b/backup/man/whatsthis.1
new file mode 100644 (file)
index 0000000..4ed971f
--- /dev/null
@@ -0,0 +1,37 @@
+.TH BACKUP-WHATSTHIS "1" "July 2003" "Debian" "Chiark-backup"
+.SH NAME
+backup-whatsthis \- read an id off a tape and display it
+.SH SYNOPSIS
+.B backup-whatsthis
+.RB [\| --list
+.RI [\| n \|]]
+.br
+.SH DESCRIPTION
+`backup-whatsthis' is a simple script to display the TAPEID of the current
+tape and optionally list its contents.  This script is a bit of a hack
+and may not be fully reliable.
+.SH OPTIONS
+.TP
+.B \--list
+.RI [\| n \|]
+Print TAPEID then list archive n (default 0). Note that archives are
+numbered from zero.
+.SH FILES
+.TP
+.I /etc/chiark-backup/settings.pl
+Configuration file for the whole of chiark-backup
+.P
+.SH BUGS
+`backup-whatsthis' is currently hardwired to assume `cpio' type backups
+when listing; it could be trivially hardwired to assume `zafio' 
+or with slightly more effort it could be done properly :->.
+.SH AUTHOR
+This Manual page was written by Matthew Vernon <matthew@debian.org> but 
+may be used by anyone.
+.SH COPYRIGHT
+Copyright \(c0 1997-1998,2000-2001 Ian Jackson <ian@chiark.greenend.org.uk>
+.br
+Copyright \(c0 1999 Peter Maydell <pmaydell@chiark.greenend.org.uk>
+.br
+This is free software; see the source for copying conditions.  There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.