1singularity(1)                                                  singularity(1)
2
3
4

NAME

6       singularity-run-help - Show the user-defined help for an image
7
8
9

SYNOPSIS

11       singularity run-help <image path>
12
13
14

DESCRIPTION

16       Show the help for an image.
17
18
19       The help text is from the '%help' section of the definition file. If
20       you are using the '--apps' option,
21         the help text is instead from that app's '%apphelp' section.
22
23
24

OPTIONS

26       --app=""
27           Show the help for an app
28
29
30       -h, --help[=false]
31           help for run-help
32
33
34

EXAMPLE

36                $ cat my_container.def
37                Bootstrap: docker
38                From: busybox
39
40                %help
41                    Some help for this container
42
43                %apphelp foo
44                    Some help for application 'foo' in this container
45
46                $ sudo singularity build my_container.sif my_container.def
47                Using container recipe deffile: my_container.def
48                [...snip...]
49                Cleaning up...
50
51                $ singularity run-help my_container.sif
52
53                  Some help for this container
54
55                $ singularity run-help --app foo my_container.sif
56
57                  Some help for application in this container
58
59
60
61

SEE ALSO

63       singularity(1)
64
65
66

HISTORY

68       29-May-2019 Auto generated by spf13/cobra
69
70
71
72Auto generated by spf13/cobra      May 2019                     singularity(1)