Update manpage

PiSCSI · Oct 6, 2023 · 70dcb4d · 70dcb4d
1 parent 5cc5abe
commit 70dcb4d
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 25 deletions.
diff --git a/doc/scsictl.1 b/doc/scsictl.1
@@ -7,7 +7,6 @@ scsictl \- Sends management commands to the piscsi process
 \fB\-l\fR |
 \fB\-m\fR |
 \fB\-o\fR |
-\fB\-s\fR |
 \fB\-v\fR |
 \fB\-D\fR |
 \fB\-I\fR |
@@ -18,28 +17,29 @@ scsictl \- Sends management commands to the piscsi process
 \fB\-T\fR |
 \fB\-V\fR |
 \fB\-X\fR |
-[\fB\-C\fR \fIFILENAME:FILESIZE\fR]
-[\fB\-E\fR \fIFILENAME\fR]
-[\fB\-F\fR \fIIMAGE_FOLDER\fR]
-[\fB\-R\fR \fICURRENT_NAME:NEW_NAME\fR]
-[\fB\-c\fR \fICMD\fR]
-[\fB\-f\fR \fIFILE|PARAM\fR]
-[\fB\-g\fR \fILOG_LEVEL\fR]
-[\fB\-h\fR \fIHOST\fR]
-[\fB\-i\fR \fIID[:LUN]\fR
-[\fB\-n\fR \fINAME\fR]
-[\fB\-p\fR \fIPORT\fR]
-[\fB\-r\fR \fIRESERVED_IDS\fR]
-[\fB\-t\fR \fITYPE\fR]
-[\fB\-x\fR \fICURRENT_NAME:NEW_NAME\fR]
+[\fB\-C\fR \fIFILENAME:FILESIZE\fR] |
+[\fB\-E\fR \fIFILENAME\fR] |
+[\fB\-F\fR \fIIMAGE_FOLDER\fR] |
+[\fB\-R\fR \fICURRENT_NAME:NEW_NAME\fR] |
+[\fB\-c\fR \fICMD\fR] |
+[\fB\-f\fR \fIFILE|PARAM\fR] |
+[\fB\-g\fR \fILOG_LEVEL\fR] |
+[\fB\-h\fR \fIHOST\fR] |
+[\fB\-i\fR \fIID[:LUN]\fR] |
+[\fB\-n\fR \fINAME\fR] |
+[\fB\-p\fR \fIPORT\fR] |
+[\fB\-r\fR \fIRESERVED_IDS\fR] |
+[\fB\-s\fR \fI[FOLDER_PATTERN:FILE_PATTERN:OPERATIONS]\fR] |
+[\fB\-t\fR \fITYPE\fR] |
+[\fB\-x\fR \fICURRENT_NAME:NEW_NAME\fR] |
 [\fB\-z\fR \fILOCALE\fR]
 .SH DESCRIPTION
 .B scsictl
 sends commands to the piscsi process to make configuration adjustments at runtime or to check the status of the devices.
 
 Either the -i or -l option should be specified at one time. Not both. 
 
-You do NOT need root privileges to use scsictl.
+You do NOT need root privileges to use scsictl. scsictl also runs on non-Pi Linux platforms.
 
 Note: The command and type arguments are case insensitive. Only the first letter of the command/type is evaluated by the tool.
 
@@ -96,7 +96,7 @@ The piscsi port to connect to, default is 6868.
 .BR \-r\fI " " \fIRESERVED_IDS
 Comma-separated list of IDs to reserve. Pass an empty list in order to not reserve anything.
 .TP
-.BR \-s\fI
+.BR \-s\fI " " \fI[FOLDER_PATTERN:FILE_PATTERN:OPERATIONS]
 Display server-side settings like available images or supported device types.
 .TP
 .BR \-S\fI

diff --git a/doc/scsictl_man_page.txt b/doc/scsictl_man_page.txt
@@ -6,19 +6,21 @@ NAME
        scsictl - Sends management commands to the piscsi process
 
 SYNOPSIS
-       scsictl  -e | -l | -m | -o | -s | -v | -D | -I | -L | -O | -P | -S | -T
-       | -V | -X | [-C FILENAME:FILESIZE] [-E FILENAME] [-F IMAGE_FOLDER]  [-R
-       CURRENT_NAME:NEW_NAME]  [-c  CMD]  [-f  FILE|PARAM]  [-g LOG_LEVEL] [-h
-       HOST] [-i ID[:LUN] [-n NAME] [-p PORT] [-r RESERVED_IDS] [-t TYPE]  [-x
-       CURRENT_NAME:NEW_NAME] [-z LOCALE]
+       scsictl  -e | -l | -m | -o | -v | -D | -I | -L | -O | -P | -S | -T | -V
+       | -X | [-C FILENAME:FILESIZE] | [-E FILENAME] | [-F IMAGE_FOLDER] | [-R
+       CURRENT_NAME:NEW_NAME]  | [-c CMD] | [-f FILE|PARAM] | [-g LOG_LEVEL] |
+       [-h HOST] | [-i ID[:LUN]] | [-n NAME] | [-p PORT] | [-r RESERVED_IDS] |
+       [-s  [FOLDER_PATTERN:FILE_PATTERN:OPERATIONS]]  |  [-t TYPE] | [-x CUR‐
+       RENT_NAME:NEW_NAME] | [-z LOCALE]
 
 DESCRIPTION
-       scsictl  sends commands to the piscsi process to make configuration ad‐
+       scsictl sends commands to the piscsi process to make configuration  ad‐
        justments at runtime or to check the status of the devices.
 
        Either the -i or -l option should be specified at one time. Not both.
 
-       You do NOT need root privileges to use scsictl.
+       You  do  NOT  need root privileges to use scsictl. scsictl also runs on
+       non-Pi Linux platforms.
 
        Note: The command and type arguments are  case  insensitive.  Only  the
        first letter of the command/type is evaluated by the tool.
@@ -74,7 +76,8 @@ OPTIONS
               Comma-separated list of IDs to reserve. Pass an  empty  list  in
               order to not reserve anything.
 
-       -s     Display  server-side settings like available images or supported
+       -s [FOLDER_PATTERN:FILE_PATTERN:OPERATIONS]
+              Display  server-side settings like available images or supported
               device types.
 
        -S     Display statistics.