docs/manpages/smbtar.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "SMBTAR" 1 "" "" ""
  21 .SH NAME
  22 smbtar \- shell script for backing up SMB/CIFS shares directly to UNIX tape drives
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fBsmbtar\fR [-r] [-i] [-a] [-v] {-s server} [-p password] [-x services] [-X] [-N filename]
  27        [-b blocksize] [-d directory] [-l loglevel] [-u user] [-t tape] {filenames}
  28
  29 .fi
  30
  31 .SH "DESCRIPTION"
  32
  33 .PP
  34 This tool is part of the \fBSamba\fR(7) suite\&.
  35
  36 .PP
  37 \fBsmbtar\fR is a very small shell script on top of \fBsmbclient\fR(1) which dumps SMB shares directly to tape\&.
  38
  39 .SH "OPTIONS"
  40
  41 .TP
  42 -s server
  43 The SMB/CIFS server that the share resides upon\&.
  44
  45
  46 .TP
  47 -x service
  48 The share name on the server to connect to\&. The default is "backup"\&.
  49
  50
  51 .TP
  52 -X
  53 Exclude mode\&. Exclude filenames\&.\&.\&. from tar create or restore\&.
  54
  55
  56 .TP
  57 -d directory
  58 Change to initial \fIdirectory \fR before restoring / backing up files\&.
  59
  60
  61 .TP
  62 -v
  63 Verbose mode\&.
  64
  65
  66 .TP
  67 -p password
  68 The password to use to access a share\&. Default: none
  69
  70
  71 .TP
  72 -u user
  73 The user id to connect as\&. Default: UNIX login name\&.
  74
  75
  76 .TP
  77 -a
  78 Reset DOS archive bit mode to indicate file has been archived\&.
  79
  80
  81 .TP
  82 -t tape
  83 Tape device\&. May be regular file or tape device\&. Default: \fI$TAPE\fR environmental variable; if not set, a file called \fItar\&.out \fR\&.
  84
  85
  86 .TP
  87 -b blocksize
  88 Blocking factor\&. Defaults to 20\&. See \fBtar(1)\fR for a fuller explanation\&.
  89
  90
  91 .TP
  92 -N filename
  93 Backup only files newer than filename\&. Could be used (for example) on a log file to implement incremental backups\&.
  94
  95
  96 .TP
  97 -i
  98 Incremental mode; tar files are only backed up if they have the archive bit set\&. The archive bit is reset after each file is read\&.
  99
 100
 101 .TP
 102 -r
 103 Restore\&. Files are restored to the share from the tar file\&.
 104
 105
 106 .TP
 107 -l log level
 108 Log (debug) level\&. Corresponds to the \fI-d\fR flag of \fBsmbclient\fR(1)\&.
 109
 110
 111 .SH "ENVIRONMENT VARIABLES"
 112
 113 .PP
 114 The \fI$TAPE\fR variable specifies the default tape device to write to\&. May be overridden with the -t option\&.
 115
 116 .SH "BUGS"
 117
 118 .PP
 119 The \fBsmbtar\fR script has different options from ordinary tar and from smbclient's tar command\&.
 120
 121 .SH "CAVEATS"
 122
 123 .PP
 124 Sites that are more careful about security may not like the way the script handles PC passwords\&. Backup and restore work on entire shares; should work on file lists\&. smbtar works best with GNU tar and may not work well with other versions\&.
 125
 126 .SH "DIAGNOSTICS"
 127
 128 .PP
 129 See the \fBDIAGNOSTICS\fR section for the \fBsmbclient\fR(1) command\&.
 130
 131 .SH "VERSION"
 132
 133 .PP
 134 This man page is correct for version 3\&.0 of the Samba suite\&.
 135
 136 .SH "SEE ALSO"
 137
 138 .PP
 139 \fBsmbd\fR(8), \fBsmbclient\fR(1), \fBsmb.conf\fR(5)\&.
 140
 141 .SH "AUTHOR"
 142
 143 .PP
 144 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
 145
 146 .PP
 147 Ricky Poulten wrote the tar extension and this man page\&. The \fBsmbtar\fR script was heavily rewritten and improved by Martin Kraemer\&. Many thanks to everyone who suggested extensions, improvements, bug fixes, etc\&. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
 148