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       The help text is from the '%help' section of the definition file. If
17       you are
18         using the '--apps' option, the help text is instead from that app's
19       '%apphelp'
20         section.
21
22
23

OPTIONS

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

EXAMPLE

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

SEE ALSO

62       singularity(1)
63
64
65

HISTORY

67       18-Feb-2020 Auto generated by spf13/cobra
68
69
70
71Auto generated by spf13/cobra      Feb 2020                     singularity(1)