From 586676add78962dad4389e2a831be3403488a777 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Wed, 29 Oct 2008 02:39:40 +0000 Subject: /home/texlive/karl/Master/tlpkg/bin/tl-update-auto git-svn-id: svn://tug.org/texlive/trunk@11105 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf/doc/man/man1/tlmgr.1 | 69 +++++++++++++++++++++++++++++++----- Master/texmf/doc/man/man1/tlmgr.pdf | Bin 21641 -> 24830 bytes 2 files changed, 61 insertions(+), 8 deletions(-) (limited to 'Master') diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1 index da93e60c2dc..f9ff4232371 100644 --- a/Master/texmf/doc/man/man1/tlmgr.1 +++ b/Master/texmf/doc/man/man1/tlmgr.1 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "TLMGR 1" -.TH TLMGR 1 "2008-10-23" "perl v5.8.8" "User Contributed Perl Documentation" +.TH TLMGR 1 "2008-10-29" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" tlmgr \- the TeX Live Manager .SH "SYNOPSIS" @@ -260,8 +260,22 @@ written to the terminal. This is a more detailed report than \f(CW\*(C`\-\-list Under normal circumstances tlmgr tries to remove packages which have disappeared on the server when called with \f(CW\*(C`\-\-all\*(C'\fR, as described above. This prevents any such removals. -.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 8 -.IX Item "--backupdir directory" +.IP "\fB\-\-backup\fR and \fB\-\-backupdir\fR \fIdirectory\fR" 8 +.IX Item "--backup and --backupdir directory" +These options control the creation of backups of packages before +an update is started. If none of the two are given, no backup package +will be saved. If \fB\-\-backupdir\fR is given specifying a (writable) +directory then a back up will be made in that location. If only +\&\fB\-\-backup\fR is given then the location for the backups has to be +set in the tlpdb via the \fBoption\fR action (see below). If both are +given then a backup will be made to the specified directory. +.Sp +By setting relevent options in the tlpdb via the \fBoption\fR action +it is possible to automatically create backups for all packages, and +keep only a certain number of backups. Please see the \fBoption\fR +action for details. So if \fB\-\-backup\fR is not given, but the \fBautobackup\fR +option is set in the tlpdb, a backup will be made. +.Sp \&\fIdirectory\fR specifies a directory where the package as installed will be saved before updates are performed. Then you can restore later if the update turns out to be problematic; see the \f(CW\*(C`restore\*(C'\fR action for @@ -285,10 +299,22 @@ If the package on the server is older than the package already installed (e.g., if the selected mirror is out of date), \f(CW\*(C`tlmgr\*(C'\fR does not downgrade. Also, packages for uninstalled platforms are not installed. .RE -.IP "\fBbackup\fR \-\-backupdir \fIdir\fR [\fB\-\-all\fR] [\fIpkg\fR...]" 4 -.IX Item "backup --backupdir dir [--all] [pkg...]" -Makes a backup of the given packages, or all packages with \f(CW\*(C`\-\-all\*(C'\fR, to -\&\fIdir\fR, which must exist and be writable. Options: +.IP "\fBbackup\fR [\-\-clean[=\fIN\fR]] [\-\-backupdir \fIdir\fR] [\fB\-\-all\fR] [\fIpkg\fR...]" 4 +.IX Item "backup [--clean[=N]] [--backupdir dir] [--all] [pkg...]" +The first mode without the \fB\-\-clean\fR switch is to make a backup of +the given packages, or all packages with \f(CW\*(C`\-\-all\*(C'\fR. These backups are +saved to the following place: If the \fB\-\-backupdir\fR option if given, to +the directory \fIdir\fR, which must exist and be writable. +If the \fB\-\-backupdir\fR option is not given, the option setting in the +tlpdb is used, if present. If both are missing, no backups are made. +.Sp +The second mode is when the \fB\-\-clean\fR switch is given, either with +or without argument. If the value for the \fB\-\-clean\fR switch is missing, the +option \fBautobackup\fR from the tlpdb is used. If both are missing \fBtlmgr\fR +will terminate. For the meaning of the different values of that switch +see below the \fBoption\fR action. +.Sp +Options: .RS 4 .IP "\fB\-\-backupdir\fR \fIdirectory\fR" 8 .IX Item "--backupdir directory" @@ -298,6 +324,14 @@ directory where backups are to be placed. .IX Item "--all" Make a backup of all packages in the TeX Live installation. This will take quite a lot of space and time. +.IP "\fB\-\-clean\fR" 8 +.IX Item "--clean" +Instead of making backups cleans up the backup directory from old +backups. +.IP "\fB\-\-dry\-run\fR" 8 +.IX Item "--dry-run" +Nothing is actually backed up or removed; instead, the actions to be +performed are written to the terminal. .RE .RS 4 .RE @@ -372,7 +406,9 @@ Possible values for \fIkey\fR are: \&\f(CW\*(C`location\*(C'\fR (default installation location), \&\f(CW\*(C`formats\*(C'\fR (create formats at installation time), \&\f(CW\*(C`docfiles\*(C'\fR (install documentation files), -\&\f(CW\*(C`srcfiles\*(C'\fR (install source files). +\&\f(CW\*(C`srcfiles\*(C'\fR (install source files), +\&\f(CW\*(C`autobackup\*(C'\fR (specify the number of backups to be kept), +\&\f(CW\*(C`backupdir\*(C'\fR (specify the default location for backups). .Sp Perhaps the most common use for this is if you originally installed from \&\s-1DVD\s0, and want to permanently change the installation to get further @@ -383,6 +419,23 @@ updates from the Internet. To do this, you can run .Ve .Sp where \s-1YYYY\s0 is the TeX Live release year. +.Sp +The two options \f(CW\*(C`autobackup\*(C'\fR and \f(CW\*(C`backupdir\*(C'\fR can be used to specify +defaults for the \fBupdate\fR, \fBbackup\fR and \fBrestore\fR actions. These +three actions normally need a directory to write to or read from the +backups. If nothing is specified on the command line, the default taken +from the \f(CW\*(C`backupdir\*(C'\fR is taken. +.Sp +The \f(CW\*(C`autobackup\*(C'\fR option (de)activates the automatical generation of +backups. This option can be an integer larger or equal then \-1. If +\&\f(CW\*(C`autobackup\*(C'\fR is \-1, backups will not be removed (if you not ask for +explicitely with \fBtlmgr backup \-\-clean=\f(BIN\fB ...\fR specifying for \fIN\fR +something different then \-1. If it any other integer, i.e., larger or +equal than 0, it specifies the number of backups to be kept. That also +includes that backups are disabled with 0 as argument. +.Sp +In the \fB\-\-clean\fR mode of the \fBbackup\fR action this option also specifies +the number to be kept. .IP "\fBpaper a4\fR" 4 .IX Item "paper a4" .PD 0 diff --git a/Master/texmf/doc/man/man1/tlmgr.pdf b/Master/texmf/doc/man/man1/tlmgr.pdf index 6bf541fc244..694c89d898a 100644 Binary files a/Master/texmf/doc/man/man1/tlmgr.pdf and b/Master/texmf/doc/man/man1/tlmgr.pdf differ -- cgit v1.2.3