.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.1.
.TH SINGULARITY "1" "February 2022" "singularity 3.9.5+ds1-1" "User Commands"
.SH NAME
singularity \- Singularity containers command line interface
.SH DESCRIPTION
Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)
.SS "Usage:"
.IP
singularity [global options...]
.SS "Description:"
.IP
Singularity containers provide an application virtualization layer enabling
mobility of compute via both application and environment portability. With
Singularity one is capable of building a root file system that runs on any
other Linux system where Singularity is installed.
.SH OPTIONS
.TP
\fB\-c\fR, \fB\-\-config\fR string
specify a configuration file (for root or
unprivileged installation only) (default
"/etc/singularity/singularity.conf")
.TP
\fB\-d\fR, \fB\-\-debug\fR
print debugging information (highest verbosity)
.TP
\fB\-h\fR, \fB\-\-help\fR
help for singularity
.TP
\fB\-\-nocolor\fR
print without color output (default False)
.TP
\fB\-q\fR, \fB\-\-quiet\fR
suppress normal output
.TP
\fB\-s\fR, \fB\-\-silent\fR
only print errors
.TP
\fB\-v\fR, \fB\-\-verbose\fR
print additional information
.TP
\fB\-\-version\fR
version for singularity
.SS "Available Commands:"
.TP
build
Build a Singularity image
.TP
cache
Manage the local cache
.TP
capability
Manage Linux capabilities for users and groups
.TP
completion
Generate the autocompletion script for the specified shell
.TP
config
Manage various singularity configuration (root user only)
.TP
delete
Deletes requested image from the library
.TP
exec
Run a command within a container
.TP
help
Help about any command
.TP
inspect
Show metadata for an image
.TP
instance
Manage containers running as services
.TP
key
Manage OpenPGP keys
.TP
oci
Manage OCI containers
.TP
overlay
Manage an EXT3 writable overlay image
.TP
plugin
Manage Singularity plugins
.TP
pull
Pull an image from a URI
.TP
push
Upload image to the provided URI
.TP
remote
Manage singularity remote endpoints, keyservers and OCI/Docker registry credentials
.TP
run
Run the user\-defined default command within a container
.TP
run\-help
Show the user\-defined help for an image
.TP
search
Search a Container Library for images
.TP
shell
Run a shell within a container
.TP
sif
Manipulate Singularity Image Format (SIF) images
.TP
sign
Attach digital signature(s) to an image
.TP
test
Run the user\-defined tests within a container
.TP
verify
Verify cryptographic signatures attached to an image
.TP
version
Show the version for Singularity
.SH EXAMPLES
.IP
\f(CW$ singularity help <command> [<subcommand>]\fR
.br
\f(CW$ singularity help build\fR
.br
\f(CW$ singularity help instance start\fR
.PP
For additional help or support, please visit https://www.sylabs.io/docs/