File: var_misc.html

package info (click to toggle)
sdf 2.001%2B1-3
links: PTS, VCS
area: main
in suites: jessie, jessie-kfreebsd
size: 6,140 kB
ctags: 2,440
sloc: perl: 18,543; sh: 31; makefile: 29
file content (231 lines) | stat: -rw-r--r-- 3,595 bytes
parent folder | download | duplicates (6)
<!doctype html public "-//W30//DTD W3 HTML 2.0//EN">

<HTML>

<!-- This file was generated using SDF 2.001 by
     Ian Clatworthy (ianc@mincom.com). SDF is freely
     available from http://www.mincom.com/mtr/sdf. -->

<HEAD>
<TITLE>SDF 2.001: SDF Reference: Miscellaneous Variables</TITLE>
</HEAD>
<BODY BGCOLOR="ffffff">

<DIV CLASS="header">
<P><IMG SRC="../sdflogo.gif" ALIGN="Right"></P>
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="re_sdf.html">Contents</A> | <A HREF="in_var.html">Parent Topic</A> | <A HREF="var_file.html">Previous Topic</A> | <A HREF="in_claif.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
<BR CLEAR="Right">
</DIV>
<DIV CLASS="main">
<H1>13.5. Miscellaneous Variables</H1>
<HR>
<H2><A NAME="Purpose">Purpose</A></H2>
<P>These variables are generally useful.</P>
<HR>
<H2><A NAME="Interface">Interface</A></H2>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Name</STRONG>
</TD>
<TD>
<STRONG>Type</STRONG>
</TD>
<TD>
<STRONG>Purpose</STRONG>
</TD>
</TR>
<TR CLASS="group">
<TD>
<STRONG>Characters:</STRONG>
</TD>
<TD>
<STRONG>&nbsp;</STRONG>
</TD>
<TD>
<STRONG>&nbsp;</STRONG>
</TD>
</TR>
<TR>
<TD>
c
</TD>
<TD>
string
</TD>
<TD>
copyright character
</TD>
</TR>
<TR>
<TD>
tm
</TD>
<TD>
string
</TD>
<TD>
trademark character
</TD>
</TR>
<TR>
<TD>
rtm
</TD>
<TD>
string
</TD>
<TD>
registered trademark character
</TD>
</TR>
<TR>
<TD>
nbsp
</TD>
<TD>
string
</TD>
<TD>
non-breaking space
</TD>
</TR>
<TR CLASS="group">
<TD>
<STRONG>Environment:</STRONG>
</TD>
<TD>
<STRONG>&nbsp;</STRONG>
</TD>
<TD>
<STRONG>&nbsp;</STRONG>
</TD>
</TR>
<TR>
<TD>
SDF_VERSION
</TD>
<TD>
string
</TD>
<TD>
product version string (e.g. 2.000 beta1)
</TD>
</TR>
<TR>
<TD>
SDF_HOME
</TD>
<TD>
string
</TD>
<TD>
library/configuration directory
</TD>
</TR>
<TR CLASS="group">
<TD>
<STRONG>Expression formats:</STRONG>
</TD>
<TD>
<STRONG>&nbsp;</STRONG>
</TD>
<TD>
<STRONG>&nbsp;</STRONG>
</TD>
</TR>
<TR>
<TD>
FORMAT_UPPER
</TD>
<TD>
string
</TD>
<TD>
convert a string to uppercase
</TD>
</TR>
<TR>
<TD>
FORMAT_LOWER
</TD>
<TD>
string
</TD>
<TD>
convert a string to lowercase
</TD>
</TR>
<TR>
<TD>
FORMAT_FULL
</TD>
<TD>
string
</TD>
<TD>
format to a complete date-time format
</TD>
</TR>
<TR>
<TD>
FORMAT_TIME
</TD>
<TD>
string
</TD>
<TD>
format to a time only
</TD>
</TR>
<TR>
<TD>
FORMAT_DATE
</TD>
<TD>
string
</TD>
<TD>
format to a date only
</TD>
</TR>
<TR>
<TD>
FORMAT_CONCISE
</TD>
<TD>
string
</TD>
<TD>
format to a concise date only
</TD>
</TR>
<TR>
<TD>
FORMAT_YEAR
</TD>
<TD>
string
</TD>
<TD>
format to a 4-digit year
</TD>
</TR>
</TABLE>

<HR>
<H2><A NAME="Description">Description</A></H2>
<P>The <EM>character</EM> variables are the preferred way of including the respective symbols. A format-specific configuration file can override the default definitions of these symbols.</P>
<P>The <EM>environment</EM> variables can be used to find out which version of SDF is executing and where it is installed.</P>
<P>The <EM>expression format</EM> variables define bits of Perl code to format variables or expressions. They can be defined in a configuration file - your system adminstrator may wish to configure date formatting to suit local conventions.</P>
</DIV>
<DIV CLASS="footer">
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="re_sdf.html">Contents</A> | <A HREF="in_var.html">Parent Topic</A> | <A HREF="var_file.html">Previous Topic</A> | <A HREF="in_claif.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
</DIV>

</BODY>
</HTML>