.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "SREVIEW-CONFIG 1p"
.TH SREVIEW-CONFIG 1p "2018-01-01" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
sreview\-config \- manage the SReview configuration
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
sreview-config \-\-help|\-\-config\-file=FILE|\-\-action=ACTION|\-\-set=KEY|VALUE
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
sreview-config is used to manage the SReview configuration from the
command line. It takes up to two options: the current configuration file
to read defaults from, and the action to perform on that configuration
file.
.PP
It can be used on upgrade of SReview to a newer version, to initialize the
configuration with working settings, or to initialize the database.
.SH "OPTIONS"
.IX Header "OPTIONS"
.SS "\fB\-\-help\fP"
.IX Subsection "--help"
Produce help output.
.SS "\fB\-\-config\-file\fP=FILE"
.IX Subsection "--config-file=FILE"
Use \f(CW\*(C`FILE\*(C'\fR as the configuration file to read defaults from. If this
parameter is not specified, then sreview-config will try the file
\&\f(CW\*(C`config.pm\*(C'\fR in the directory pointed to by the \f(CW\*(C`SREVIEW_WDIR\*(C'\fR
environment variable, followed by \f(CW\*(C`/etc/sreview/config.pm\*(C'\fR, and then
fall back on the builtin defaults.
.SS "\fB\-\-set\fP=KEY=VALUE"
.IX Subsection "--set=KEY=VALUE"
After reading the selected config file (see \f(CW\*(C`\-\-config\-file\*(C'\fR) and before
performing the requested action, set the value of configuration setting
\&\f(CW\*(C`KEY\*(C'\fR to \f(CW\*(C`VALUE\*(C'\fR.
.PP
This option can be repeated multiple times as needed.
.SS "\fB\-\-action\fP=ACTION"
.IX Subsection "--action=ACTION"
Perform \s-1ACTION,\s0 which can be one of:
.PP
\fIdump\fR
.IX Subsection "dump"
.PP
Write the current configuration to standard output. \fBNote\fR: Do \fInot\fR
redirect the output of this command to the active configuration file,
since that will overwrite the active configuration file with empty data
before it is read by \f(CW\*(C`sreview\-config\*(C'\fR, which will not work. See
\&\f(CW\*(C`update\*(C'\fR for that.
.PP
\fIinitdb\fR
.IX Subsection "initdb"
.PP
Read the configuration file, then initialize the database that is
configured.
.PP
Note that this action is not strictly necessary; sreview-web will
implicitly initialize and upgrade the database to the latest version at
startup.
.PP
\fIupdate\fR
.IX Subsection "update"
.PP
Read the configuration file, then rewrite it with new settings that are
not found in the current configuration file, as well as incorporating
configuration settings that were set with \f(CW\*(C`\-\-set\*(C'\fR.
.PP
This is useful on upgrade of SReview, so that new configuration
options can be added to the configuration file without loss of old
options. It can also be used as a way to configure \f(CW\*(C`sreview\*(C'\fR.