From 2c01353475ee3d0415d12a4ad92406c780f6699f Mon Sep 17 00:00:00 2001 From: Herb Lewis Date: Fri, 29 Sep 2000 19:50:57 +0000 Subject: new man pages (This used to be commit 8a7d6c8e91ecd57f2693be7d697d8231c8d339a4) --- docs/manpages/findsmb.1 | 95 ++++++++++++++++++++++++++++++++++++++++++++++ docs/manpages/smbcontrol.1 | 80 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 175 insertions(+) create mode 100644 docs/manpages/findsmb.1 create mode 100644 docs/manpages/smbcontrol.1 (limited to 'docs/manpages') diff --git a/docs/manpages/findsmb.1 b/docs/manpages/findsmb.1 new file mode 100644 index 0000000000..708fea6378 --- /dev/null +++ b/docs/manpages/findsmb.1 @@ -0,0 +1,95 @@ +.TH "findsmb " "1" "2 May 2000" "Samba" "SAMBA" +.PP +.SH "NAME" +findsmb \- list info about machines that respond to SMB name queries on a subnet +.PP +.SH "SYNOPSIS" +.PP +\fBfindsmb\fP [subnet broadcast address] +.PP +.SH "DESCRIPTION" +.PP +This perl script is part of the \fBSamba\fP suite\&. +.PP +\fBfindsmb\fP is a perl script that prints out several pieces +of information about machines on a subnet that respond to SMB +name query requests\&. +It uses \fBnmblookup\fP and +\fBsmbclient\fP to obtain this information\&. +.PP +.SH "OPTIONS" +.PP +.IP +.IP "\fBsubnet broadcast address\fP" +Without this option, \fBfindsmb\fP +will probe the subnet of the machine where \fBfindsmb\fP is run\&. +This value is passed to \fBnmblookup\fP as part of the \fB-B\fP +option +.IP +.PP +.SH "EXAMPLES" +.PP +The output of \fBfindsmb\fP lists the following information for all +machines that respond to the initial \fBnmblookup\fP for any name: +IP address, NetBIOS name, Workgroup name, operating system, and +SMB server version\&. +.PP +There will be a "+" in front of the workgroup name for machines that are +local master browsers for that workgroup\&. There will be an "*" in front +of the workgroup name for machines that are the domain master browser for +that workgroup\&. Machines that are running Windows, Windows 95 or Windows 98 +will not show any information about the operating system or server version\&. +.PP +The command must be run on a system without +\fBnmbd\fP running\&. If \fBnmbd\fP is running on the system, you will only +get the IP address and the DNS name of the machine\&. To get proper responses +from Windows 95 and Windows 98 machines, the command must be run as root\&. +.PP +For example running: +.PP +\f(CWfindsmb\fP +.PP +on a machine without \fBnmbd\fP running would yield output similar +to the following +.PP + +.DS + + +IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION +--------------------------------------------------------------------- +192\&.168\&.35\&.10 MINESET-TEST1 [DMVENGR] +192\&.168\&.35\&.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2\&.0\&.6] +192\&.168\&.35\&.56 HERBNT2 [HERB-NT] +192\&.168\&.35\&.63 GANDALF [MVENGR] [Unix] [Samba 2\&.0\&.5a for IRIX] +192\&.168\&.35\&.65 SAUNA [WORKGROUP] [Unix] [Samba 1\&.9\&.18p10] +192\&.168\&.35\&.71 FROGSTAR [ENGR] [Unix] [Samba 2\&.0\&.0 for IRIX] +192\&.168\&.35\&.78 HERBDHCP1 +[HERB] +192\&.168\&.35\&.88 SCNT2 +[MVENGR] [Windows NT 4\&.0] [NT LAN Manager 4\&.0] +192\&.168\&.35\&.93 FROGSTAR-PC [MVENGR] [Windows 5\&.0] [Windows 2000 LAN Manager] +192\&.168\&.35\&.97 HERBNT1 *[HERB-NT] [Windows NT 4\&.0] [NT LAN Manager 4\&.0] + +.DE + + +.PP +.SH "VERSION" +.PP +This man page is correct for version 2\&.0 of the Samba suite\&. +.PP +.SH "SEE ALSO" +.PP +\fBnmblookup (1)\fP, \fBsmbclient (1)\fP +.PP +.SH "AUTHOR" +.PP +This perl script was developed by Herb Lewis of SGI\&. +.PP +The original Samba software and related utilities were created by +Andrew Tridgell \fIsamba@samba\&.org\fP\&. Samba is now developed +by the Samba Team as an Open Source project similar to the way the +Linux kernel is developed\&. +.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/smbcontrol.1 b/docs/manpages/smbcontrol.1 new file mode 100644 index 0000000000..9a6dd16abf --- /dev/null +++ b/docs/manpages/smbcontrol.1 @@ -0,0 +1,80 @@ +.TH "smbcontrol " "1" "29 Sep 2000" "Samba" "SAMBA" +.PP +.SH "NAME" +smbcontrol \- send messages to smbd or nmbd processes +.PP +.SH "SYNOPSIS" +.PP +\fBsmbcontrol\fP -i +.PP +\fBsmbcontrol\fP destination message-type parameters +.PP +.SH "DESCRIPTION" +.PP +This program is part of the \fBSamba\fP suite\&. +.PP +\fBsmbcontrol\fP is a very small program, which sends messages to a \fBsmbd\fP +or a \fBnmbd\fP daemon running on the system\&. +.PP +.SH "OPTIONS" +.PP +.IP +.IP "\fB-i\fP" +Run interactively\&. Individual commands of the form +destination message-type parameters +can be entered on STDIN\&. An empty command line will quit the program\&. +.IP +.IP "\fBdestination\fP" +is one of "nmbd", "smbd" or a process ID +.IP +The \fBsmbd\fP destination causes the message to be "broadcast" to all +smbd daemons\&. +.IP +The \fBnmbd\fP destination causes the message to be sent to the nmbd +daemon specified in the \fBnmbd\&.pid\fP file\&. +.IP +If a single process ID is given, the message is sent to only that +process\&. +.IP +.IP "\fBmessage-type\fP" +is one of: debug, force-election, or ping\&. +.IP +The \fBdebug\fP message-type allows the debug level to be set to the value +specified by the parameter\&. This can be sent to any of the destinations\&. +.IP +The \fBforce-election\fP message-type can only be sent to the \fBnmbd\fP +destination\&. This message causes the \fBnmbd\fP daemon to force a +new browse master election\&. +.IP +The \fBping\fP message-type sends the number of "ping" messages specified +by the parameter and waits for the same number of +reply "pong" messages\&. This can be sent to any of the destinations\&. +.IP +.IP "\fBparameters\fP" +is any parameters required for the message-type +.IP +.PP +.SH "VERSION" +.PP +This man page is correct for version 2\&.2\&.0 of the Samba suite\&. +.PP +.SH "SEE ALSO" +.PP +\fBsmbd (8)\fP, \fBnmbd (8)\fP +.PP +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by +Andrew Tridgell \fIsamba@samba\&.org\fP\&. Samba is now developed +by the Samba Team as an Open Source project similar to the way the +Linux kernel is developed\&. +.PP +This man page source was written in YODL format (another excellent piece of Open +Source software, available at +\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP) +for the Samba 2\&.2\&.0 release by Herb Lewis\&. +\fIsamba@samba\&.org\fP\&. +.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\&. -- cgit