Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed pages/docs/user-docs/.action-exec.md.swp
Binary file not shown.
5 changes: 5 additions & 0 deletions pages/docs/user-docs/action-exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ SUPPORT_URL="http://www.debian.org/support"
BUG_REPORT_URL="https://bugs.debian.org/"
$
```
### Printing the OS release for a running instance:
Use the `instance://<instance name>` syntax like so:
```
$ singularity exec instance://my-instance cat /etc/os-release
```

### Special Characters
And properly passing along special characters to the program within the container.
Expand Down
4 changes: 4 additions & 0 deletions pages/docs/user-docs/build-docker-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Registry: http://custom_registry
```
The **Registry** keyword is optional. It will default to `index.docker.io`.
```
Namespace: namespace
```
The **Namespace** keyword is optional. It will default to `library`.
```
IncludeCmd: yes
```
The **IncludeCmd** keyword is optional. If included, and if a `%runscript` is not specified, a Docker `CMD` will take precedence over `ENTRYPOINT` and will be used as a runscript. Note that the `IncludeCmd` keyword is considered valid if it is _not empty_! This means that `IncludeCmd: yes` and `IncludeCmd: no` are identical. In both cases the `IncludeCmd` keyword is not empty, so the Docker `CMD` will take precedence over an `ENTRYPOINT`.
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/user-docs/docs-instance-stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Stopping cow1 instance of /home/ubuntu/GodloveD-lolcow-master.img (PID=20522)

### Stop all running instances
```
$ singularity instance.stop \*
$ singularity instance.stop --all
Stopping cow2 instance of /home/ubuntu/GodloveD-lolcow-master.img (PID=20558)
Stopping hiya instance of /home/ubuntu/vsoch-hello-world-master.img (PID=20595)
```
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/user-docs/docs-recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A Singularity Recipe is the driver of a custom build, and the starting point for
A Singularity Recipe file is divided into several parts:

1. **Header**: The Header describes the core operating system to build within the container. Here you will configure the base operating system features that you need within your container. Examples of this include, what distribution of Linux, what version, what packages must be part of a core install.
2. **Sections**: The rest of the definition is comprised of sections, sometimes called scriptlets or blobs of data. Each section is defined by a `%` character followed by the name of the particular section. All sections are optional.
2. **Sections**: The rest of the definition is comprised of sections, sometimes called scriptlets or blobs of data. Each section is defined by a `%` character followed by the name of the particular section. All sections are optional. Sections that are executed at build time are executed with the `/bin/sh` interpreter and can accept `/bin/sh` options. Similarly, sections that produce scripts to be executed at runtime can accept options intended for `/bin/sh`

Please see the [examples](https://github.com/singularityware/singularity/tree/master/examples) directory in the [Singularity source code](https://github.com/singularityware/singularity) for some ideas on how to get started.

Expand Down