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
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=""      show the help for an app
26
27
28       -h, --help[=false]      help for run-help
29
30
31

EXAMPLE

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

SEE ALSO

60       singularity(1)
61
62
63

HISTORY

65       9-Nov-2021 Auto generated by spf13/cobra
66
67
68
69Auto generated by spf13/cobra      Nov 2021                     singularity(1)