logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

singularity-run-help - Show the user-defined help for an image

Description

       The help text is from the '%help' section of the definition file. If you are
         using the '--apps' option, the help text is instead from that app's '%apphelp'
         section.

Example

         $ cat my_container.def
         Bootstrap: docker
         From: busybox

         %help
             Some help for this container

         %apphelp foo
             Some help for application 'foo' in this container

         $ sudo singularity build my_container.sif my_container.def
         Using container recipe deffile: my_container.def
         [...snip...]
         Cleaning up...

         $ singularity run-help my_container.sif

           Some help for this container

         $ singularity run-help --app foo my_container.sif

           Some help for application in this container

History

       27-Feb-2025 Auto generated by spf13/cobra

Auto generated by spf13/cobra                       Feb 2025                                      singularity(1)

Name

       singularity-run-help - Show the user-defined help for an image

Options

--app=""      show the help for an app

       -h, --help[=false]      help for run-help

See Also

singularity(1)

Synopsis

singularityrun-help

See Also