mirror of
https://github.com/valitydev/salt.git
synced 2024-11-09 01:36:48 +00:00
144 lines
3.5 KiB
Groff
144 lines
3.5 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "SPM" "1" "October 31, 2016" "2016.11.0" "Salt"
|
|
.SH NAME
|
|
spm \- Salt Package Manager Command
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.sp
|
|
Salt Package Manager
|
|
.SH SYNOPSIS
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
spm <command> [<argument>]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH DESCRIPTION
|
|
.sp
|
|
spm is the frontend command for managing Salt packages. Packages normally only
|
|
include formulas, meaning a group of SLS files that install into the
|
|
\fBfile_roots\fP on the Salt Master, but Salt modules can also be installed.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-y, \-\-assume\-yes
|
|
Assume \fByes\fP instead of prompting the other whether or not to proceed
|
|
with a particular command. Default is False.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-f, \-\-force
|
|
When presented with a course of action that spm would normally refuse to
|
|
perform, that action will be performed anyway. This is often destructive,
|
|
and should be used with caution.
|
|
.UNINDENT
|
|
.SS Logging Options
|
|
.sp
|
|
Logging options which override any settings defined on the configuration files.
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
|
|
Console logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
|
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
|
|
\fBwarning\fP\&.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-log\-file=LOG_FILE
|
|
Log file path. Default: /var/log/salt/spm\&.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-log\-file\-level=LOG_LEVEL_LOGFILE
|
|
Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
|
\fBdebug\fP, \fBinfo\fP, \fBwarning\fP, \fBerror\fP, \fBquiet\fP\&. Default:
|
|
\fBwarning\fP\&.
|
|
.UNINDENT
|
|
.SH COMMANDS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B update_repo
|
|
Connect to remote repositories locally configured on the system and download
|
|
their metadata.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B install
|
|
Install a package from a configured SPM repository. Requires a package name.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B remove
|
|
Remove an installed package from the system. Requires a package name.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B info
|
|
List information about an installed package. Requires a package name.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B files
|
|
List files belonging to an installed package. Requires a package name.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B local
|
|
Perform one of the above options (except for remove) on a package file,
|
|
instead of on a package in a repository, or an installed package. Requires
|
|
a valid path to a local file on the system.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B build
|
|
Build a package from a directory containing a FORMULA file. Requires a valid
|
|
path to a local directory on the system.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B create_repo
|
|
Scan a directory for valid SPM package files and build an SPM\-METADATA file
|
|
in that directory which describes them.
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIsalt(1)\fP
|
|
\fIsalt\-master(1)\fP
|
|
\fIsalt\-minion(1)\fP
|
|
.SH AUTHOR
|
|
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
|
.SH COPYRIGHT
|
|
2016 SaltStack, Inc.
|
|
.\" Generated by docutils manpage writer.
|
|
.
|