summaryrefslogtreecommitdiff
path: root/docs/manpages
diff options
context:
space:
mode:
authorGerald Carter <jerry@samba.org>2001-02-22 21:48:19 +0000
committerGerald Carter <jerry@samba.org>2001-02-22 21:48:19 +0000
commitcbf0f980c9cbc6ae3fd067c506e8062c4399d7b0 (patch)
tree089b85019d3266b7360d2563904e3aae6e3122c9 /docs/manpages
parent4bca9fd8d4c57c9bcd36c8ed9924a866540ddd65 (diff)
downloadsamba-cbf0f980c9cbc6ae3fd067c506e8062c4399d7b0.tar.gz
samba-cbf0f980c9cbc6ae3fd067c506e8062c4399d7b0.tar.bz2
samba-cbf0f980c9cbc6ae3fd067c506e8062c4399d7b0.zip
save as we go. More pages done.
(This used to be commit ec1dfb80b39f816faed702ace20a385aba9caf6b)
Diffstat (limited to 'docs/manpages')
-rw-r--r--docs/manpages/make_smbcodepage.1284
-rw-r--r--docs/manpages/smbsh.1157
2 files changed, 212 insertions, 229 deletions
diff --git a/docs/manpages/make_smbcodepage.1 b/docs/manpages/make_smbcodepage.1
index e6c76d9855..502f9a5909 100644
--- a/docs/manpages/make_smbcodepage.1
+++ b/docs/manpages/make_smbcodepage.1
@@ -1,144 +1,140 @@
-.TH "make_smbcodepage " "1" "23 Oct 1998" "Samba" "SAMBA"
-.PP
-.SH "NAME"
-make_codepage \- Construct a codepage file for Samba
-.PP
-.SH "SYNOPSIS"
-.PP
-\fBmake_smbcodepage\fP [c|d] codepage inputfile outputfile
-.PP
-.SH "DESCRIPTION"
-.PP
-This program is part of the \fBSamba\fP suite\&.
-.PP
-\fBmake_smbcodepage\fP compiles or de-compiles codepage files for use
-with the internationalization features of Samba 2\&.0
-.PP
-.SH "OPTIONS"
-.PP
-.IP
-.IP "c|d"
-This tells \fBmake_smbcodepage\fP if it is compiling (\fBc\fP) a text
-format code page file to binary, or (\fBd\fP) de-compiling a binary codepage
-file to text\&.
-.IP
-.IP "codepage"
-This is the codepage we are processing (a number, e\&.g\&. 850)\&.
-.IP
-.IP "inputfile"
-This is the input file to process\&. In the \'\fBc\fP\' case this
-will be a text codepage definition file such as the ones found in the
-Samba \fIsource/codepages\fP directory\&. In the \'\fBd\fP\' case this will be the
-binary format codepage definition file normally found in the
-\fIlib/codepages\fP directory in the Samba install directory path\&.
-.IP
-.IP "outputfile"
-This is the output file to produce\&.
-.IP
-.PP
-.SH "Samba Codepage Files"
-.PP
-A text Samba codepage definition file is a description that tells
-Samba how to map from upper to lower case for characters greater than
-ascii 127 in the specified DOS code page\&. Note that for certain DOS
-codepages (437 for example) mapping from lower to upper case may be
-non-symmetrical\&. For example, in code page 437 lower case a acute maps to
-a plain upper case A when going from lower to upper case, but
-plain upper case A maps to plain lower case a when lower casing a
-character\&.
-.PP
-A binary Samba codepage definition file is a binary representation of
-the same information, including a value that specifies what codepage
-this file is describing\&.
-.PP
-As Samba does not yet use UNICODE (current for Samba version 2\&.0) you
-must specify the client code page that your DOS and Windows clients
-are using if you wish to have case insensitivity done correctly for
-your particular language\&. The default codepage Samba uses is 850
-(Western European)\&. Text codepage definition sample files are
-provided in the Samba distribution for codepages 437 (USA), 737
-(Greek), 850 (Western European) 852 (MS-DOS Latin 2), 861 (Icelandic),
-866 (Cyrillic), 932 (Kanji SJIS), 936 (Simplified Chinese), 949
-(Hangul) and 950 (Traditional Chinese)\&. Users are encouraged to write
-text codepage definition files for their own code pages and donate
-them to samba@samba\&.org\&. All codepage files in the
-Samba \fIsource/codepages\fP directory are compiled and installed when a
-\fI\'make install\'\fP command is issued there\&.
-.PP
-The client codepage used by the \fBsmbd\fP server is
-configured using the \fBclient code
-page\fP parameter in the
-\fBsmb\&.conf\fP file\&.
-.PP
-.SH "FILES"
-.PP
-\fBcodepage_def\&.<codepage>\fP
-.PP
-These are the input (text) codepage files provided in the Samba
-\fIsource/codepages\fP directory\&.
-.PP
-A text codepage definition file consists of multiple lines
-containing four fields\&. These fields are :
-.PP
-.IP
-.IP o
-\fBlower\fP: which is the (hex) lower case character mapped on this
-line\&.
-.IP
-.IP o
-\fBupper\fP: which is the (hex) upper case character that the lower
-case character will map to\&.
-.IP
-.IP o
-\fBmap upper to lower\fP which is a boolean value (put either True
-or False here) which tells Samba if it is to map the given upper case
-character to the given lower case character when lower casing a
-filename\&.
-.IP
-.IP o
-\fBmap lower to upper\fP which is a boolean value (put either True
-or False here) which tells Samba if it is to map the given lower case
-character to the given upper case character when upper casing a
-filename\&.
-.IP
-.PP
-\fBcodepage\&.<codepage>\fP These are the output (binary) codepage files
-produced and placed in the Samba destination \fIlib/codepage\fP
-directory\&.
-.PP
-.SH "INSTALLATION"
-.PP
-The location of the server and its support files is a matter for
-individual system administrators\&. The following are thus suggestions
-only\&.
-.PP
-It is recommended that the \fBmake_smbcodepage\fP program be installed
-under the \fI/usr/local/samba\fP hierarchy, in a directory readable by
-all, writeable only by root\&. The program itself should be executable
-by all\&. The program should NOT be setuid or setgid!
-.PP
-.SH "VERSION"
-.PP
-This man page is correct for version 2\&.0 of the Samba suite\&.
-.PP
-.SH "SEE ALSO"
-.PP
-\fBsmb\&.conf(5)\fP, \fBsmbd (8)\fP
-.PP
-.SH "AUTHOR"
-.PP
-The original Samba software and related utilities were created by
-Andrew Tridgell samba@samba\&.org\&. Samba is now developed
-by the Samba Team as an Open Source project similar to the way the
-Linux kernel is developed\&.
-.PP
-The original Samba man pages were written by Karl Auer\&. The man page
-sources were converted to YODL format (another excellent piece of Open
-Source software, available at
-\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
-and updated for the Samba2\&.0 release by Jeremy Allison\&.
-samba@samba\&.org\&.
-.PP
-See \fBsamba (7)\fP to find out how to get a full
-list of contributors and details on how to submit bug reports,
-comments etc\&.
+.\" This manpage has been automatically generated by docbook2man-spec
+.\" from a DocBook document. docbook2man-spec can be found at:
+.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
+.\" Please send any bug reports, improvements, comments, patches,
+.\" etc. to Steve Cheng <steve@ggi-project.org>.
+.TH "MAKE_SMBCODEPAGE" "1" "22 February 2001" "" ""
+.SH NAME
+make_smbcodepage \- construct a codepage file for Samba
+.SH SYNOPSIS
+.sp
+\fBmake_smbcodepage\fR \fBc|d\fR \fBcodepage\fR \fBinputfile\fR \fBoutputfile\fR
+.SH "DESCRIPTION"
+.PP
+This tool is part of the Samba <URL:samba.7.html> suite.
+.PP
+\fBmake_smbcodepage\fR compiles or de-compiles
+codepage files for use with the internationalization features
+of Samba 2.2
+.SH "OPTIONS"
+.TP
+\fBc|d\fR
+This tells \fBmake_smbcodepage\fR
+if it is compiling (\fIc\fR) a text format code
+page file to binary, or (\fId\fR) de-compiling
+a binary codepage file to text.
+.TP
+\fBcodepage\fR
+This is the codepage we are processing (a
+number, e.g. 850).
+.TP
+\fBinputfile\fR
+This is the input file to process. In t
+he '\fIc\fR' case this will be a text
+codepage definition file such as the ones found in the Samba
+\fIsource/codepages\fR directory. In
+the '\fId\fR' case this will be the
+binary format codepage definition file normally found in
+the \fIlib/codepages\fR directory in the
+Samba install directory path.
+.TP
+\fBoutputfile\fR
+This is the output file to produce.
+.SH "SAMBA CODEPAGE FILES"
+.PP
+A text Samba codepage definition file is a description
+that tells Samba how to map from upper to lower case for
+characters greater than ascii 127 in the specified DOS code page.
+Note that for certain DOS codepages (437 for example) mapping
+from lower to upper case may be non-symmetrical. For example, in
+code page 437 lower case a acute maps to a plain upper case A
+when going from lower to upper case, but plain upper case A maps
+to plain lower case a when lower casing a character.
+.PP
+A binary Samba codepage definition file is a binary
+representation of the same information, including a value that
+specifies what codepage this file is describing.
+.PP
+As Samba does not yet use UNICODE (current for Samba version 2.2)
+you must specify the client code page that your DOS and Windows
+clients are using if you wish to have case insensitivity done
+correctly for your particular language. The default codepage Samba
+uses is 850 (Western European). Text codepage definition sample files
+are provided in the Samba distribution for codepages 437 (USA), 737 (Greek),
+850 (Western European) 852 (MS-DOS Latin 2), 861 (Icelandic), 866 (Cyrillic),
+932 (Kanji SJIS), 936 (Simplified Chinese), 949 (Hangul) and 950 (Traditional
+Chinese). Users are encouraged to write text codepage definition files for
+their own code pages and donate them to samba@samba.org. All codepage files
+in the Samba \fIsource/codepages\fR directory are
+compiled and installed when a \fB'make install'\fR
+command is issued there.
+.PP
+The client codepage used by the \fBsmbd\fR server
+is configured using the \fBclient code page\fR parameter
+in the \fBsmb.conf\fR file.
+.SH "FILES"
+.PP
+\fBcodepage_def.<codepage>\fR
+.PP
+These are the input (text) codepage files provided in the
+Samba \fIsource/codepages\fR directory.
+.PP
+A text codepage definition file consists of multiple lines
+containing four fields. These fields are:
+.TP 0.2i
+\(bu
+\fBlower\fR: which is the
+(hex) lower case character mapped on this line.
+.TP 0.2i
+\(bu
+\fBupper\fR: which is the (hex)
+upper case character that the lower case character will map to.
+.TP 0.2i
+\(bu
+\fBmap upper to lower\fR which
+is a boolean value (put either True or False here) which tells
+Samba if it is to map the given upper case character to the
+given lower case character when lower casing a filename.
+.TP 0.2i
+\(bu
+\fBmap lower to upper\fR which
+is a boolean value (put either True or False here) which tells
+Samba if it is to map the given lower case character to the
+given upper case character when upper casing a filename.
+.PP
+\fBcodepage.<codepage>\fR - These are the
+output (binary) codepage files produced and placed in the Samba
+destination \fIlib/codepage\fR directory.
+.PP
+.SH "INSTALLATION"
+.PP
+The location of the server and its support files is a
+matter for individual system administrators. The following are
+thus suggestions only.
+.PP
+It is recommended that the \fBmake_smbcodepage
+\fRprogram be installed under the \fI/usr/local/samba
+\fRhierarchy, in a directory readable by all, writeable
+only by root. The program itself should be executable by all. The
+program should NOT be setuid or setgid!
+.SH "VERSION"
+.PP
+This man page is correct for version 2.2 of
+the Samba suite.
+.SH "SEE ALSO"
+.PP
+\fBsmbd(8)\fR <URL:smbd.8.html>,
+smb.conf(5) <URL:smb.conf.5.html>
+.SH "AUTHOR"
+.PP
+The original Samba software and related utilities
+were created by Andrew Tridgell. Samba is now developed
+by the Samba Team as an Open Source project similar
+to the way the Linux kernel is developed.
+.PP
+The original Samba man pages were written by Karl Auer.
+The man page sources were converted to YODL format (another
+excellent piece of Open Source software, available at
+ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
+release by Jeremy Allison. The conversion to DocBook for
+Samba 2.2 was done by Gerald Carter
diff --git a/docs/manpages/smbsh.1 b/docs/manpages/smbsh.1
index 44f6b063e3..66bc4d97b8 100644
--- a/docs/manpages/smbsh.1
+++ b/docs/manpages/smbsh.1
@@ -1,85 +1,72 @@
-.TH SMBSH 1 "26 Apr 2000" "smbsh 2.0.7"
-.PP
-.SH "NAME"
-smbsh \- Allows access to Windows NT filesystem using UNIX commands
-.PP
-.SH "SYNOPSIS"
-.PP
-\fBsmbsh\fP
-.PP
-.SH "DESCRIPTION"
-.PP
-This program is part of the \fBSamba\fP suite\&.
-.PP
-\fBsmbsh\fP allows you to access an NT filesystem using UNIX commands
-such as \fBls\fP, \fBegrep\fP, and \fBrcp\fP\&. You must use a shell that
-is dynmanically linked in order for \fBsmbsh\fP to work correctly\&.
-.PP
-To use the \fBsmbsh\fP command, execute \fBsmbsh\fP from the prompt and
-enter the username and password that authenticate you to the
-machine running the Windows NT operating system\&.
-.PP
-
-.DS
-
-
-system% smbsh
-Username: user
-Password:
-
-.DE
-
-
-.PP
-Any dynamically linked command you execute from this shell will
-access the \fB/smb\fP directory using the smb protocol\&.
-For example, the command
-.PP
-\f(CWls /smb\fP
-.PP
-will show all the machines in your workgroup\&.
-The command
-.PP
-\f(CWls /smb/<machine-name>\fP
-.PP
-will show the share names for that machine\&. You could then, for example, use the
-\fBcd\fP command to change directories, \fBvi\fP to edit files, and \fBrcp\fP
-to copy files\&.
-.PP
-.SH "VERSION"
-.PP
-This man page is correct for the 2\&.0\&.3 of the Samba suite\&.
-.PP
-.SH "BUGS"
-.PP
-\fBsmbsh\fP works by intercepting the standard libc calls with the dynamically loaded
-versions in \fBsmbwrapper\&.o\fP\&. Not all calls have been "wrapped" so some programs
-may not function correctly under \fBsmbsh\fP\&.
-.PP
-Programs which are not dynamically linked cannot make use of \fBsmbsh\fP\'s
-functionality\&. Most versions of UNIX have a \fBfile\fP command that will describe how
-a program was linked\&.
-.PP
-.SH "SEE ALSO"
-.PP
-\fBsmb\&.conf (5)\fP,
-\fBsmbd (8)\fP\&.
-.PP
-.SH "AUTHOR"
-.PP
-The original Samba software and related utilities were created by
-Andrew Tridgell (samba@samba\&.org)\&. Samba is now developed
-by the Samba Team as an Open Source project similar to the way the
-Linux kernel is developed\&.
-.PP
-The original Samba man pages were written by Karl Auer\&. The man page
-sources were converted to YODL format (another excellent piece of Open
-Source software, available at
-\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
-and updated for the Samba2\&.0 release by Jeremy Allison\&.
-samba@samba\&.org\&.
-.PP
-See \fBsamba (7)\fP to find out how to get a full
-list of contributors and details on how to submit bug reports,
-comments etc\&.
-.PP
+.\" This manpage has been automatically generated by docbook2man-spec
+.\" from a DocBook document. docbook2man-spec can be found at:
+.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
+.\" Please send any bug reports, improvements, comments, patches,
+.\" etc. to Steve Cheng <steve@ggi-project.org>.
+.TH "SMBSH" "1" "22 February 2001" "" ""
+.SH NAME
+smbsh \- Allows access to Windows NT filesystem using UNIX commands
+.SH SYNOPSIS
+.sp
+\fBsmbsh\fR
+.SH "DESCRIPTION"
+.PP
+This tool is part of the Samba <URL:samba.7.html> suite.
+.PP
+\fBsmbsh\fR allows you to access an NT filesystem
+using UNIX commands such as \fBls\fR, \fB egrep\fR, and \fBrcp\fR. You must use a
+shell that is dynmanically linked in order for \fBsmbsh\fR
+to work correctly.
+.PP
+To use the \fBsmbsh\fR command, execute \fB smbsh\fR from the prompt and enter the username and password
+that authenticate you to the machine running the Windows NT
+operating system.
+.PP
+.sp
+.nf
+ system% \fBsmbsh\fR
+ Username: \fBuser\fR
+ Password: \fBXXXXXXX\fR
+
+.sp
+.fi
+.PP
+Any dynamically linked command you execute from
+this shell will access the \fI/smb\fR directory
+using the smb protocol. For example, the command \fBls /smb
+\fRwill show all the machines in your workgroup. The command
+\fBls /smb/<machine-name>\fR will show the share
+names for that machine. You could then, for example, use the \fB cd\fR command to change directories, \fBvi\fR to
+edit files, and \fBrcp\fR to copy files.
+.SH "VERSION"
+.PP
+This man page is correct for version 2.2 of
+the Samba suite.
+.SH "BUGS"
+.PP
+\fBsmbsh\fR works by intercepting the standard
+libc calls with the dynamically loaded versions in \fI smbwrapper.o\fR. Not all calls have been "wrapped", so
+some programs may not function correctly under \fBsmbsh
+\fR\&.
+.PP
+Programs which are not dynamically linked cannot make
+use of \fBsmbsh\fR's functionality. Most versions
+of UNIX have a \fBfile\fR command that will
+describe how a program was linked.
+.SH "SEE ALSO"
+.PP
+\fBsmbd(8)\fR <URL:smbd.8.html>,
+smb.conf(5) <URL:smb.conf.5.html>
+.SH "AUTHOR"
+.PP
+The original Samba software and related utilities
+were created by Andrew Tridgell. Samba is now developed
+by the Samba Team as an Open Source project similar
+to the way the Linux kernel is developed.
+.PP
+The original Samba man pages were written by Karl Auer.
+The man page sources were converted to YODL format (another
+excellent piece of Open Source software, available at
+ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
+release by Jeremy Allison. The conversion to DocBook for
+Samba 2.2 was done by Gerald Carter