.TH FUSESMB.CONF 5 "August 5, 2005"

.SH NAME
fusesmb.conf \- the configuration file for \fBfusesmb\fR

.SH FILE FORMAT
The file consists of sections and parameters. A section begins with the name of the section in square
brackets and continues until the next section begins. Sections contain parameters of the form: \fIname\fR = \fIvalue\fR.

The file is line-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter.
.PP
Section and parameter names are not case sensitive.
.PP
Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is discarded.
Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading and  trailing  whitespace
in a parameter value is discarded. Internal whitespace within a parameter value is retained verbatim.
.PP
Any  line beginning with a semicolon (``\fB;\fR'') or a hash (``\fB#\fR'') character is ignored, as are lines containing only whitespace.

.SH SPECIAL SECTIONS
.B fusesmb.conf
can contain the following sections:
.TP
The \fB[global]\fR section
Section for global parameters.
.TP
The \fB[ignore]\fR section
Section for specifying servers and/or workgroups that should not be listed.
.TP
The \fB[/\fISERVER\fR\fB]\fR section
Section for server-specific settings. The section name should start with a slash ``\fB/\fR'' and not end with a slash.
.TP
The \fB[/\fISERVER\fB/\fISHARE\fB]\fR
Section for share-specific settings. The section name should start with a slash followed by the server name followed by a slash ending on the share name. It should not end with a slash.

.SH EXPLANATION OF EACH PARAMETER
This chapter explains each possible option. The section names - specified between parentheses after each option - shows the applicable sections for this option. For example: ( [global] ) specifies that this option is only possible for the section [global].
.TP
\fBignore\fR ( [/SERVER] )
Ignore this server. Possible values are: true, false, 1 and 0.

Example: \fIignore\fR = \fItrue\fR
.TP
\fBinterval\fR ( [global] )
Interval for scanning the network for shares. Value is a number that specifies the network scanning interval in minutes. If the value is smaller or equal to zero the network is not scanned.

Example: \fIinterval\fR = \fI20\fR
.TP
\fBpassword\fR ( [global], [/SERVER], [/SERVER/SHARE] )
Password. Value is string containing the password.

Example: \fIpassword\fR = \fIsecret\fR
.TP
\fBservers\fR ( [ignore] )
Servers to ignore. Value is each server to ignore separated by a comma.

Example: \fIservers\fR = \fISERVER1, SERVER2, SERVER3\fR

.TP
\fBshowhiddenshares\fR ( [global], [/SERVER] )
Show hidden shares. Possible values are: true, false, 1 and 0.

Example: \fIshowhiddenshares\fR = \fIfalse\fR

.TP
\fBtimeout\fR ( [global] )
Connection timeout in seconds. A server after this timeout is considered offline. Values smaller than 2 seconds are ignored.

Example: \fItimeout\fR = \fI10\fR

.TP
\fBusername\fR ( [global], [/SERVER], [/SERVER/SHARE] )
Username. Value is string containing the username.

Example: \fIusername\fR = \fIjohndoe\fR

.TP
\fBworkgroups\fR ( [ignore] )
Workgroups to ignore. Value is each workgroup to ignore separated by a comma.

Example: \fIworkgroups\fR = \fIWORKGROUP1, WORKGROUP2\fR


.SH EXAMPLE
.nf
; Global settings
.B [global]

; Default username and password
username=user
password=totallysecret

; List hidden shares
showhiddenshares=true

; Connection timeout in seconds
timeout = 10

;Interval for updating new shares in minutes
interval = 10

; Section for servers and/or workgroups to ignore
.B [ignore]
servers=SERVER,SERVER2,SERVER3
workgroups=WORKGROUP,WG2

; Share-specific settings
.B [/SERVER/SHARE]
username=john
password=doe

; Server-specific settings
.B [/SERVER]
username=jane
password=doe
showhiddenshares=true
ignore=true
.fi

.SH "SEE ALSO"
.BR fusesmb (1)

.SH AUTHOR
Vincent Wagelaar <vincent@ricardis.tudelft.nl>.