usmb.1

   1 .\" Copyright (C) 2010 Geoff Johnstone.
   2 .\" See section COPYING for conditions for redistribution.
   3 .TH usmb 1 "April 2010" "usmb" "User Commands"
   4 .fp 0 CR
   5 .SH NAME
   6 usmb \- Mount SMB/CIFS shares via FUSE
   7 .SH SYNOPSIS
   8 usmb [\-c \fIfile\fR] [\-d] [\-f] \fImount_id\fR
   9 .br
  10 usmb [\-c \fIfile\fR] \-u \fImount_id\fR
  11 .SH DESCRIPTION
  12 .P
  13 usmb mounts SMB and CIFS shares through FUSE, including Samba shares and
  14 Windows shared folders. Unlike some other such filesystems, usmb can mount
  15 shares from any server, including those not browsable or advertised on the
  16 network.
  17 .P
  18 Shares, usernames and other details are defined in a configuration file, by
  19 default ${HOME}/.usmb.conf.
  20 .SH OPTIONS
  21 .TP
  22 \fB\-c\fR \fIfile\fR, \fB\-\-config\fR=\fIfile\fR
  23 Use \fIfile\fR rather than ${HOME}/.usmb.conf as the configuration file.
  24 .TP
  25 \fB\-d\fR, \fB\-\-debug\fR
  26 Debug mode.
  27 .TP
  28 \fB\-f\fR, \fB\-\-nofork\fR
  29 Foreground operation (i.e. don't daemonise).
  30 .TP
  31 \fB\-h\fR, \fB\-\-help\fR
  32 Show usage information and exit.
  33 .TP
  34 \fB\-u\fR, \fB\-\-unmount\fR
  35 Unmount the given filesystem.
  36 .TP
  37 \fB\-v\fR, \fB\-\-version\fR
  38 Show usmb, FUSE and Samba versions and exit.
  39 .P
  40 .SH CONFIGURATION
  41 .P
  42 usmb uses the configuration file ${HOME}/.usmb.conf to define shares and the
  43 credentials used to access them. The configuration file is an XML file with
  44 two main elements: credentials and mounts. The file can contain any number of
  45 credentials and mounts elements; the whole file is wrapped in a usmbconfig
  46 element.
  47 .SS Credentials
  48 .P
  49 .ft CR
  50   <credentials id="\fIID used in mount elements\f(CR">
  51     <domain>\fIdomain or workgroup\f(CR</domain>
  52     <username>\fIusername\f(CR</username>
  53     <password>\fIpassword (optional)\f(CR</password>
  54   </credentials>
  55 .P
  56 Each credentials element defines a domain/username/password triple. If you
  57 omit the <password> element then usmb will prompt for a password when the
  58 credentials are used.
  59 .SS Mounts
  60 .P
  61 .ft CR
  62   <mount id="\fImount_id\f(CR" credentials="\fIID of credentials to use\f(CR">
  63     <server>\fIhostname or IP address of server\f(CR</server>
  64     <share>\fIshare name\f(CR</share>
  65     <mountpoint>\fI/path/to/mount/point\f(CR</mountpoint>
  66     <options>\fImount options\f(CR</options>
  67   </mount>
  68 .P
  69 A mount element describes a share. The id attribute is given on the usmb
  70 command line to identify the share to mount. The credentials attribute
  71 identified the id of the credentials element to use. The (optional) options
  72 element gives a comma-separated list of FUSE mount options:
  73 .TP
  74 \fBhard_remove\fR
  75 Immediate removal (don't hide files)
  76 .TP
  77 \fBumask=M\fR
  78 Set file permissions (octal)
  79 .TP
  80 \fBuid=N\fR
  81 Set file owner
  82 .TP
  83 \fBgid=N\fR
  84 Set file group
  85 .TP
  86 \fBallow_other\fR
  87 Allow access to other users
  88 .TP
  89 \fBallow_root\fR
  90 Allow access to root
  91 .TP
  92 \fBnonempty\fR
  93 Allow mount over non-empty directory
  94 .SS Example
  95 .P
  96 .ft CR
  97 <?xml version="1.0" encoding="ISO-8859-1"?>
  98 .br
  99 <usmbconfig>
 100
 101   <credentials id="cred1">
 102     <domain>WORKGROUP</domain>
 103     <username>user</username>
 104     <password>pass</password>
 105   </credentials>
 106
 107   <credentials id="cred2">
 108     <domain>mydomain</domain>
 109     <username>anotheruser</username>
 110     <!--  No password element => prompt for password at runtime. -->
 111   </credentials>
 112
 113   <mount id="home" credentials="cred1">
 114     <server>192.168.0.5</server>
 115     <share>myshare</share>
 116     <mountpoint>/tmp/smb</mountpoint>
 117   </mount>
 118
 119   <mount id="music" credentials="cred2">
 120     <server>winbox</server>
 121     <share>music</share>
 122
 123     <!-- You can use ~/xyz or ~user/xyz for the mountpoint. -->
 124     <mountpoint>~/music</mountpoint>
 125     <options>allow_root</options>
 126   </mount>
 127
 128 </usmbconfig>
 129 .P
 130 This defines two shares:
 131 .RS 2
 132 \\\\192.168.0.5\\myshare on /tmp/smb authenticating as WORKGROUP\\user
 133 .br
 134 \\\\winbox\\music on ${HOME}/music authenticating as mydomain\\anotheruser
 135 .RE
 136 .P
 137 These can be mounted using "usmb home" or "usmb music".
 138 .SH AUTHOR
 139 Geoff Johnstone, with contributions from Jonathan Schultz, Stijn Hoop, Nigel
 140 Smith and Michal Suchanek.
 141 .SH FILES
 142 ${HOME}/.usmb.conf
 143 .SH BUGS
 144 .P
 145 usmb should not require a configuration file. The configuration file can
 146 provide defaults but you should be able to specify everything necessary on
 147 the command line.
 148 .P
 149 usmb does not support Kerberos / GSSAPI authentication, although a development
 150 branch exists with preliminary support.
 151 .SH "SEE ALSO"
 152 fusermount(1), mount.cifs(8), umount.cifs(8).
 153 .SH COPYING
 154 Copyright \(co 2006-2010 Geoff Johnstone.
 155 .br
 156 Licence: GNU GPL version 3 <http://gnu.org/licenses/gpl.html>.