1apptainer(1) apptainer(1)
2
3
4
6 apptainer-run-help - Show the user-defined help for an image
7
8
9
11 apptainer run-help
12
13
14
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
25 --app="" show the help for an app
26
27
28 -h, --help[=false] help for run-help
29
30
31
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 apptainer build my_container.sif my_container.def
44 Using container recipe deffile: my_container.def
45 [...snip...]
46 Cleaning up...
47
48 $ apptainer run-help my_container.sif
49
50 Some help for this container
51
52 $ apptainer run-help --app foo my_container.sif
53
54 Some help for application in this container
55
56
57
58
60 apptainer(1)
61
62
63
65 29-Mar-2023 Auto generated by spf13/cobra
66
67
68
69Auto generated by spf13/cobra Mar 2023 apptainer(1)