docs-xml: mention that the man pages are "part of" version x
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_unityed_media.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_media_harmony.8">
4
5 <refmeta>
6         <refentrytitle>vfs_unityed_media</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_unityed_media</refname>
16         <refpurpose>Allow multiple Avid clients to share a network drive.</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = unityed_media</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>Unityed Media is related with Media Harmony VFS, the
33         main difference between Unityed Media and Media Harmony is
34         that Unityed Media doesn't need manual refreshing of media
35         directories. Unityed Media handles your media files in a similar
36         way to the way Unity, ISIS, EditShare or another dedicated solution
37         does. Without client-side application and on hardware of your
38         choice.</para>
39
40         <para>This module is stackable.</para>
41 </refsect1>
42
43 <refsect1>
44         <title>CONFIGURATION</title>
45
46         <para>If Mac and Windows Avid clients will be accessing the same
47         folder, they should be given separate share definitions, with
48         hidden Mac files vetoed on the Windows share.  See EXAMPLES.</para>
49 </refsect1>
50
51 <refsect1>
52         <title>OPTIONS</title>
53
54         <variablelist>
55
56           <varlistentry>
57             <term>unityed_media:clientid = user | hostname | ip </term>
58             <listitem>
59               <para>Controls what client related identifier is
60               appended to user specific paths:</para>
61
62               <itemizedlist>
63                 <listitem><para><command>user (default)</command> -
64                 use the username.  </para></listitem>
65
66                 <listitem><para><command>hostname</command> - use the
67                 hostname. Note this will not work with OS X clients as
68                 these always send a generic string ("workstation") to
69                 the server..</para></listitem>
70
71                 <listitem><para><command>ip</command> - use the
72                 client's IP address.  NOTE: this is untested and may
73                 not work at all.</para></listitem>
74               </itemizedlist>
75
76             </listitem>
77           </varlistentry>
78         </variablelist>
79 </refsect1>
80
81 <refsect1>
82         <title>EXAMPLES</title>
83
84         <para>Enable unityed_media for Mac and Windows clients:</para>
85 <programlisting>
86         <smbconfsection name="[avid_mac]"/>
87         <smbconfoption name="path">/avid</smbconfoption>
88         <smbconfoption name="vfs objects">unityed_media</smbconfoption>
89         <smbconfsection name="[avid_win]"/>
90         <smbconfoption name="path">/avid</smbconfoption>
91         <smbconfoption name="vfs objects">unityed_media</smbconfoption>
92         <smbconfoption name="veto files">/.DS_Store/._@/.Trash@/.Spotlight@/.hidden/.hotfiles@/.vol/</smbconfoption>
93         <smbconfoption name="delete veto files">yes</smbconfoption>
94 </programlisting>
95
96 </refsect1>
97
98 <refsect1>
99         <title>VERSION</title>
100
101         <para>This man page is part of version &doc.version; of the Samba suite.
102         </para>
103 </refsect1>
104
105 <refsect1>
106         <title>AUTHOR</title>
107
108         <para>The original Samba software and related utilities
109         were created by Andrew Tridgell. Samba is now developed
110         by the Samba Team as an Open Source project similar
111         to the way the Linux kernel is developed.</para>
112
113 </refsect1>
114
115 </refentry>