removed Usage sections from commands

GodloveD · GodloveD · commit fcc9315521c7 · 2017-08-21T16:15:03.000-04:00
diff --git a/pages/docs/user-docs/docs-bootstrap.md b/pages/docs/user-docs/docs-bootstrap.md
@@ -10,87 +10,6 @@ The process of *bootstrapping* a Singularity container is equivalent to describi
 
 {% include toc.html %}
 
-## Usage
-
-```
-USAGE: singularity [...] bootstrap <container path> <definition file>
-
-The bootstrap command is useful for creating a new bootstrap or modifying an
-existing one using a definition file that describes how to build the
-container. The quickest, easiest Bootstrap is dumping DOcker layers into
-a container:
-
-    BootStrap: docker
-    From: library/ubuntu:14.04.1
-
-For more documentation on definition file recipes, look below.
-
-note: This command must be executed as root.
-
-
-
-CREATE OPTIONS:
-    -T|--notest     Bootstrap without running tests in %test section
-    -f|--force      Force a rebootstrap of an OS (note: this does not delete
-                    what is currently in the image, just causes the core to
-                    be reinstalled)
-    -s|--section    Only run a given section within the bootstrap (setup,
-                    post, files, environment, test, labels, none)
-       --nobase     Skip the generation of the base OS
-
-
-DEFFILE BASEOS EXAMPLES:
-
-    Docker:
-        BootStrap: docker
-        From: tensorflow/tensorflow:latest
-        IncludeCmd: yes #Include the CMD/ENTRYPOINT as the Singularity Runscript
-
-    YUM/RHEL:
-        BootStrap: yum
-        OSVersion: 7
-        MirrorURL: http://mirror.centos.org/centos-%{OSVERSION}/%{OSVERSION}/os/$basearch/
-        Include: yum #This is important to include inside the base container
-
-    Debian/Ubuntu:
-        BootStrap: debootstrap
-        OSVersion: trusty
-        MirrorURL: http://us.archive.ubuntu.com/ubuntu/
-
-
-DEFFILE SECTION EXAMPLES:
-
-    %setup
-        echo "This is a scriptlet that will be executed on the host, as root, after"
-        echo "the container has been bootstrapped. To install things into the container"
-        echo "reference the file system location with \$SINGULARITY_BUILDROOT"
-
-    %post
-        echo "This scriptlet section will be executed from within the container after"
-        echo "the bootstrap/base has been created and setup"
-
-    %test
-        echo "Define any test commands that should be executed after container has been"
-        echo "built. This scriptlet will be executed from within the running container"
-        echo "as the root user. Pay attention to the exit/return value of this scriptlet"
-        echo "as any non-zero exit code will be assumed as failure"
-        exit 0
-
-    %labels
-        HELLO MOTO
-        KEY VALUE
-
-    %files
-        /path/on/host/file.txt /path/on/container/file.txt 
-        relative_file.txt /path/on/container/relative_file.txt
-
-
-EXAMPLES:
-
-    $ singularity create /tmp/Debian.img
-    $ sudo singularity bootstrap /tmp/Debian.img debian.def
-```
-
 ## The header fields:
 
 ### Bootstrap:
diff --git a/pages/docs/user-docs/docs-exec.md b/pages/docs/user-docs/docs-exec.md
@@ -10,78 +10,9 @@ The `exec` Singularity sub-command allows you to spawn an arbitrary command with
 
 {% include toc.html %}
 
-## Usage
+## Examples
 
-The usage is as follows:
-
-```
-USAGE: singularity [...] exec [exec options...] <container path> <command>
-
-This command will allow you to execute any program within the given
-container image.
-
-EXEC OPTIONS:
-    -B/--bind <spec>    A user-bind path specification.  spec has the format
-                        src[:dest[:opts]], where src and dest are outside and
-                        inside paths.  If dest is not given, it is set equal
-                        to src.  Mount options ('opts') may be specified as
-                        'ro' (read-only) or 'rw' (read/write, which is the 
-                        default). This option can be called multiple times.
-    -c/--contain        This option disables the sharing of filesystems on 
-                        your host (e.g. /dev, $HOME and /tmp).
-    -C/--containall     Contain not only file systems, but also PID and IPC 
-    -e/--cleanenv       Clean environment before running container
-    -H/--home <spec>    A home directory specification.  spec can either be a
-                        src path or src:dest pair.  src is the source path
-                        of the home directory outside the container and dest
-                        overrides the home directory within the container
-    -i/--ipc            Run container in a new IPC namespace
-    -n/--nv             Enable experimental Nvidia support
-    -p/--pid            Run container in a new PID namespace
-    --pwd               Initial working directory for payload process inside 
-                        the container
-    -S/--scratch <path> Include a scratch directory within the container that 
-                        is linked to a temporary dir (use -W to force location)
-    -u/--user           Run container in a new user namespace (this allows
-                        Singularity to run completely unprivileged on recent
-                        kernels and doesn't support all features)
-    -W/--workdir        Working directory to be used for /tmp, /var/tmp and
-                        $HOME (if -c/--contain was also used)
-    -w/--writable       By default all Singularity containers are available as
-                        read only. This option makes the file system accessible
-                        as read/write.
-
-
-CONTAINER FORMATS SUPPORTED:
-    *.img               This is the native Singularity image format for all
-                        Singularity versions 2.x.
-    *.sqsh              SquashFS format, note the suffix is required!
-    *.tar*              Tar archives are exploded to a temporary directory and
-                        run within that directory (and cleaned up after). The
-                        contents of the archive is a root file system with root
-                        being in the current directory. Compression suffixes as
-                        '.gz' and '.bz2' are supported.
-    directory/          Container directories that contain a valid root file
-                        system.
-
-
-EXAMPLES:
-    
-    $ singularity exec /tmp/Debian.img cat /etc/debian_version
-    $ singularity exec /tmp/Debian.img python ./hello_world.py
-    $ cat hello_world.py | singularity exec /tmp/Debian.img python
-    $ sudo singularity exec --writable /tmp/Debian.img apt-get update
-
-For additional help, please visit our public documentation pages which are
-found at:
-
-    http://singularity.lbl.gov/
-
-```
-
-### Examples
-
-#### Printing the OS release inside the container:
+### Printing the OS release inside the container:
 
 ```bash
 $ singularity exec container.img cat /etc/os-release
@@ -96,7 +27,7 @@ BUG_REPORT_URL="https://bugs.debian.org/"
 $ 
 ```
 
-#### Special Characters
+### Special Characters
 And properly passing along special characters to the program within the container.
 
 ```bash
@@ -115,7 +46,7 @@ $
 ```
 
 
-#### A Python example
+### A Python example
 Starting with the file `hello.py` in the current directory with the contents of:
 
 ```python
@@ -161,7 +92,7 @@ Downloading layer: sha256:6a5a5368e0c2d3e5909184fa28ddfd56072e7ff3ee9a945876f7ee
 Hello World: The Python version is 3.5.2
 ```
 
-#### A GPU example
+### A GPU example
 If you're host system has an NVIDIA GPU card and a driver installed you can
 leverage the card with the `--nv` option.  (This example requires a fairly 
 recent version of the NVIDIA driver on the host system to run the latest 
diff --git a/pages/docs/user-docs/docs-export.md b/pages/docs/user-docs/docs-export.md
@@ -7,23 +7,3 @@ folder: docs
 ---
 
 Export is a way to dump the contents of your container into a .tar.gz, or a stream to put into some other place. For example, you could stream this into an in memory tar in python.
-
-## Usage
-
-```bash
-USAGE: singularity [...] export [export options...] <container path>
-
-Export will dump a tar stream of the container image contents to standard
-out (stdout). 
-
-EXPORT OPTIONS:
-    -f/--file       Output to a file instead of a pipe
-       --command    Replace the tar command (DEFAULT: 'tar cf - .')
-
-EXAMPLES:
-
-    $ singularity export /tmp/Debian.img > /tmp/Debian.tar
-    $ singularity export /tmp/Debian.img | gzip -9 > /tmp/Debian.tar.gz
-    $ singularity export -f Debian.tar /tmp/Debian.img
-
-```
diff --git a/pages/docs/user-docs/docs-import.md b/pages/docs/user-docs/docs-import.md
@@ -7,42 +7,3 @@ folder: docs
 ---
 
 Singularity import is essentially taking a dump of files and folders and adding them to your image. This works for local compressed things (e.g., tar.gz) but also for docker image layers that you don't have on your system. As of version 2.3, import of docker layers includes the environment and metadata without needing sudo.
-
-## Usage
-
-```bash
-USAGE: singularity [...] import <container path> [import from URI]
-
-Import takes a URI and will populate a container with the contents of
-the URI. If no URI is given, import will expect an incoming tar pipe.
-
-The size of the container you need to create to import a complete system
-may be significantly larger than the size of the tar file/stream due to
-overheads of the container filesystem.
-
-SUPPORTED URIs:
-
-    http/https: Pull an image using curl over HTTPD
-    docker:     Pull an image from the Docker repository
-    shub:       Pull an image from Singularity Hub
-    file:       Use a local file (same as just passing local path)
-
-SUPPORTED FILE TYPES:
-
-    .tar, .tar.gz, .tgz, .tar.bz2
-
-EXAMPLES:
-
-    Once you have created the base image template:
-
-    $ singularity create /tmp/Debian.img
-
-    You can then import:
-
-    $ gunzip -c debian.tar.gz | singularity import /tmp/Debian
-    $ singularity import /tmp/Debian.img debian.tar.gz
-    $ singularity import /tmp/Debian.img file://debian.tar.gz
-    $ singularity import /tmp/Debian.img http://foo.com/debian.tar.gz
-    $ singularity import /tmp/Debian.img docker://ubuntu:latest
-
-```
diff --git a/pages/docs/user-docs/docs-inspect.md b/pages/docs/user-docs/docs-inspect.md
@@ -10,47 +10,6 @@ How can you sniff an image? We have provided the inspect command for you to easi
 
 {% include toc.html %}
 
-## Usage
-
-```bash
-$ singularity inspect --help
-
-USAGE: singularity [...] inspect [exec options...] <container path>
-
-This command will show you the runscript for the image.
-
-INSPECT OPTIONS:
-    -l/--labels      Show the labels associated with the image (default)
-    -d/--deffile     Show the bootstrap definition file which was used
-                     to generate this image
-    -r/--runscript   Show the runscript for this image
-    -t/--test        Show the test script for this image
-    -e/--environment Show the environment settings for this container
-    -j/--json        Print structured json instead of sections
-
-EXAMPLES:
-    
-    $ singularity inspect ubuntu.img
-    #!/bin/sh
-
-    exec /bin/bash "$@"
-
-    $ singularity inspect --labels ubuntu.img
-    {
-        "SINGULARITY_DEFFILE_BOOTSTRAP": "docker",
-        "SINGULARITY_DEFFILE": "Singularity",
-        "SINGULARITY_DEFFILE_FROM": "ubuntu:latest",
-        "SINGULARITY_BOOTSTRAP_VERSION": "2.2.99"
-    }
-
-
-For additional help, please visit our public documentation pages which are
-found at:
-
-    http://singularity.lbl.gov/
-
-```
-
 This inspect is essential for making containers understandable by other tools and applications.
 
 
diff --git a/pages/docs/user-docs/docs-pull.md b/pages/docs/user-docs/docs-pull.md
@@ -10,39 +10,6 @@ Singularity `pull` is the command that you would want to use to communicate with
 
 {% include toc.html %}
 
-## Usage
-
-```
-USAGE: singularity [...] pull shub:// [unique id]
-
-pull takes a Singularity Hub (shub) URI and will pull a container
-to PWD. If you want the image to go to SINGULARITY_CACHEDIR, you
-should use one of run, exec, or shell.
-
-SUPPORTED URIs:
-
-    shub: Pull an image using python from Singularity Hub to $PWD
-    docker: Pull a docker image using python to $PWD
-
-PULL OPTIONS:
-    -n/--name   Specify a custom container name (first priority)
-    -C/--commit Name container based on Github commit (second priority)
-    -H/--hash   Name container based on file hash (second priority)
-    
-
-EXAMPLES:
-
-    $ singularity pull docker://ubuntu:latest
-
-    $ singularity pull shub://vsoch/singularity-images
-      Found image vsoch/singularity-images:mongo
-      Downloading image... vsoch-singularity-images-mongo.img
-
-    $ singularity pull --name "meatballs.img" shub://vsoch/singularity-images
-    $ singularity pull --commit shub://vsoch/singularity-images
-    $ singularity pull --hash shub://vsoch/singularity-images
-```
-
 ## Singularity Hub
 Singularity differs from Docker in that we serve entire images, as opposed to layers. This means that pulling a Singularity Hub means downloading the entire (compressed) container file, and then having it extract on your local machine. The basic command is the following:
 
diff --git a/pages/docs/user-docs/docs-run.md b/pages/docs/user-docs/docs-run.md
diff --git a/pages/docs/user-docs/docs-shell.md b/pages/docs/user-docs/docs-shell.md
