enforce 80char max line length

misc. cleanup
pull/128/head
mtabriz 4 years ago
parent c2dbffd666
commit b7e75f1271

@ -1,6 +1,8 @@
# ch-build
# Utility to build a Charliecloud image and place it in the builders back-end storage. More information: <https://github.com/hpc/charliecloud>.
# Utility to build a Charliecloud image and place it in the builders back-end
# storage. More information: <https://github.com/hpc/charliecloud>.
# Create an image tagged foo and specified by the file /bar/Dockerfile. Use /bar as the Docker context directory. Use the default builder.
# Create an image tagged foo and specified by the file /bar/Dockerfile.
# Use /bar as the Docker context directory. Use the default builder.
ch-build -t foo --file=/bar/Dockerfile /bar

@ -1,6 +1,8 @@
# ch-build2dir
# Utility to build a Charliecloud image from Dockerfile and unpack it into a directory. More information: <https://github.com/hpc/charliecloud>.
# Utility to build a Charliecloud image from Dockerfile and unpack it into a
# directory. More information: <https://github.com/hpc/charliecloud>.
# Build a Charliecloud image using ./Dockerfile.foo and create image directory /var/tmp/foo
# Build a Charliecloud image using ./Dockerfile.foo and create image
# directory /var/tmp/foo
ch-build2dir -t foo -f ./Dockerfile.foo . /var/tmp

@ -1,6 +1,8 @@
# ch-builder2squash
# Utility to flatten a builder image into a Charliecloud SquashFS file. More information: <https://github.com/hpc/charliecloud>.
# Utility to flatten a builder image into a Charliecloud SquashFS file.
# More information: <https://github.com/hpc/charliecloud>.
# Flattens the builder image tagged "debian" into a SquashFS file named debian.sqfs in /var/tmp.
# Flattens the builder image tagged "debian" into a SquashFS file named
# debian.sqfs in /var/tmp.
ch-builder2squash debian /var/tmp

@ -1,6 +1,8 @@
# ch-builder2tar
# Utility to flatten a builder image into a Charliecloud image tarball. More information: <https://github.com/hpc/charliecloud>.
# Utility to flatten a builder image into a Charliecloud image tarball.
# More information: <https://github.com/hpc/charliecloud>.
# Flatten the builder image tagged "hello" into a Charliecloud tarball in directory /var/tmp
# Flatten the builder image tagged "hello" into a Charliecloud tarball in
# directory /var/tmp
ch-builder2tar hello /var/tmp

@ -1,6 +1,8 @@
# ch-dir2squash
# Utility to create a SquashFS file from a Charliecloud image directory. More information: <https://github.com/hpc/charliecloud>.
# Utility to create a SquashFS file from a Charliecloud image directory.
# More information: <https://github.com/hpc/charliecloud>.
# Create a Charliecloud SquashFS file debian.sqfs from the image directory /var/tmp/debian under the directory /var/tmp.
# Create a Charliecloud SquashFS file debian.sqfs under the directory /var/tmp
# from the image directory /var/tmp/debian.
ch-dir2squash /var/tmp/debian /var/tmp

@ -1,7 +1,10 @@
# ch-grow
# Utility to build and manage Charliecloud images but not running them. It is completely unprivileged, with no setuid/setgid/setcap helpers. More information: <https://github.com/hpc/charliecloud>.
# Utility to build and manage Charliecloud images but not running them.
# It is completely unprivileged, with no setuid/setgid/setcap helpers.
# More information: <https://github.com/hpc/charliecloud>.
# Build the image "bar" using ./foo/bar/Dockerfile and context directory ./foo/bar
# Build the image "bar" using ./foo/bar/Dockerfile and context directory
# ./foo/bar
ch-grow build -t bar -f ./foo/bar/Dockerfile ./foo/bar
# Download the Debian Buster image and place it in /tmp/buster.

@ -1,7 +1,8 @@
# ch-mount
# Utility to mount a SquashFS image file using FUSE. More information: <https://github.com/hpc/charliecloud>.
# Utility to mount a SquashFS image file using FUSE.
# More information: <https://github.com/hpc/charliecloud>.
# Create a new empty directory named debian, then mount it on /var/tmp directory. The /var/tmp directory must not already exist.
# Create a new empty directory named debian, then mount it on /var/tmp
# directory. The /var/tmp directory must not already exist.
ch-mount /var/tmp/debian.sqfs /var/tmp

@ -1,6 +1,8 @@
# ch-pull2dir
# Utility to pull an image from the Docker Hub and unpack it into a directory. More information: <https://github.com/hpc/charliecloud>.
# Utility to pull an image from the Docker Hub and unpack it into a directory.
# More information: <https://github.com/hpc/charliecloud>.
# Pull Docker image named alpine:latest from Docker Hub and extract it into a subdirectory of /var/tmp. A temporary tarball will be stored in /var/tmp.
# Pull Docker image named alpine:latest from Docker Hub and extract it into
# a subdirectory of /var/tmp. A temporary tarball will be stored in /var/tmp.
ch-pull2dir alpine:latest /var/tmp

@ -1,7 +1,8 @@
# ch-pull2tar
# Utility to pull an image from the Docker Hub and flatten it into a tarball. More information: <https://github.com/hpc/charliecloud>.
# Utility to pull an image from the Docker Hub and flatten it into a tarball.
# More information: <https://github.com/hpc/charliecloud>.
# Pull a Docker image named alpine:latest from Docker Hub and flatten it into a Charliecloud tarball in the directory /var/tmp.
# Pull a Docker image named alpine:latest from Docker Hub and flatten it into
# a Charliecloud tarball in the directory /var/tmp.
ch-pull2tar alpine:latest /var/tmp

@ -1,6 +1,8 @@
# ch-run
# Utility to run a command in a Charliecloud container. More information: <https://github.com/hpc/charliecloud>.
# Utility to run a command in a Charliecloud container.
# More information: <https://github.com/hpc/charliecloud>.
# Run the command echo hello inside a Charliecloud container using the unpacked image at /data/foo.
# Run the command echo hello inside a Charliecloud container using
# the unpacked image at /data/foo.
ch-run /data/foo -- echo hello

@ -1,6 +1,9 @@
# ch-tar2dir
# Utility to unpack a Charliecloud image tarball into a directory. More information: <https://github.com/hpc/charliecloud>.
# Utility to unpack a Charliecloud image tarball into a directory.
# More information: <https://github.com/hpc/charliecloud>.
# Extract the tarball /var/tmp/hello.tar.gz into a subdirectory of /var/tmp. hello.tar.gz must contain a Linux filesystem image, e.g. as created by ch-builder2tar.
# Extract the tarball /var/tmp/hello.tar.gz into a subdirectory of /var/tmp.
# hello.tar.gz must contain a Linux filesystem image, e.g. as created
# by ch-builder2tar.
ch-tar2dir /var/tmp/hello.tar.gz /var/tmp

Loading…
Cancel
Save