summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJohn Terpstra <jht@samba.org>2000-07-30 06:52:16 +0000
committerJohn Terpstra <jht@samba.org>2000-07-30 06:52:16 +0000
commitc46e6a5961ba4af2ec2381c2ceab88d03335d3f2 (patch)
tree205b47fd707a3131dce888e67ae157b3c5fde947 /docs
parent2e1603868d2d7a647ee302730bd5b58bf997c0be (diff)
downloadsamba-c46e6a5961ba4af2ec2381c2ceab88d03335d3f2.tar.gz
samba-c46e6a5961ba4af2ec2381c2ceab88d03335d3f2.tar.bz2
samba-c46e6a5961ba4af2ec2381c2ceab88d03335d3f2.zip
Adding missing man pages.
(This used to be commit 25091dcf7c194b450e95e2a673423d2d0ad7f272)
Diffstat (limited to 'docs')
-rw-r--r--docs/manpages/make_unicodemap.1100
-rw-r--r--docs/manpages/smbsh.185
2 files changed, 185 insertions, 0 deletions
diff --git a/docs/manpages/make_unicodemap.1 b/docs/manpages/make_unicodemap.1
new file mode 100644
index 0000000000..9319f9ba4e
--- /dev/null
+++ b/docs/manpages/make_unicodemap.1
@@ -0,0 +1,100 @@
+.TH MAKE_UNICODEMAP 1 "26 Apr 2000" "make_unicodemap 2.0.7"
+.PP
+.SH "NAME"
+make_unicodemap \- Construct a unicode map file for Samba
+.PP
+.SH "SYNOPSIS"
+.PP
+\fBmake_unicodemap\fP codepage inputfile outputfile
+.PP
+.SH "DESCRIPTION"
+.PP
+This program is part of the \fBSamba\fP suite\&.
+.PP
+\fBmake_unicodemap\fP compiles text unicode map files into binary unicode
+map files for use with the internationalization features of Samba 2\&.0
+.PP
+.SH "OPTIONS"
+.PP
+.IP
+.IP "codepage"
+This is the codepage or UNIX character set we are processing (a number, e\&.g\&. 850)\&.
+.IP
+.IP "inputfile"
+This is the input file to process\&. This is a text unicode map file
+such as the ones found in the Samba \fIsource/codepages\fP directory\&.
+.IP
+.IP "outputfile"
+This is the binary output file to produce\&.
+.IP
+.PP
+.SH "Samba Unicode Map Files"
+.PP
+A text Samba unicode map file is a description that tells
+Samba how to map characters from a specified DOS code page or UNIX character
+set to 16 bit unicode\&.
+.PP
+A binary Samba unicode map file is a binary representation of
+the same information, including a value that specifies what codepage
+or UNIX character set this file is describing\&.
+.PP
+.SH "FILES"
+.PP
+\fBCP<codepage>\&.TXT\fP
+.PP
+These are the input (text) unicode map files provided in the Samba
+\fIsource/codepages\fP directory\&.
+.PP
+A text unicode map file consists of multiple lines
+containing two fields\&. These fields are :
+.PP
+.IP
+.IP o
+\fBcharacter\fP: which is the (hex) character mapped on this
+line\&.
+.IP
+.IP o
+\fBunicode\fP: which is the (hex) 16 bit unicode character that the
+character will map to\&.
+.IP
+.PP
+\fBunicode_map\&.<codepage>\fP These are the output (binary) unicode map 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_unicodemap\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\&.
diff --git a/docs/manpages/smbsh.1 b/docs/manpages/smbsh.1
new file mode 100644
index 0000000000..44f6b063e3
--- /dev/null
+++ b/docs/manpages/smbsh.1
@@ -0,0 +1,85 @@
+.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