.nh
.TH "singularity" "1" "Feb 2022" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
singularity-run-help - Show the user-defined help for an image


.SH SYNOPSIS
.PP
\fBsingularity run-help \fP


.SH DESCRIPTION
.PP
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.


.SH OPTIONS
.PP
\fB--app\fP=""
	show the help for an app

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for run-help


.SH EXAMPLE
.PP
.RS

.nf

  $ 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

.fi
.RE


.SH SEE ALSO
.PP
\fBsingularity(1)\fP


.SH HISTORY
.PP
20-Feb-2022 Auto generated by spf13/cobra