Introduction
Introduction Statistics Contact Development Disclaimer Help
Major manpage overhaul. - susmb - mounting of SMB/CIFS shares via FUSE
git clone git://git.codemadness.org/susmb
Log
Files
Refs
README
LICENSE
---
commit 63a04f04d15b49ebcae0f359b50ce6ea550d7428
parent b5dd6bf3497dc1cedb8f7e30658ad009aea5ac38
Author: Geoff Johnstone <[email protected]>
Date: Fri, 2 Apr 2010 19:20:51 +0100
Major manpage overhaul.
Augment the previous skeleton content with configuration information etc.
Rewrite as a native roff document.
Diffstat:
M debian/control | 1 -
A usmb.1 | 156 +++++++++++++++++++++++++++++…
D usmb.1.txt | 71 -----------------------------…
3 files changed, 156 insertions(+), 72 deletions(-)
---
diff --git a/debian/control b/debian/control
@@ -3,7 +3,6 @@ Section: otherosfs
Priority: optional
Build-Depends:
debhelper,
- asciidoc, xmlto,
autoconf (>= 2.63),
devscripts,
libfuse-dev (>= 2.6),
diff --git a/usmb.1 b/usmb.1
@@ -0,0 +1,156 @@
+.\" Copyright (C) 2010 Geoff Johnstone.
+.\" See section COPYING for conditions for redistribution.
+.TH usmb 1 "April 2010" "usmb" "User Commands"
+.fp 0 CR
+.SH NAME
+usmb \- Mount SMB/CIFS shares via FUSE
+.SH SYNOPSIS
+usmb [\-c \fIfile\fR] [\-d] [\-f] \fImount_id\fR
+.br
+usmb [\-c \fIfile\fR] \-u \fImount_id\fR
+.SH DESCRIPTION
+.P
+usmb mounts SMB and CIFS shares through FUSE, including Samba shares and
+Windows shared folders. Unlike some other such filesystems, usmb can mount
+shares from any server, including those not browsable or advertised on the
+network.
+.P
+Shares, usernames and other details are defined in a configuration file, by
+default ${HOME}/.usmb.conf.
+.SH OPTIONS
+.TP
+\fB\-c\fR \fIfile\fR, \fB\-\-config\fR=\fIfile\fR
+Use \fIfile\fR rather than ${HOME}/.usmb.conf as the configuration file.
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Debug mode.
+.TP
+\fB\-f\fR, \fB\-\-nofork\fR
+Foreground operation (i.e. don't daemonise).
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show usage information and exit.
+.TP
+\fB\-u\fR, \fB\-\-unmount\fR
+Unmount the given filesystem.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Show usmb, FUSE and Samba versions and exit.
+.P
+.SH CONFIGURATION
+.P
+usmb uses the configuration file ${HOME}/.usmb.conf to define shares and the
+credentials used to access them. The configuration file is an XML file with
+two main elements: credentials and mounts. The file can contain any number of
+credentials and mounts elements; the whole file is wrapped in a usmbconfig
+element.
+.SS Credentials
+.P
+.ft CR
+ <credentials id="\fIID used in mount elements\f(CR">
+ <domain>\fIdomain or workgroup\f(CR</domain>
+ <username>\fIusername\f(CR</username>
+ <password>\fIpassword (optional)\f(CR</password>
+ </credentials>
+.P
+Each credentials element defines a domain/username/password triple. If you
+omit the <password> element then usmb will prompt for a password when the
+credentials are used.
+.SS Mounts
+.P
+.ft CR
+ <mount id="\fImount_id\f(CR" credentials="\fIID of credentials to use\f(CR">
+ <server>\fIhostname or IP address of server\f(CR</server>
+ <share>\fIshare name\f(CR</share>
+ <mountpoint>\fI/path/to/mount/point\f(CR</mountpoint>
+ <options>\fImount options\f(CR</options>
+ </mount>
+.P
+A mount element describes a share. The id attribute is given on the usmb
+command line to identify the share to mount. The credentials attribute
+identified the id of the credentials element to use. The (optional) options
+element gives a comma-separated list of FUSE mount options:
+.TP
+\fBhard_remove\fR
+Immediate removal (don't hide files)
+.TP
+\fBumask=M\fR
+Set file permissions (octal)
+.TP
+\fBuid=N\fR
+Set file owner
+.TP
+\fBgid=N\fR
+Set file group
+.TP
+\fBallow_other\fR
+Allow access to other users
+.TP
+\fBallow_root\fR
+Allow access to root
+.TP
+\fBnonempty\fR
+Allow mount over non-empty directory
+.SS Example
+.P
+.ft CR
+<?xml version="1.0" encoding="ISO-8859-1"?>
+.br
+<usmbconfig>
+
+ <credentials id="cred1">
+ <domain>WORKGROUP</domain>
+ <username>user</username>
+ <password>pass</password>
+ </credentials>
+
+ <credentials id="cred2">
+ <domain>mydomain</domain>
+ <username>anotheruser</username>
+ <!-- No password element => prompt for password at runtime. -->
+ </credentials>
+
+ <mount id="home" credentials="cred1">
+ <server>192.168.0.5</server>
+ <share>myshare</share>
+ <mountpoint>/tmp/smb</mountpoint>
+ </mount>
+
+ <mount id="music" credentials="cred2">
+ <server>winbox</server>
+ <share>music</share>
+
+ <!-- You can use ~/xyz or ~user/xyz for the mountpoint. -->
+ <mountpoint>~/music</mountpoint>
+ <options>allow_root</options>
+ </mount>
+
+</usmbconfig>
+.P
+This defines two shares:
+.RS 2
+\\\\192.168.0.5\\myshare on /tmp/smb authenticating as WORKGROUP\\user
+.br
+\\\\winbox\\music on ${HOME}/music authenticating as mydomain\\anotheruser
+.RE
+.P
+These can be mounted using "usmb home" or "usmb music".
+.SH AUTHOR
+Geoff Johnstone, with contributions from Jonathan Schultz, Stijn Hoop, Nigel
+Smith and Michal Suchanek.
+.SH FILES
+${HOME}/.usmb.conf
+.SH BUGS
+.P
+usmb should not require a configuration file. The configuration file can
+provide defaults but you should be able to specify everything necessary on
+the command line.
+.P
+usmb does not support Kerberos / GSSAPI authentication, although a development
+branch exists with preliminary support.
+.SH "SEE ALSO"
+fusermount(1), mount.cifs(8), umount.cifs(8).
+.SH COPYING
+Copyright \(co 2006-2010 Geoff Johnstone.
+.br
+Licence: GNU GPL version 3 <http://gnu.org/licenses/gpl.html>.
diff --git a/usmb.1.txt b/usmb.1.txt
@@ -1,71 +0,0 @@
-USMB(1)
-=======
-Geoff Johnstone
-
-
-NAME
-----
-
-usmb - mount SMB/CIFS shares via FUSE
-
-SYNOPSIS
---------
-
-*usmb* [OPTION...]
-
-DESCRIPTION
------------
-
-usmb allows mounting Samba (CIFS) shares through FUSE.
-
-
-Unlike some other Samba FUSE implementation usmb can mount shares from any
-server, including serrvers and shares not visible in "Network neighbourhood"
-(not advertised on the local lan.
-
-The share, user name and other details are specified in a configuration file.
-
-The source archive includes an example configuration file 'usmb.conf' and a
-more complete documentation of the program in 'README' file. If you have
-installed packaged version of the program these files should be available in
-'/usr/share/doc/usmb'.
-
-OPTIONS
--------
-
-*-c 'configuration file'*::
-*--config='configuration file'*::
- Specify configuration file to use.
- Defaults to '~/.usmb.conf'.
-
-*-d*::
-*--debug*::
- Debug mode.
-
-*-f*::
-*--nofork*::
- Do not fork, stay in foreground.
-
-*-h*::
-*--help*::
- Show options.
-
-FILES
------
-*'~/.usmb.conf'*::
- The default location of usmb configuration file.
-
-SEE ALSO
---------
-'README' 'usmb.conf' *fusermount*(1)
-
-
-AUTHORS
--------
- usmb was written by Geoff Johnstone
- This minimal manpage was written by Michal Suchanek <[email protected]>
-
-COPYING
--------
-Free use of this software is granted under the terms of the GNU General Public
-License (GPL).
You are viewing proxied material from codemadness.org. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.