apptainer-run-help 命令

apptainer run-help displays help text embedded within an Apptainer/Singularity container. This help information is defined during container build time using the %help section in a definition file. When the --app flag is used, it displays help from the specified app's %apphelp section instead. Container authors use the %help section to document how to use their container, including expected arguments, required bind mounts, environment variables, and example commands. This provides users with container-specific usage information without needing external documentation. When called on a container without a help section, the command returns with no output. The help text is stored in the container's metadata and does not affect the container's runtime size significantly. This command is particularly useful in HPC environments where users may encounter unfamiliar containers and need quick usage guidance. It complements apptainer inspect which shows technical metadata rather than user-facing documentation.

Run `apptainer run-help [container.sif]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.

Show the help for a specific app defined in the container rather than the general container help. The help text comes from the app's %apphelp section.