git.gag.com Git - debian/amanda/blob - man/amtoc.8

   1 .\"     Title: amtoc
   2 .\"    Author: Nicolas Mayencourt <Nicolas.Mayencourt@cui.unige.ch>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMTOC" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amtoc \- generate TOC (Table Of Contents) for an \fIAmanda\fR run
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamtoc\fR\ 'u
 174 \fBamtoc\fR [\-a] [\-i] [\-t] [\-f\ \fIfile\fR] [\-s\ \fIsubs\fR] [\-w] [\-\-] \fIlogfile\fR
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 \fIAmtoc\fR
 179 generates a table of contents for an
 180 \fIAmanda\fR
 181 run\&. It\'s a perl script (if you don\'t have perl, install it first!)\&.
 182 .SH "OPTIONS"
 183 .PP
 184 \fB\-a\fR
 185 .RS 4
 186 The output file name will be
 187 \fIlabel\-of\-the\-tape\fR\&.toc in the same directory as
 188 \fIlogfile\fR\&.
 189 .RE
 190 .PP
 191 \fB\-i\fR
 192 .RS 4
 193 Display help about
 194 \fBamtoc\fR\&.
 195 .RE
 196 .PP
 197 \fB\-t\fR
 198 .RS 4
 199 Generate the output in tabular form\&.
 200 .RE
 201 .PP
 202 \fB\-f file\fR
 203 .RS 4
 204 Write the output to a file (\'\-\' for stdout)\&.
 205 .RE
 206 .PP
 207 \fB\-s subs\fR
 208 .RS 4
 209 Evaluate the output file name from
 210 \fIsubs\fR, with $_ set to
 211 \fIlabel\-of\-the\-tape\fR\&. The
 212 \fB\-a\fR
 213 option is equivalent to
 214 \fB\-s\fR
 215 \fI\'s/$_/\&.toc/\'\fR\&.
 216 .RE
 217 .PP
 218 \fB\-w\fR
 219 .RS 4
 220 Separate tapes with form\-feeds and display blank lines before totals\&.
 221 .RE
 222 .PP
 223 \fB\-\-\fR
 224 .RS 4
 225 Marks the last option so the next parameter is the
 226 \fIlogfile\fR\&.
 227 .RE
 228 .PP
 229 \fBlogfile\fR
 230 .RS 4
 231 (use \'\-\' for stdin)
 232 .RE
 233 .SH "OUTPUT FORMAT"
 234 .PP
 235 The standard output has five fields separated by two spaces:
 236 .nf
 237 #  Server:/partition  date  level  size[Kb]
 238 0  daily\-05:  19991005  \-  \-
 239 1  cuisun15:/cuisun15/home  19991005  1  96
 240 2  cuinfs:/export/dentiste  19991005  1  96
 241   \&.\&.\&.
 242 103  cuisg11:/  19991005  0  4139136
 243 103  total:  \-  \-  16716288
 244 .fi
 245 .PP
 246 In tabular format (\-t), this would look like:
 247 .nf
 248   #  Server:/partition           date      lev  size[Kb]
 249   0  daily\-05:                   19991005    \-         \-
 250   1  cuisun15:/cuisun15/home     19991005    1        96
 251   2  cuinfs:/export/dentiste     19991005    1        96
 252   \&.\&.\&.
 253 103  cuisg11:/                   19991005    0   4139136
 254 103  total:                      \-           \-  16716288
 255 .fi
 256 .SH "USAGE"
 257 .PP
 258 The easiest way to use it is to run
 259 \fBamtoc\fR
 260 right after
 261 \fIamdump\fR
 262 in the
 263 \fIcron job:\fR
 264 .nf
 265 amdump daily ; logdir=`amgetconf daily logdir` ; log=`ls \-1t $logdir/log\&.*\&.[0\-9] | head \-1` ; amtoc \-a $log
 266 .fi
 267 .PP
 268 which will generate /usr/local/etc/amanda//daily/\fItape_label\fR\&.toc\&. You may also want to call
 269 \fBamtoc\fR
 270 after an
 271 \fIamflush\fR\&.
 272 .SH "SEE ALSO"
 273 .PP
 274 \fBamanda\fR(8),
 275 \fBamdump\fR(8),
 276 \fBamflush\fR(8),
 277 \fBamgetconf\fR(8), cron, perl,
 278 : http://wiki.zmanda.com
 279 .SH "Authors"
 280 .PP
 281 \fBNicolas Mayencourt\fR <\&Nicolas\&.Mayencourt@cui\&.unige\&.ch\&>
 282 .RS 4
 283 University of Geneva/Switzerland
 284 .RE
 285 .PP
 286 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>