Bug 45833

Summary: nsmb.conf man page
Product: Documentation Reporter: osa <osa>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description osa 2002-11-29 11:50:00 UTC
	nsmb.conf man page

Fix: 

.\" Copyright (c) 2002
.\"	Sergey A. Osokin
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd November 26, 2002
.Dt NSMB.CONF 5
.Os
.Sh NAME
.Nm nsmb.conf
.Nd define remote mount points for
.Tn SMB
mount requests
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
The
.Nm
file contains information about the computers, users and shares
(also knows as remote mount points) for the
.Tn SMB
mount protocol.
.Pp
The file consist from a set of sections. Each section started by section
name surrounded with square brackets:
.Bd -literal -offset indent
[section_name]
.Ed
.Pp
End of the section marked either by new section or by the end of file.
Each section can contain zero or more parameters:
.Bd -literal -offset indent
[section_name]
key=value
.Ed
where 'key' represents parameter name and 'value' a value assigned
to this parameter.
.Pp
.Tn SMB
library uses next forms of section names:
.Bl -tag -width flag
.It Ic A)
[default]
.It Ic B)
[SERVER]
.It Ic C)
[SERVER:USER]
.It Ic D)
[SERVER:USER:SHARE]
.El
.Pp
Here is the map of possible keywords:
.Bl -column keyword/section SIGTERM SIGTERM
.It Sy "keyword/section	A B C D	Comment
.It Cm "addr" Ta Dv - + - - Ta Dv "IP or IPX address of SMB server"
.It Cm "charsets" Ta Dv - + + + Ta Dv "local:remote charset pair"
.It Cm "nbns" Ta Dv +  +  -  - Ta Dv "address of NetBIOS name server (WINS)"
.It Cm "nbscope" Ta Dv +  +  -  - Ta Dv "NetBIOS scope"
.It Cm "nbtimeout" Ta Dv +  +  -  - Ta Dv "timeout for NetBIOS name servers"
.It Cm "password" Ta Dv -  -  +  + Ta Dv "a plain text password used to access to the given share"
.It Cm "retry_count" Ta Dv +  +  -  - Ta Dv "number of retries before connection marked as broken"
.It Cm "timeout" Ta Dv +  +  -  - Ta Dv "SMB request timeout"
.It Cm "workgroup" Ta Dv +  +  +  + Ta Dv "name of workgroup"
.El
.Pp
.Sh FILES
.Bl -tag -width /etc/nsmb.conf -compact
.It Pa /etc/nsmb.conf
the default remote mount-point file
.El
.Sh EXAMPLES
Here is a simple configuration example:
.Bd -literal -offset indent
[default]
workgroup=SALES
# The 'FSERVER' is an NT server.
[FSERVER]
charsets=koi8-r:cp866
addr=fserv.coolcorp.com
.Ed
.Pp
In section "default" we describe our default workgroup (or domain)
SALES, then we make a comment (line that begin with a #), then describe
a server section FSERVER with charset, FSERVER's hostname is
"fserv.coolcorp.com".
.Sh SEE ALSO
.Xr mount_smbfs 8
.Sh AUTHORS
.An This man page written by Sergey Osokin Aq ozz@FreeBSD.org.ru
Comment 1 Peter Pentchev freebsd_committer freebsd_triage 2002-11-29 12:36:34 UTC
Responsible Changed
From-To: freebsd-doc->bp

Over to our smbfs maintainer.
Comment 2 Tom Rhodes freebsd_committer freebsd_triage 2003-01-11 05:04:59 UTC
Responsible Changed
From-To: bp->trhodes

I'm working with bp on this.
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2003-08-09 20:13:24 UTC
State Changed
From-To: open->analyzed

A rewritten version, based on your submission, was committed moments ago. 
Thanks for the submission!
Comment 4 Hiten Pandya freebsd_committer freebsd_triage 2004-12-03 18:53:43 UTC
State Changed
From-To: analyzed->closed

Manual page was committed around 9th August 2003 by the Real Tom Rhodes.