'\" t
.\"     Title: sys.conf
.\"    Author: Mr. Martin Belanger
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/04/2023
.\"    Manual: sys.conf
.\"    Source: nvme-stas
.\"  Language: English
.\"
.TH "SYS\&.CONF" "5" "" "nvme-stas 2.3-rc5" ""
.\" -----------------------------------------------------------------
.\" * 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"
sys.conf \- \fBnvme-stas\fR(7) configuration file
.SH "SYNOPSIS"
.PP
/etc/stas/sys\&.conf
.SH "DESCRIPTION"
.PP
When
\fBstafd\fR(8)
and
\fBstacd\fR(8)
start up, they read the system configuration from
sys\&.conf\&.
.SH "CONFIGURATION FILE FORMAT"
.PP
sys\&.conf
is a plain text file divided into sections, with configuration entries in the style
\fIkey\fR=\fIvalue\fR\&. Whitespace immediately before or after the
=
is ignored\&. Empty lines and lines starting with
#
are ignored, which may be used for commenting\&.
.SH "OPTIONS"
.SS "[Host] section"
.PP
The following options are available in the
[Host]
section:
.PP
\fInqn=\fR
.RS 4
Takes a string argument identifying the Host NQN\&. A value starting with
file://
indicates that the Host NQN can be retrieved from a separate file\&. This is a mandatory parameter\&. Defaults to:
file:///etc/nvme/hostnqn\&.
.RE
.PP
\fIid=\fR
.RS 4
Takes a string argument identifying the Host ID\&. A value starting with
file://
indicates that the Host ID can be retrieved from a separate file\&. This is a mandatory parameter\&. Defaults to:
file:///etc/nvme/hostid\&.
.RE
.PP
\fIsymname=\fR
.RS 4
Takes a string argument identifying the Host symbolic name\&. A value starting with
file://
indicates that the symbolic name can be retrieved from a separate file\&. This is an optional parameter\&. There is no default value\&.
.RE
.SH "SEE ALSO"
.PP
\fBnvme-stas\fR(7)