up: ARG     index Zimbu documentation

CLASS ARG.Usage @earlyInit @public

summary

     

The Usage message to be displayed when there is a flag error and for --help.

The first "%0%" in the text is replaced with the name of the program.

Example: 

 ARG.Usage usage = NEW("Usage: %0% [flags] filename")

NEW(text) @public  Create a Usage text.
$get() string @public  Return the text.
$value() string @public  Return the text.
 

members (alphabetically)

     

PROC NEW(string text) @public

     

Create a Usage text.

The first "%0%" in text will be replaced with the name of the program.

This must be invoked in EarlyInit() or earlier.

FUNC $get() string @public

     

Return the text.

The first "%0%" in the text has been replaced with the name of the program.

FUNC $value() string @public

     

Return the text.

The first "%0%" in the text has been replaced with the name of the program.

license

      Copyright 2009 Bram Moolenaar All Rights Reserved.

      Licensed under the Apache License, Version 2.0. See the LICENSE file or obtain a copy at: http://www.apache.org/licenses/LICENSE-2.0