[PATCH 2/5] man: Document .ifexists CLI meta command

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, 2015-05-05 at 00:13 +0200, Peter Meerwald wrote:
> Signed-off-by: Peter Meerwald <pmeerw at pmeerw.net>
> ---
>  man/pulse-cli-syntax.5.xml.in | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/man/pulse-cli-syntax.5.xml.in b/man/pulse-cli-syntax.5.xml.in
> index 071b0cf..bb3ff70 100644
> --- a/man/pulse-cli-syntax.5.xml.in
> +++ b/man/pulse-cli-syntax.5.xml.in
> @@ -320,6 +320,17 @@ License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
>        cancel the execution of the current script file. This is ignored when
>        used on the interactive command line.</p></optdesc>
>      </option>
> +    <option>
> +      <p><opt>.ifexists</opt> <arg>filename</arg></p>
> +      <optdesc><p>Execute the subsequent block of commands only if the specified
> +      file exists.</p></optdesc>
> +    </option>

The documentation should mention that .ifexists is primarily meant for
checking the existence of modules, although it works with other files
too, as long as absolute paths are used. Relative paths are resolved
using the module directory as the base.

> +    <option>
> +      <p><opt>.else</opt> and <opt>.endif</opt></p>
> +      <optdesc><p>A block of commands is delimited by an <opt>.else</opt> or
> +      <opt>.endif</opt> meta command. Nesting conditional commands is not
> +      supported.</p></optdesc>
> +    </option>

-- 
Tanu



[Index of Archives]     [Linux Audio Users]     [AMD Graphics]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux