Index: ossp-pkg/var/var_qref.pod RCS File: /v/ossp/cvs/ossp-pkg/var/Attic/var_qref.pod,v rcsdiff -q -kk '-r1.1' '-r1.2' -u '/v/ossp/cvs/ossp-pkg/var/Attic/var_qref.pod,v' 2>/dev/null --- 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 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 +var_qref -- OSSP var Quick Reference -Ordinary characters C<\> and I. +=head1 DESCRIPTION -=item C<\t>, C<\r>, C<\n> +A string expanded through B can consist of arbitrary text +characters plus one or more of the following special syntax constructs +which are expanded by B. This is just a very brief summary. +For more details see var(3). -Tabulator, carriage return and newline character. +=over 4 =item C<\>I -Character with the octal value I. +Character with the octal value I +(I: C<0>,...,C<7>). -=item C<\x>I +=item C<\x>I, C<\x{>IC<}> -Character with the hexadecial value I. +Character with the hexadecimal value I or the characters +denoted by grouped hexadecimal numbers I. (I, I: +C<0>,...,C<9>,[C],...,[C]). -=item C<\x{>IC<}> +=item C<\t>, C<\r>, C<\n> + +Tabulator, Carriage Return and Newline character. + +=item C<\\>, C<\>I -Characters denoted by grouped hexadecimal numbers I. +Ordinary character C<\> and I. =item C<$>I, C<${>IC<}> @@ -33,23 +67,23 @@ =item C<${>IC<[>IC<]>C<}> -Contents of array variable I at I position. +Contents of array variable I at position I. For I full arithmetic expressions are allowed. =item C<${>IC<:#}> Length of C<$>I. -=item ${name:l}, ${name:u} +=item C<${>IC<:l}>, C<${>IC<:u}> C<$>I, converted to all lower-case or all upper-case. -=item ${name:-} +=item C<${>IC<:->IC<}> If C<$>I is not empty string, then C<$>I, else I (default value). -=item ${name:+} +=item C<${>IC<:+>IC<}> If C<$>I is empty string, then empty string, else I (positive alternative). @@ -103,3 +137,9 @@ =back +=head1 SEE ALSO + +var(3). + +=cut +