diff options
Diffstat (limited to 'docs/docbook')
| -rw-r--r-- | docs/docbook/manpages/smbmnt.8.sgml | 97 | ||||
| -rw-r--r-- | docs/docbook/manpages/smbmount.8.sgml | 181 | ||||
| -rw-r--r-- | docs/docbook/manpages/smbumount.8.sgml | 67 |
3 files changed, 345 insertions, 0 deletions
diff --git a/docs/docbook/manpages/smbmnt.8.sgml b/docs/docbook/manpages/smbmnt.8.sgml new file mode 100644 index 0000000000..e25c73d092 --- /dev/null +++ b/docs/docbook/manpages/smbmnt.8.sgml @@ -0,0 +1,97 @@ +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="smbumount"> + +<refmeta> + <refentrytitle>smbmnt</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbmnt</refname> + <refpurpose>helper utility for mounting SMB filesystems</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbumount</command> + <arg choice="req">mount-point</arg> + <arg choice="opt">-s <share></arg> + <arg choice="opt">-r</arg> + <arg choice="opt">-u <uid></arg> + <arg choice="opt">-g <gid></arg> + <arg choice="opt">-f <mask></arg> + <arg choice="opt">-d <mask></arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para><command>smbmnt</command> is a helper application used + by the smbmount program to do the actual mounting of SMB shares. + <command>smbmnt</command> is meant to be installed setuid root + so that normal users can mount their smb shares. It checks + whether the user has write permissions on the mount point and + then mounts the directory.</para> + + <para>The <command>smbmnt</command> program is normally invoked + by <ulink url="smbmount.8.html"><command>smbmount(8)</command> + </ulink>. It should not be invoked directly by users. </para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-r</term> + <listitem><para>mount the filesystem read-only + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-u uid</term> + <listitem><para>specify the uid that the files will + be owned by </para></listitem> + </varlistentry> + + <varlistentry> + <term>-g gid</term> + <listitem><para>specify the gid that the files will be + owned by </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-f mask</term> + <listitem><para>specify the octal file mask applied + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-d mask</term> + <listitem><para>specify the octal directory mask + applied </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>The current maintainer of smbfs and the userspace + tools <command>smbmount</command>, <command>smbumount</command>, + and <command>smbmnt</command> is <ulink + url="mailto:urban@teststation.com">Urban Widmark</ulink>.</para> + + <para>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbmount.8.sgml b/docs/docbook/manpages/smbmount.8.sgml new file mode 100644 index 0000000000..a1a510ecd7 --- /dev/null +++ b/docs/docbook/manpages/smbmount.8.sgml @@ -0,0 +1,181 @@ +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="smbmount"> + +<refmeta> + <refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbmount</refname> + <refpurpose>mount and smbfs filesystem</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbumount</command> + <arg choice="req">service</arg> + <arg choice="req">mount-point</arg> + <arg choice="opt">-o options</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para><command>smbmount</command> mounts a SMB filesystem. It + is usually invoked as <command>mount.smb</command> from + the <command>mount(8)</command> command when using the + "-t smb" option. The kernel must support the smbfs filesystem. </para> + + <para>Options to smbmount are specified as a comma separated list + of key=value pairs.</para> + + <para><emphasis>NOTE:</emphasis> <command>smbmount</command> + calls <command>smbmnt(8)</command> to do the actual mount. You + must make sure that <command>smbmnt</command> is in the path so + that it can be found. </para> + +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>username=<arg></term> + <listitem><para>specifies the username to connect as. If + this is not given then the environment variable <parameter> + $USER</parameter> is used. This option can also take the + form "user%password" or "user/workgroup" or + "user/workgroup%password" to allow the password and workgroup + to be specified as part of the username.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>password=<arg></term> + <listitem><para>specifies the SMB password. If not given then + <command>smbmount</command> will prompt for a passeword, unless + the guest option is given. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>netbiosname=<arg></term> + <listitem><para>sets the source NetBIOS name. It defaults + to the local hostname. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>uid=<arg></term> + <listitem><para>sets the uid that files will be mounted as. + It may be specified as either a username or a numeric uid. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>gid=<arg></term> + <listitem><para>sets the gid that files will be mounted as. + It may be specified as either a groupname or a numeric + gid. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>port=<arg></term> + <listitem><para>sets the remote SMB port number. The default + is 139. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>fmask=<arg></term> + <listitem><para>sets the file mask. This determines the + permissions that remote files have in the local filesystem. + The default is based on the current umask. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>dmask=<arg></term> + <listitem><para>sets the directory mask. This deterines the + permissions that remote directories have in the local filesystem. + The default is based on the current umask. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>debug=<arg></term> + <listitem><para>sets the debug level. This is useful for + tracking down SMB connection problems. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>ip=<arg></term> + <listitem><para>sets the destination host or IP address. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>workgroup=<arg></term> + <listitem><para>sets the workgroup on the destination </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>sockopt=<arg></term> + <listitem><para>sets the TCP socket options. See the <ulink + url="smb.conf.5.html#SOCKETOPTIONS"><filename>smb.conf + </filename></ulink> <parameter>socket options</parameter> option. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>scope=<arg></term> + <listitem><para>sets the NetBIOS scope </para></listitem> + </varlistentry> + + <varlistentry> + <term>guest</term> + <listitem><para>don't prompt for a password </para></listitem> + </varlistentry> + + + <varlistentry> + <term>ro</term> + <listitem><para>mount read-only </para></listitem> + </varlistentry> + + <varlistentry> + <term>rw</term><listitem><para>mount read-write </para></listitem> + </varlistentry> + </variablelist> + + +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>The current maintainer of smbfs and the userspace + tools <command>smbmount</command>, <command>smbumount</command>, + and <command>smbmnt</command> is <ulink + url="mailto:urban@teststation.com">Urban Widmark</ulink></para> + + <para>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbumount.8.sgml b/docs/docbook/manpages/smbumount.8.sgml new file mode 100644 index 0000000000..be7e929e06 --- /dev/null +++ b/docs/docbook/manpages/smbumount.8.sgml @@ -0,0 +1,67 @@ +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="smbumount"> + +<refmeta> + <refentrytitle>smbumount</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbumount</refname> + <refpurpose>smbfs umount for normal users</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbumount</command> + <arg choice="req">mount-point</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>With this program, normal users can unmount smb-filesystems, + provided that it is suid root. <command>smbumount</command> has + been written to give normal linux-users more control over their + resources. It is safe to install this program suid root, because only + the user who has mounted a filesystem is allowed to unmount it again. + For root it is not necessary to use smbumount. The normal umount + program works perfectly well, but it would certainly be problematic + to make umount setuid root.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>mount-point</term> + <listitem><para>The directory to unmount.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>SEE ALSO</title> + + <para><ulink url="smbmount.8.html"><command>smbmount(8)</command> + </ulink></para> +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>The current maintainer of smbfs and the userspace + tools <command>smbmount</command>, <command>smbumount</command>, + and <command>smbmnt</command> is <ulink + url="mailto:urban@teststation.com">Urban Widmark</ulink>.</para> + + <para>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter</para> +</refsect1> + +</refentry> |