summaryrefslogtreecommitdiffstats
path: root/share/man/container-get.1
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/container-get.1')
-rw-r--r--share/man/container-get.1148
1 files changed, 148 insertions, 0 deletions
diff --git a/share/man/container-get.1 b/share/man/container-get.1
new file mode 100644
index 0000000..8466e19
--- /dev/null
+++ b/share/man/container-get.1
@@ -0,0 +1,148 @@
+.\" Open Infrastructure: compute-tools
+.\"
+.\" Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+.\"
+.\" SPDX-License-Identifier: GPL-3.0+
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program. If not, see <https://www.gnu.org/licenses/>.
+.\"
+.
+.TH CONTAINER-GET 1 compute-tools "Open Infrastructure"
+.SH NAME
+container-get \- Download a container
+.
+.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
+..
+.SH SYNOPSIS
+.nf
+\fBcontainer get\fP [\(aqOPTIONS\(aq]
+\fBcnt g\fP [\(aqOPTIONS\(aq]
+.fi
+.sp
+.SH DESCRIPTION
+.sp
+The \fBcontainer get\fP command downloads a container based on a script.
+.SS Scripts
+.sp
+The following download scripts are available:
+.INDENT 0.0
+.TP
+.B curl:
+Basic script to build Debian based container, see container\-create\-curl(1).
+.TP
+.B default:
+Symlink (if existing) to a download script which is used if no script was
+specified. On Debian based system this can be managed through
+update\-alternatives(1), i.e. \(aqsudo update\-alternatives \-\-config
+container_get\-script\(aq.
+.UNINDENT
+.SH OPTIONS
+.sp
+The following \fBcontainer get\fP options are available:
+.INDENT 0.0
+.TP
+.B \-n, \-\-name=\(aqNAME\(aq:
+Specify container name.
+.TP
+.B \-c, \-\-capability=\(aqCAPABILITY\(aq:
+Specify capabilities to grant, see capabilities(7).
+.TP
+.B \-d, \-\-drop\-capability=\(aqDROP_CAPABILITY\(aq:
+Specify capabilities to drop, see capabilities(7).
+.TP
+.B \-s, \-\-script=\(aqSCRIPT\(aq:
+Specify container build script, defaults to \(aqdebootstrap\(aq.
+.TP
+.B \-v, \-\-verbose:
+Explain what is being done.
+.TP
+.B \-b, \-\-bind=\(aqDIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]\(aq:
+Specify container read\-write bind mounts, see systemd\-nspawn(1) \-\-bind option.
+.TP
+.B \-\-bind\-ro=\(aqDIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]\(aq:
+Specify container read\-only bind mounts, see systemd\-nspawn(1) \-\-bind\-ro
+option.
+.TP
+.B \-\-cnt\-overlay=\(aqDIRECTORY_LOWER:DIRECTORY_UPPER:DIRECTORY_WORK:DIRECTORY_MERGED[;DIRECTORY_UPPER:DIRECTORY_LOWER:DIRECTORY_WORK:DIRECTORY_MERGED]\(aq:
+Specify container overlay mounts, see Documentation/filesystems/overlayfs.txt.
+.TP
+.B \-\-cnt.overlay\-options=\(aqOPTION1,OPTION2[;OPTION3,OPTION4]\(aq:
+Specify container overlay mount options, see
+Documentation/filesystems/overlayfs.txt.
+.TP
+.B \-\-cnt.start=\(aqOPTION1[,OPTION2,...]\(aq:
+Specify container start options, see container\-start(1).
+.UNINDENT
+.SH EXAMPLES
+.sp
+Create example.net container using curl script:
+.INDENT 0.0
+.INDENT 3.5
+sudo container get \-n example.net \-s curl
+.UNINDENT
+.UNINDENT
+.sp
+Create example.net container with the default download script and start it:
+.INDENT 0.0
+.INDENT 3.5
+sudo container get,start \-n example.net
+.UNINDENT
+.UNINDENT
+.SH SEE ALSO
+.nf
+compute\-tools(7),
+container(1).
+.fi
+.sp
+.SH HOMEPAGE
+.sp
+More information about compute\-tools and the Open Infrastructure project can be
+found on the homepage (\fI\%https://open\-infrastructure.net\fP).
+.SH CONTACT
+.sp
+Bug reports, feature requests, help, patches, support and everything else are
+welcome on the Open Infrastructure Software Mailing List
+<\fI\%software@lists.open\-infrastructure.net\fP>.
+.sp
+Debian specific bugs can also be reported in the Debian Bug Tracking System
+(\fI\%https://bugs.debian.org\fP).
+.SH AUTHORS
+.sp
+compute\-tools were written by Daniel Baumann
+<\fI\%daniel.baumann@open\-infrastructure.net\fP> and others.
+.