From cb5cc4592c38a709164bb3739f18ae0a3031c5ef Mon Sep 17 00:00:00 2001 From: Bart Van Assche Date: Mon, 16 Jan 2012 10:23:06 +0000 Subject: [PATCH] scstadmin: Document the ISCSID_OPTIONS variable in the /etc/default/scst man page. That variable was added in r4066. git-svn-id: http://svn.code.sf.net/p/scst/svn/trunk@4073 d57e44dd-8a1f-0410-8b47-8ef2f437770f --- scstadmin/scstadmin.sysfs/man5/scst.5 | 32 ++++++++++++++++++++------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/scstadmin/scstadmin.sysfs/man5/scst.5 b/scstadmin/scstadmin.sysfs/man5/scst.5 index 6e50e44d7..f28237310 100644 --- a/scstadmin/scstadmin.sysfs/man5/scst.5 +++ b/scstadmin/scstadmin.sysfs/man5/scst.5 @@ -4,16 +4,25 @@ .\" under the terms of the GNU General Public License, version 2 (GPLv2). .TH scst 5 "July 2011" "scstadmin 2.0.0" .SH NAME -scst \- /etc/init.d/scst configuration file. +/etc/default/scst \- Configuration file read by /etc/init.d/scst. .SH DESCRIPTION /etc/default/scst is a configuration file read by the SCST startup script -/etc/init.d/scst and contains zero or more variables that control the behavior -of that startup script. Currently there is only one such variable, -SCST_TARGET_MODULES, and it only has to be set when using the procfs interface. +/etc/init.d/scst. It contains zero or more variables that control the behavior +of that startup script. The recognized variables are: +.TP +.B ISCSID_OPTIONS +Specifies which command-line options will be passed to iscsi-scstd by the SCST +init script when SCST is started. This variable is ignored if no iSCSI target +entries have been defined in /etc/scst.conf. See also the iscsi-scstd man page +for more information about the supported command-line options. +.TP +.B SCST_TARGET_MODULES +This variable has only to be set when the procfs interface of SCST is being +used instead of the sysfs interface. It defines which target modules should be +loaded by the SCST init script when SCST is started and also which target +modules should be unloaded when SCST is stopped. .P -The format of the -.I scst -file is as follows: +The format of the /etc/default/scst file is as follows: .br - Blank lines and lines starting with a hash sign (#) are ignored. .br @@ -23,6 +32,13 @@ surrounded with double quotes. .P An example: .IP +.br +# iscsi-scstd command-line options. See also man iscsi-scstd. +.br +ISCSID_OPTIONS="-u0 -g0 -p3260" +.br + +.br # When using the procfs interface, the /etc/init.d/scst script .br # cannot derive from /etc/scst.conf which target modules will @@ -35,4 +51,4 @@ SCST_TARGET_MODULES="scst_local iscsi_scst ib_srpt" Configuration file that controls the behavior of some aspects of /etc/init.d/scst. .SH "SEE ALSO" -scstadmin(1), scst.conf(5) +scstadmin(1), scst.conf(5), iscsi-scstd(8)