media_harmony VFS module: Add and build by default.
[kamenim/samba-autobuild/.git] / docs-xml / manpages-3 / vfs_media_harmony.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_media_harmony</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">3.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_media_harmony</refname>
16         <refpurpose>Allow multiple Avid clients to share a network drive.</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = media_harmony</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>The <command>vfs_media_harmony</command> VFS module allows
33         Avid editorial workstations to share a network drive.  It does
34         this by:</para>
35         <orderedlist continuation="restarts" inheritnum="ignore" numeration="arabic">
36         <listitem><para>Giving each client their own copy of the Avid
37         msmMMOB.mdb and msmFMID.pmr files and Creating directories.</para></listitem>
38         <listitem><para>Allowing each client to explicitly control the
39         write time the Avid application sees on Avid media directories.</para></listitem>
40         </orderedlist>
41
42         <para>This module is stackable.</para>
43
44 </refsect1>
45
46 <refsect1>
47         <title>CONFIGURATION</title>
48
49         <para><command>vfs_media_harmony</command> automatically redirects
50         requests from clients for Avid database files or an Avid Creating
51         directory to a client-specific version of the file.  No
52         configuration beyond enabling the module is needed to get this
53         portion of its functionality working.</para>
54
55         <para>If Mac and Windows Avid clients will be accessing the same
56         folder, they should be given separate share definitions, with
57         hidden Mac files vetoed on the Windows share.  See EXAMPLES.</para>
58
59         <para>To allow each client to control when the Avid application
60         refreshes their Avid databases, create files for each client
61         and each Avid media directory with the name
62         [avid_dir_name]_[client_ip_address]_[client_username].
63         To trigger Avid database refreshes, update the write time on
64         those files.  See EXAMPLES.</para>
65
66         <para>It is also necessary for the <command>cache locked write times = no</command>
67         option to be set for clients to be able to control their Avid
68         media folder write times.</para>
69
70 </refsect1>
71
72 <refsect1>
73         <title>EXAMPLES</title>
74
75         <para>Enable media_harmony for Mac and Windows clients:</para>
76 <programlisting>
77         <smbconfsection name="[avid_mac]"/>
78         <smbconfoption name="path">/avid</smbconfoption>
79         <smbconfoption name="vfs objects">media_harmony</smbconfoption>
80         <smbconfoption name="cache locked write times">no</smbconfoption>
81         <smbconfsection name="[avid_win]"/>
82         <smbconfoption name="path">/avid</smbconfoption>
83         <smbconfoption name="vfs objects">media_harmony</smbconfoption>
84         <smbconfoption name="cache locked write times">no</smbconfoption>
85         <smbconfoption name="veto files">/.DS_Store/._@/.Trash@/.Spotlight@/.hidden/.hotfiles@/.vol/</smbconfoption>
86         <smbconfoption name="delete veto files">yes</smbconfoption>
87 </programlisting>
88
89         <para>Create the files that will allow users david and susan
90         to control their own Avid database refreshes:</para>
91 <programlisting>
92         touch '/avid/OMFI MediaFiles_192.168.1.10_david' \
93                 '/avid/OMFI MediaFiles_192.168.1.11_susan' \
94                 '/avid/Avid MediaFiles/MXF/1_192.168.1.10_david' \
95                 '/avid/Avid MediaFiles/MXF/1_192.168.1.11_susan'
96 </programlisting>
97         <para>Trigger an Avid database refresh for user david:</para>
98 <programlisting>
99         touch '/avid/OMFI MediaFiles_192.168.1.10_david' \
100                 '/avid/Avid MediaFiles/MXF/1_192.168.1.10_david'
101 </programlisting>
102
103         <para>If you have a large number of Avid media folders to manage,
104         you can give each editor a suitably modified version of
105         examples/scripts/vfs/media_harmony/trigger_avid_update.py to
106         create and update these files.</para>
107
108 </refsect1>
109
110 <refsect1>
111         <title>CAVEATS</title>
112
113         <para><command>vfs_media_harmony</command> is designed to work with
114         Avid editing applications that look in the Avid MediaFiles or
115         OMFI MediaFiles directories for media.  It is not designed to work
116         as expected in all circumstances for general use.  For example: It
117         is possible to open a client-specific file such as
118         msmMMOB.mdb_192.168.1.10_userx even though it doesn't show up
119         in a directory listing.</para>
120
121 </refsect1>
122
123
124
125 <refsect1>
126         <title>VERSION</title>
127
128         <para>This man page is correct for version 3.2.7 of the Samba suite.
129         </para>
130 </refsect1>
131
132 <refsect1>
133         <title>AUTHOR</title>
134
135         <para>The original Samba software and related utilities
136         were created by Andrew Tridgell. Samba is now developed
137         by the Samba Team as an Open Source project similar
138         to the way the Linux kernel is developed.</para>
139
140 </refsect1>
141
142 </refentry>