--- var_qref.pod 2002/01/04 22:31:03 1.1
+++ var_qref.pod 2002/01/08 16:36:40 1.2
@@ -1,31 +1,65 @@
+##
+## VAR - OSSP variable expression library.
+## Copyright (c) 2001-2002 The OSSP Project (http://www.ossp.org/)
+## Copyright (c) 2001-2002 Cable & Wireless Deutschland (http://www.cw.com/de/)
+##
+## This file is part of OSSP VAR, an extensible data serialization
+## library which can be found at http://www.ossp.org/pkg/var/.
+##
+## Permission to use, copy, modify, and distribute this software for
+## any purpose with or without fee is hereby granted, provided that
+## the above copyright notice and this permission notice appear in all
+## copies.
+##
+## THIS SOFTWARE IS PROVIDED `AS IS' AND ANY EXPRESSED OR IMPLIED
+## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
+## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+## SUCH DAMAGE.
+##
+## var_qref.pod: Quick Reference manual page source
+##
=pod
-A string expanded through B<OSSP var> can consist of arbitrary text
-characters plus one or more of the following special constructs.
-This is just a very brief summary. For details see var(3).
-
-=over 4
+=head1 NAME
-=item C<\\>, C<\>I<x>
+var_qref -- OSSP var Quick Reference
-Ordinary characters C<\> and I<x>.
+=head1 DESCRIPTION
-=item C<\t>, C<\r>, C<\n>
+A string expanded through B<OSSP var> can consist of arbitrary text
+characters plus one or more of the following special syntax constructs
+which are expanded by B<OSSP var>. This is just a very brief summary.
+For more details see var(3).
-Tabulator, carriage return and newline character.
+=over 4
=item C<\>I<NNN>
-Character with the octal value I<NNN>.
+Character with the octal value I<NNN>
+(I<N>: C<0>,...,C<7>).
-=item C<\x>I<NN>
+=item C<\x>I<NN>, C<\x{>I<NNMM..>C<}>
-Character with the hexadecial value I<NN>.
+Character with the hexadecimal value I<NN> or the characters
+denoted by grouped hexadecimal numbers I<NNMM..>. (I<N>, I<M>:
+C<0>,...,C<9>,[C<aA>],...,[C<fF>]).
-=item C<\x{>I<NNMM..>C<}>
+=item C<\t>, C<\r>, C<\n>
+
+Tabulator, Carriage Return and Newline character.
+
+=item C<\\>, C<\>I<x>
-Characters denoted by grouped hexadecimal numbers I<NNMM..>.
+Ordinary character C<\> and I<x>.
=item C<$>I<name>, C<${>I<name>C<}>
@@ -33,23 +67,23 @@
=item C<${>I<name>C<[>I<index>C<]>C<}>
-Contents of array variable I<name> at I<index> position.
+Contents of array variable I<name> at position I<index>.
For I<index> full arithmetic expressions are allowed.
=item C<${>I<name>C<:#}>
Length of C<$>I<name>.
-=item ${name:l}, ${name:u}
+=item C<${>I<name>C<:l}>, C<${>I<name>C<:u}>
C<$>I<name>, converted to all lower-case or all upper-case.
-=item ${name:-<word>}
+=item C<${>I<name>C<:->I<word>C<}>
If C<$>I<name> is not empty string, then C<$>I<name>, else I<word>
(default value).
-=item ${name:+<word>}
+=item C<${>I<name>C<:+>I<word>C<}>
If C<$>I<name> is empty string, then empty string, else I<word>
(positive alternative).
@@ -103,3 +137,9 @@
=back
+=head1 SEE ALSO
+
+var(3).
+
+=cut
+
|
