git.maemo.org Git - samba/blob - 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 .ad l
  25 .hy 0
  26 .HP 7
  27 \fBsmbtar\fR [\-r] [\-i] [\-a] [\-v] {\-s\ server} [\-p\ password] [\-x\ services] [\-X] [\-N\ filename] [\-b\ blocksize] [\-d\ directory] [\-l\ loglevel] [\-u\ user] [\-t\ tape] {filenames}
  28 .ad
  29 .hy
  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 .TP
  46 \-x service
  47 The share name on the server to connect to\&. The default is "backup"\&.
  48
  49 .TP
  50 \-X
  51 Exclude mode\&. Exclude filenames\&.\&.\&. from tar create or restore\&.
  52
  53 .TP
  54 \-d directory
  55 Change to initial \fIdirectory \fR before restoring / backing up files\&.
  56
  57 .TP
  58 \-v
  59 Verbose mode\&.
  60
  61 .TP
  62 \-p password
  63 The password to use to access a share\&. Default: none
  64
  65 .TP
  66 \-u user
  67 The user id to connect as\&. Default: UNIX login name\&.
  68
  69 .TP
  70 \-a
  71 Reset DOS archive bit mode to indicate file has been archived\&.
  72
  73 .TP
  74 \-t tape
  75 Tape device\&. May be regular file or tape device\&. Default: \fI$TAPE\fR environmental variable; if not set, a file called \fItar\&.out \fR\&.
  76
  77 .TP
  78 \-b blocksize
  79 Blocking factor\&. Defaults to 20\&. See\fBtar(1)\fR for a fuller explanation\&.
  80
  81 .TP
  82 \-N filename
  83 Backup only files newer than filename\&. Could be used (for example) on a log file to implement incremental backups\&.
  84
  85 .TP
  86 \-i
  87 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\&.
  88
  89 .TP
  90 \-r
  91 Restore\&. Files are restored to the share from the tar file\&.
  92
  93 .TP
  94 \-l log level
  95 Log (debug) level\&. Corresponds to the\fI\-d\fR flag of \fBsmbclient\fR(1)\&.
  96
  97 .SH "ENVIRONMENT VARIABLES"
  98
  99 .PP
 100 The \fI$TAPE\fR variable specifies the default tape device to write to\&. May be overridden with the \-t option\&.
 101
 102 .SH "BUGS"
 103
 104 .PP
 105 The \fBsmbtar\fR script has different options from ordinary tar and from smbclient's tar command\&.
 106
 107 .SH "CAVEATS"
 108
 109 .PP
 110 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\&.
 111
 112 .SH "DIAGNOSTICS"
 113
 114 .PP
 115 See the \fBDIAGNOSTICS\fR section for the \fBsmbclient\fR(1) command\&.
 116
 117 .SH "VERSION"
 118
 119 .PP
 120 This man page is correct for version 3\&.0 of the Samba suite\&.
 121
 122 .SH "SEE ALSO"
 123
 124 .PP
 125 \fBsmbd\fR(8), \fBsmbclient\fR(1), \fBsmb\&.conf\fR(5)\&.
 126
 127 .SH "AUTHOR"
 128
 129 .PP
 130 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\&.
 131
 132 .PP
 133 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\&.
 134