aboutsummaryrefslogtreecommitdiff
path: root/net/samba420/files/man/smbstatus.1
diff options
context:
space:
mode:
Diffstat (limited to 'net/samba420/files/man/smbstatus.1')
-rw-r--r--net/samba420/files/man/smbstatus.1186
1 files changed, 186 insertions, 0 deletions
diff --git a/net/samba420/files/man/smbstatus.1 b/net/samba420/files/man/smbstatus.1
new file mode 100644
index 000000000000..334109958047
--- /dev/null
+++ b/net/samba420/files/man/smbstatus.1
@@ -0,0 +1,186 @@
+'\" t
+.\" Title: smbstatus
+.\" Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 08/09/2022
+.\" Manual: User Commands
+.\" Source: Samba 4.16.4
+.\" Language: English
+.\"
+.TH "SMBSTATUS" "1" "08/09/2022" "Samba 4\&.16\&.4" "User Commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+smbstatus \- report on current Samba connections
+.SH "SYNOPSIS"
+.HP \w'\ 'u
+smbstatus [\-p|\-\-processes] [\-v|\-\-verbose] [\-L|\-\-locks] [\-S|\-\-shares] [\-N|\-\-notify] [\-u|\-\-user=STRING] [\-b|\-\-brief] [\-P|\-\-profile] [\-R|\-\-profile\-rates] [\-B|\-\-byterange] [\-n|\-\-numeric] [\-f|\-\-fast] [\-\-resolve\-uids] [\-?|\-\-help] [\-\-usage] [\-d|\-\-debuglevel=DEBUGLEVEL] [\-\-debug\-stdout] [\-\-configfile=CONFIGFILE] [\-\-option=name=value] [\-l|\-\-log\-basename=LOGFILEBASE] [\-\-leak\-report] [\-\-leak\-report\-full]
+.SH "DESCRIPTION"
+.PP
+This tool is part of the
+\fBsamba\fR(7)
+suite\&.
+.PP
+smbstatus
+is a very simple program to list the current Samba connections\&.
+.SH "OPTIONS"
+.PP
+\-P|\-\-profile
+.RS 4
+If samba has been compiled with the profiling option, print only the contents of the profiling shared memory area\&.
+.RE
+.PP
+\-R|\-\-profile\-rates
+.RS 4
+If samba has been compiled with the profiling option, print the contents of the profiling shared memory area and the call rates\&.
+.RE
+.PP
+\-b|\-\-brief
+.RS 4
+gives brief output\&.
+.RE
+.PP
+\-v|\-\-verbose
+.RS 4
+gives verbose output\&.
+.RE
+.PP
+\-L|\-\-locks
+.RS 4
+causes smbstatus to only list locks\&.
+.RE
+.PP
+\-B|\-\-byterange
+.RS 4
+causes smbstatus to include byte range locks\&.
+.RE
+.PP
+\-p|\-\-processes
+.RS 4
+print a list of
+\fBsmbd\fR(8)
+processes and exit\&. Useful for scripting\&.
+.RE
+.PP
+\-S|\-\-shares
+.RS 4
+causes smbstatus to only list shares\&.
+.RE
+.PP
+\-N|\-\-notify
+.RS 4
+causes smbstatus to display registered file notifications
+.RE
+.PP
+\-f|\-\-fast
+.RS 4
+causes smbstatus to not check if the status data is valid by checking if the processes that the status data refer to all still exist\&. This speeds up execution on busy systems and clusters but might display stale data of processes that died without cleaning up properly\&.
+.RE
+.PP
+\-u|\-\-user=<username>
+.RS 4
+selects information relevant to
+\fIusername\fR
+only\&.
+.RE
+.PP
+\-n|\-\-numeric
+.RS 4
+causes smbstatus to display numeric UIDs and GIDs instead of resolving them to names\&.
+.RE
+.PP
+\-?|\-\-help
+.RS 4
+Print a summary of command line options\&.
+.RE
+.PP
+\-\-usage
+.RS 4
+Display brief usage message\&.
+.RE
+.PP
+\-d|\-\-debuglevel=DEBUGLEVEL
+.RS 4
+\fIlevel\fR
+is an integer from 0 to 10\&. The default value if this parameter is not specified is 1 for client applications\&.
+.sp
+The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
+.sp
+Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
+.sp
+Note that specifying this parameter here will override the
+\m[blue]\fBlog level\fR\m[]
+parameter in the
+smb\&.conf
+file\&.
+.RE
+.PP
+\-\-debug\-stdout
+.RS 4
+This will redirect debug output to STDOUT\&. By default all clients are logging to STDERR\&.
+.RE
+.PP
+\-\-configfile=<configuration file>
+.RS 4
+The file specified contains the configuration details required by the client\&. The information in this file can be general for client and server or only provide client specific like options such as
+\m[blue]\fBclient smb encrypt\fR\m[]\&. See
+smb\&.conf
+for more information\&. The default configuration file name is determined at compile time\&.
+.RE
+.PP
+\-\-option=<name>=<value>
+.RS 4
+Set the
+\fBsmb.conf\fR(5)
+option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&. If a name or a value includes a space, wrap whole \-\-option=name=value into quotes\&.
+.RE
+.PP
+\-l|\-\-log\-basename=logdirectory
+.RS 4
+Base directory name for log/debug files\&. The extension
+\fB"\&.progname"\fR
+will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
+.RE
+.PP
+\-\-leak\-report
+.RS 4
+Enable talloc leak reporting on exit\&.
+.RE
+.PP
+\-\-leak\-report\-full
+.RS 4
+Enable full talloc leak reporting on exit\&.
+.RE
+.PP
+\-V|\-\-version
+.RS 4
+Prints the program version number\&.
+.RE
+.SH "VERSION"
+.PP
+This man page is part of version 4\&.16\&.4 of the Samba suite\&.
+.SH "SEE ALSO"
+.PP
+\fBsmbd\fR(8)
+and
+\fBsmb.conf\fR(5)\&.
+.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\&.