Next update of VFS modules development guide
[bbaumbach/samba-autobuild/.git] / docs / smbdotconf / misc / remoteannounce.xml
1 <samba:parameter name="remote announce"
2                  context="G"
3                  advanced="1" developer="1"
4                  type="list"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7         <para>
8         This option allows you to setup <citerefentry><refentrytitle>nmbd</refentrytitle>
9         <manvolnum>8</manvolnum></citerefentry>to periodically announce itself 
10         to arbitrary IP addresses with an arbitrary workgroup name.
11         </para>
12
13         <para>
14         This is useful if you want your Samba server to appear in a remote workgroup for 
15         which the normal browse propagation rules don't work. The remote workgroup can be 
16         anywhere that you can send IP packets to.
17         </para>
18
19         <para>
20         For example:
21 <programlisting>
22 <command moreinfo="none">remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF</command>
23 </programlisting>
24         the above line would cause <command moreinfo="none">nmbd</command> to announce itself 
25         to the two given IP addresses using the given workgroup names. If you leave out the 
26         workgroup name then the one given in the <smbconfoption name="workgroup"/> parameter 
27         is used instead.
28         </para>
29
30         <para>
31         The IP addresses you choose would normally be the broadcast addresses of the remote 
32         networks, but can also be the IP addresses of known browse masters if your network 
33         config is that stable.
34         </para>
35
36         <para>
37         See the chapter on Network Browsing in the Samba-HOWTO book.
38         </para>
39 </description>
40
41 <value type="default"></value>
42 </samba:parameter>