diff options
Diffstat (limited to 'docs-xml')
| -rw-r--r-- | docs-xml/manpages-3/idmap_adex.8.xml | 89 | ||||
| -rw-r--r-- | docs-xml/manpages-3/idmap_hash.8.xml | 76 | ||||
| -rw-r--r-- | docs-xml/manpages-3/pam_winbind.7.xml | 8 | ||||
| -rw-r--r-- | docs-xml/manpages-3/vfs_smb_traffic_analyzer.8.xml | 157 | ||||
| -rw-r--r-- | docs-xml/smbdotconf/printing/cupsconnectiontimeout.xml | 20 | ||||
| -rw-r--r-- | docs-xml/smbdotconf/winbind/winbindnormalizenames.xml | 27 |
6 files changed, 369 insertions, 8 deletions
diff --git a/docs-xml/manpages-3/idmap_adex.8.xml b/docs-xml/manpages-3/idmap_adex.8.xml new file mode 100644 index 0000000000..9eb2ff7d46 --- /dev/null +++ b/docs-xml/manpages-3/idmap_adex.8.xml @@ -0,0 +1,89 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc"> +<refentry id="idmap_adex.8"> + +<refmeta> + <refentrytitle>idmap_adex</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="source">Samba</refmiscinfo> + <refmiscinfo class="manual">System Administration tools</refmiscinfo> + <refmiscinfo class="version">3.2</refmiscinfo> +</refmeta> + + +<refnamediv> + <refname>idmap_adex</refname> + <refpurpose>Samba's idmap_adex Backend for Winbind</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <title>DESCRIPTION</title> + <para> + The idmap_adex plugin provides a way for Winbind to read + id mappings from an AD server that uses RFC2307 schema + extensions. This module implements both the idmap and nss_info + APIs and supports domain trustes as well as two-way cross + forest trusts. It is a read-only plugin requiring that the + administrator provide mappings in advance by adding the + POSIX attribute information to the users and groups objects + in AD. The most common means of doing this is using "Identity + Services for Unix" support on Windows 2003 R2 and later. + </para> + + <para> + Note that you must add the uidNumber, gidNumber, and uid + attributes to the partial attribute set of the forest global + catalog servers. This can be done using the Active Directory Schema + Management MMC plugin (schmmgmt.dll). + </para> +</refsynopsisdiv> + +<refsynopsisdiv> + <title>NSS_INFO</title> + <para> + The nss_info plugin supports reading the unixHomeDirectory, + gidNumber, loginShell, and uidNumber attributes from the user + object and the gidNumber attribute from the group object to + fill in information required by the libc getpwnam() and + getgrnam() family of functions. Group membership is filled in + according to the Windows group membership and not the + msSFU30PosixMember attribute. + </para> + + <para> + Username aliases are implement by setting the uid attribute + on the user object. While group name aliases are implemented + by reading the displayname attribute from the group object. + </para> +</refsynopsisdiv> + +<refsect1> + <title>EXAMPLES</title> + <para> + The following example shows how to retrieve idmappings and NSS data + from our principal and trusted AD domains. + </para> + + <programlisting> + [global] + idmap backend = adex + idmap uid = 1000-4000000000 + idmap gid = 1000-4000000000 + + winbind nss info = adex + winbind normalize names = yes + </programlisting> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para> + 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. + </para> +</refsect1> + +</refentry> diff --git a/docs-xml/manpages-3/idmap_hash.8.xml b/docs-xml/manpages-3/idmap_hash.8.xml new file mode 100644 index 0000000000..8e452b3c89 --- /dev/null +++ b/docs-xml/manpages-3/idmap_hash.8.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc"> +<refentry id="idmap_hash.8"> + +<refmeta> + <refentrytitle>idmap_hash</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="source">Samba</refmiscinfo> + <refmiscinfo class="manual">System Administration tools</refmiscinfo> + <refmiscinfo class="version">3.2</refmiscinfo> +</refmeta> + + +<refnamediv> + <refname>idmap_hash</refname> + <refpurpose>Samba's idmap_hash Backend for Winbind</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <title>DESCRIPTION</title> + <para>The idmap_hash plugin implements a hashing algorithm used + map SIDs for domain users and groups to a 31-bit uid and gid. + This plugin also implements the nss_info API and can be used + to support a local name mapping files if enabled via the + "winbind normlaize names" and "winbind nss info" + parameters in smb.conf. + </para> +</refsynopsisdiv> + +<refsect1> + <title>IDMAP OPTIONS</title> + + <variablelist> + <varlistentry> + <term>name_map</term> + <listitem><para> + Specifies the absolute path to the name mapping + file used by the nss_info API. Entries in the file + are of the form "<replaceable>unix name</replaceable> + = <replaceable>qualified domain name</replaceable>"e;. + Mapping of both user and group names is supported. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>EXAMPLES</title> + <para>The following example utilizes the idmap_hash plugin for + the idmap and nss_info information. + </para> + + <programlisting> + [global] + idmap backend = hash + idmap uid = 1000-4000000000 + idmap gid = 1000-4000000000 + + winbind nss info = hash + winbind normalize names = yes + idmap_hash:name_map = /etc/samba/name_map.cfg + </programlisting> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para> + 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. + </para> +</refsect1> + +</refentry> diff --git a/docs-xml/manpages-3/pam_winbind.7.xml b/docs-xml/manpages-3/pam_winbind.7.xml index cf7fd5a0f6..7f233c1386 100644 --- a/docs-xml/manpages-3/pam_winbind.7.xml +++ b/docs-xml/manpages-3/pam_winbind.7.xml @@ -134,6 +134,14 @@ </para></listitem> </varlistentry> + <varlistentry> + <term>mkhomedir</term> + <listitem><para> + Create homedirectory for a user on-the-fly, option is valid in + PAM session block. + </para></listitem> + </varlistentry> + </variablelist> diff --git a/docs-xml/manpages-3/vfs_smb_traffic_analyzer.8.xml b/docs-xml/manpages-3/vfs_smb_traffic_analyzer.8.xml new file mode 100644 index 0000000000..28c8413231 --- /dev/null +++ b/docs-xml/manpages-3/vfs_smb_traffic_analyzer.8.xml @@ -0,0 +1,157 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc"> +<refentry id="vfs_smb_traffic_analyzer.8"> + +<refmeta> + <refentrytitle>smb_traffic_analyzer</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="source">Samba</refmiscinfo> + <refmiscinfo class="manual">System Administration tools</refmiscinfo> + <refmiscinfo class="version">3.3</refmiscinfo> +</refmeta> + + +<refnamediv> + <refname>vfs_smb_traffic_analyzer</refname> + <refpurpose>log Samba VFS read and write operations through a socket + to a helper application</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>vfs objects = smb_traffic_analyzer</command> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This VFS module is part of the + <citerefentry><refentrytitle>samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>The <command>vfs_smb_traffic_analyzer</command> VFS module logs + client write and read operations on a Samba server and sends this data + over a socket to a helper program, which feeds a SQL database. More + information on the helper programs can be obtained from the + homepage of the project at: + http://holger123.wordpress.com/smb-traffic-analyzer/ + </para> + <para><command>vfs_smb_traffic_analyzer</command> currently is aware + of the following VFS operations:</para> + + <simplelist> + <member>write</member> + <member>pwrite</member> + <member>read</member> + <member>pread</member> + </simplelist> + + <para><command>vfs_smb_traffic_analyzer</command> sends the following data + in a fixed format seperated by a comma through either an internet or a + unix domain socket:</para> + <programlisting> + BYTES|USER|DOMAIN|READ/WRITE|SHARE|FILENAME|TIMESTAMP + </programlisting> + + <para>Description of the records: + + <itemizedlist> + <listitem><para><command>BYTES</command> - the length in bytes of the VFS operation</para></listitem> + <listitem><para><command>USER</command> - the user who initiated the operation</para></listitem> + <listitem><para><command>DOMAIN</command> - the domain of the user</para></listitem> + <listitem><para><command>READ/WRITE</command> - either "W" for a write operation or "R" for read</para></listitem> + <listitem><para><command>SHARE</command> - the name of the share on which the VFS operation occured</para></listitem> + <listitem><para><command>FILENAME</command> - the name of the file that was used by the VFS operation</para></listitem> + <listitem><para><command>TIMESTAMP</command> - a timestamp, formatted as "yyyy-mm-dd hh-mm-ss.ms" indicating when the VFS operation occured</para></listitem> + </itemizedlist> + + </para> + + <para>This module is stackable.</para> + +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term>smb_traffic_analyzer:mode = STRING</term> + <listitem> + <para>If STRING matches to "unix_domain_socket", the module will + use a unix domain socket located at /var/tmp/stadsocket, if + STRING contains an different string or is not defined, the module will + use an internet domain socket for data transfer.</para> + + </listitem> + </varlistentry> + + + <varlistentry> + <term>smb_traffic_analyzer:host = STRING</term> + <listitem> + <para>The module will send the data to the system named with + the hostname STRING.</para> + + </listitem> + </varlistentry> + + <varlistentry> + <term>smb_traffic_analyzer:port = STRING</term> + <listitem> + <para>The module will send the data using the TCP port given + in STRING + </para> + + </listitem> + </varlistentry> + + + </variablelist> +</refsect1> + +<refsect1> + <title>EXAMPLES</title> + + <para>The module running on share "example_share", using a unix domain socket</para> + <programlisting> + <smbconfsection name="[example_share]"/> + <smbconfoption name="path">/data/example</smbconfoption> + <smbconfoption name="vfs objects">smb_traffic_analyzer</smbconfoption> + <smbconfoption name="smb_traffic_analyzer:mode">unix_domain_socket</smbconfoption> + </programlisting> + + <para>The module running on share "example_share", using an internet domain socket, + connecting to host "examplehost" on port 3491.</para> + <programlisting> + <smbconfsection name="[example_share]"/> + <smbconfoption name="path">/data/example</smbconfoption> + <smbconfoption name="vfs objects">smb_traffic_analyzer</smbconfoption> + <smbconfoption name="smb_traffic_analyzer:host">examplehost</smbconfoption> + <smbconfoption name="smb_traffic_analyzer:port">3490</smbconfoption> + </programlisting> + +</refsect1> + +<refsect1> + <title>VERSION</title> + <para>This man page is correct for version 3.3 of the Samba suite. + </para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>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.</para> + + <para>The original version of the VFS module and the + helper tools were created by Holger Hetterich.</para> +</refsect1> + +</refentry> diff --git a/docs-xml/smbdotconf/printing/cupsconnectiontimeout.xml b/docs-xml/smbdotconf/printing/cupsconnectiontimeout.xml new file mode 100644 index 0000000000..1c7df15c3c --- /dev/null +++ b/docs-xml/smbdotconf/printing/cupsconnectiontimeout.xml @@ -0,0 +1,20 @@ +<samba:parameter name="cups connection timeout" + context="G" + type="integer" + print="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter is only applicable if <smbconfoption name="printing"/> is set to <constant>cups</constant>. + </para> + + <para> + If set, this option specifies the number of seconds that smbd will wait + whilst trying to contact to the CUPS server. The connection will fail + if it takes longer than this number of seconds. + </para> +</description> + +<value type="default">30</value> +<value type="example">60</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/winbind/winbindnormalizenames.xml b/docs-xml/smbdotconf/winbind/winbindnormalizenames.xml index 28826cf5f3..5b68bca912 100644 --- a/docs-xml/smbdotconf/winbind/winbindnormalizenames.xml +++ b/docs-xml/smbdotconf/winbind/winbindnormalizenames.xml @@ -5,14 +5,25 @@ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> <para>This parameter controls whether winbindd will replace - whitespace in user and group names with an underscore (_) character. - For example, whether the name "Space Kadet" should be - replaced with the string "space_kadet". - Frequently Unix shell scripts will have difficulty with usernames - contains whitespace due to the default field separator in the shell. - Do not enable this option if the underscore character is used in - account names within your domain - </para> + whitespace in user and group names with an underscore (_) character. + For example, whether the name "Space Kadet" should be + replaced with the string "space_kadet". + Frequently Unix shell scripts will have difficulty with usernames + contains whitespace due to the default field separator in the shell. + If your domain possesses names containing the underscore character, + this option may cause problems unless the name aliasing feature + is supported by your nss_info plugin. + </para> + + <para>This feature also enables the name aliasing API which can + be used to make domain user and group names to a non-qlaified + version. Please refer to the manpage for the configured + idmap and nss_info plugin for the specifics on how to configure + name aliasing for a specific configuration. Name aliasing takes + precendence (and is mutually exclusive) over the whitespace + replacement mechanism discussed previsouly. + </para> + </description> <value type="default">no</value> |