summaryrefslogtreecommitdiffstats
path: root/share/man/container-get-curl.1
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/container-get-curl.1')
-rw-r--r--share/man/container-get-curl.1172
1 files changed, 172 insertions, 0 deletions
diff --git a/share/man/container-get-curl.1 b/share/man/container-get-curl.1
new file mode 100644
index 0000000..9aa02af
--- /dev/null
+++ b/share/man/container-get-curl.1
@@ -0,0 +1,172 @@
+.\" 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-CURL 1 compute-tools "Open Infrastructure"
+.SH NAME
+container-get-curl \- Download a Debian based container by downloading a tarball over the network
+.
+.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 \-s curl\fP [\(aqOPTIONS\(aq]
+.fi
+.sp
+.SH DESCRIPTION
+.sp
+The curl container download script uses curl(1) to download a tarball over the
+network to create a Debian based container.
+.sp
+Depending on the tarball this script otherwise creates a pure Debian system
+with three modificiations:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+hostname is set (container name) in /etc/hostname
+.IP \(bu 2
+systemd machine\-id is generated in /etc/machine\-id
+.IP \(bu 2
+root password is set (user specified or 16 random characters)
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS Container images
+.sp
+compute\-tools will download tarballs from a server expecting that the images are
+tarballs with either gzip, lzip, xz, or no compression. See container\-images.sh
+as an example on how to create your own container images.
+.SH OPTIONS
+.sp
+The following script options are available:
+.INDENT 0.0
+.TP
+.B \-n, \-\-name=\(aqNAME\(aq:
+Specify container name.
+.TP
+.B \-a, \-\-architecture=\(aqARCHITECTURE\(aq:
+Specify container architecture.
+.TP
+.B \-\-clean:
+Remove container tarball after successful download.
+.TP
+.B \-p, \-\-root\-password=\(aqPASSWORD\(aq:
+Specify the root password, defaults to a random 16 character password.
+.TP
+.B \-\-server=\(aqSERVER\(aq:
+Specify the image server to download from, defaults to
+\(aq\fI\%https://get.open\-infrastructure.net/system/container/debian\fP\(aq.
+.TP
+.B \-\-setup=\(aqSETUP\(aq:
+Specify the setup image name to download, defaults to the value specified
+through \-\-system using the setup.tar.${COMPRESSION} suffix (where
+${COMPRESSION} is either lz, xz, or gz depending on compressor availability on
+the host system).
+.TP
+.B \-\-system=\(aqSYSTEM\(aq:
+Specify the system image name to download, defaults to
+debian\-bullseye\-current_${ARCHITECTURE}.system.tar.${COMPRESSION} (where
+${ARCHITECTURE} is the host systems architecture and ${COMPRESSION} either
+lz, xz, or gz depending on compressor availability on the host system).
+.UNINDENT
+.SH EXAMPLES
+.sp
+Download a Debian 11 (bullseye) based container with same architecture as the host
+system:
+.INDENT 0.0
+.INDENT 3.5
+sudo container get \-s curl \-n bullseye.example.net
+.UNINDENT
+.UNINDENT
+.sp
+Download a Debian 11 (bullseye) based container with different architecture as the
+host system:
+.INDENT 0.0
+.INDENT 3.5
+sudo container get \-s curl \-n bullseye\-i386.example.net \-\- \-\-system debian\-bullseye\-current_i386.system.tar.xz
+.UNINDENT
+.UNINDENT
+.SH FILES
+.sp
+The following files are used:
+.INDENT 0.0
+.TP
+.B /etc/compute\-tools/config:
+Container configuration files.
+.TP
+.B /usr/share/compute\-tools/get\-scripts:
+Container download scripts.
+.TP
+.B /usr/share/doc/compute\-tools:
+Container documentation.
+.TP
+.B /var/lib/machines:
+Container directory.
+.TP
+.B /var/cache/container:
+Container cache directory.
+.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.
+.