docs/manpages/smbtar.1

   1 .\" This manpage has been automatically generated by docbook2man-spec
   2 .\" from a DocBook document.  docbook2man-spec can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "SMBTAR" "1" "06 December 2001" "" ""
   7 .SH NAME
   8 smbtar \- shell script for backing up SMB/CIFS shares  directly to UNIX tape drives
   9 .SH SYNOPSIS
  10 .sp
  11 \fBsmbtar\fR \fB-s server\fR [ \fB-p password\fR ]  [ \fB-x services\fR ]  [ \fB-X\fR ]  [ \fB-d directory\fR ]  [ \fB-u user\fR ]  [ \fB-t tape\fR ]  [ \fB-t tape\fR ]  [ \fB-b blocksize\fR ]  [ \fB-N filename\fR ]  [ \fB-i\fR ]  [ \fB-r\fR ]  [ \fB-l loglevel\fR ]  [ \fB-v\fR ]  \fBfilenames\fR
  12 .SH "DESCRIPTION"
  13 .PP
  14 This tool is part of the  Sambasuite.
  15 .PP
  16 \fBsmbtar\fR is a very small shell script on top
  17 of \fBsmbclient(1)\fR
  18 which dumps SMB shares directly to tape.
  19 .SH "OPTIONS"
  20 .TP
  21 \fB-s server\fR
  22 The SMB/CIFS server that the share resides
  23 upon.
  24 .TP
  25 \fB-x service\fR
  26 The share name on the server to connect to.
  27 The default is "backup".
  28 .TP
  29 \fB-X\fR
  30 Exclude mode. Exclude filenames... from tar
  31 create or restore.
  32 .TP
  33 \fB-d directory\fR
  34 Change to initial \fIdirectory
  35 \fRbefore restoring / backing up files.
  36 .TP
  37 \fB-v\fR
  38 Verbose mode.
  39 .TP
  40 \fB-p password\fR
  41 The password to use to access a share.
  42 Default: none
  43 .TP
  44 \fB-u user\fR
  45 The user id to connect as. Default:
  46 UNIX login name.
  47 .TP
  48 \fB-t tape\fR
  49 Tape device. May be regular file or tape
  50 device. Default: \fI$TAPE\fR environmental
  51 variable; if not set, a file called \fItar.out
  52 \fR\&.
  53 .TP
  54 \fB-b blocksize\fR
  55 Blocking factor. Defaults to 20. See
  56 \fBtar(1)\fR for a fuller explanation.
  57 .TP
  58 \fB-N filename\fR
  59 Backup only files newer than filename. Could
  60 be used (for example) on a log file to implement incremental
  61 backups.
  62 .TP
  63 \fB-i\fR
  64 Incremental mode; tar files are only backed
  65 up if they have the archive bit set. The archive bit is reset
  66 after each file is read.
  67 .TP
  68 \fB-r\fR
  69 Restore. Files are restored to the share
  70 from the tar file.
  71 .TP
  72 \fB-l log level\fR
  73 Log (debug) level. Corresponds to the
  74 \fI-d\fR flag of \fBsmbclient(1)
  75 \fR\&.
  76 .SH "ENVIRONMENT VARIABLES"
  77 .PP
  78 The \fI$TAPE\fR variable specifies the
  79 default tape device to write to. May be overridden
  80 with the -t option.
  81 .SH "BUGS"
  82 .PP
  83 The \fBsmbtar\fR script has different
  84 options from ordinary tar and tar called from smbclient.
  85 .SH "CAVEATS"
  86 .PP
  87 Sites that are more careful about security may not like
  88 the way the script handles PC passwords. Backup and restore work
  89 on entire shares, should work on file lists. smbtar works best
  90 with GNU tar and may not work well with other versions.
  91 .SH "DIAGNOSTICS"
  92 .PP
  93 See the \fBDIAGNOSTICS\fR section for the
  94 \fBsmbclient(1)\fR
  95 command.
  96 .SH "VERSION"
  97 .PP
  98 This man page is correct for version 2.2 of
  99 the Samba suite.
 100 .SH "SEE ALSO"
 101 .PP
 102 \fBsmbd(8)\fR,
 103 \fBsmbclient(1)\fR,
 104 smb.conf(5),
 105 .SH "AUTHOR"
 106 .PP
 107 The original Samba software and related utilities
 108 were created by Andrew Tridgell. Samba is now developed
 109 by the Samba Team as an Open Source project similar
 110 to the way the Linux kernel is developed.
 111 .PP
 112 Ricky Poulten <URL:mailto:poultenr@logica.co.uk>
 113 wrote the tar extension and this man page. The \fBsmbtar\fR
 114 script was heavily rewritten and improved by Martin Kraemer <URL:mailto:Martin.Kraemer@mch.sni.de>. Many
 115 thanks to everyone who suggested extensions, improvements, bug
 116 fixes, etc. The man page sources were converted to YODL format (another
 117 excellent piece of Open Source software, available at
 118 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
 119 release by Jeremy Allison. The conversion to DocBook for
 120 Samba 2.2 was done by Gerald Carter.