System Feature
SS
Purpose
Sample Scripts
Description
Several sample scripts are available. These are named beginning with SS_ .
(SS stands for Sample Script.)
Help is available on these sample scripts. Simply use the help command
as follows.
help SS_<script_name>
Sample scripts can be used as they are, or they can be modified to suit
your purposes.
To use a sample script, use the above help command and redirect its
output to a text file, as follows.
help SS_<script_name> > SS_<script_name>.txt
Edit the newly created text file using any text editor and remove
all text until the first sharp character (#). (The sharp character is the
comment character, indicating that actual source code for the sample script
begins at that position. The text before the first sharp character contains
help page headers.)
Do make sure that you place this text file in a directory that is within
your $path system variable. If you want to add a new directory to the
$path system variable, use the following syntax.
set $path = $path+"|<directory>"
When specifying <directory>, full path is recommended. That way, you can
always be sure of which directories are in $path and which version of a
particular script is being executed, irrespective of what the current
directory is. (Note that you can add various directories to $path
in your startup script, so that these directories will be permanently
placed in $path. See help page on startup.)
Many sample scripts call other sample scripts. So, do make sure that
you copy those called scripts into a directory in your $path as well.
In general, it is a GOOD IDEA to copy all sample scripts into
$path'able files (files that are in directories in $path)
before using any sample script.
IMPORTANT: If you use copy-and-paste from the help pages displayed on
screen, to create the sample script files,
depending on your system setup, some of the special
characters used in sample scripts, such as <, >, |, ", \, etc.,
may not be copied corrrectly or may not be copied at all. This is
why WE RECOMMEND REDIRECTION of the help command output.
Many sample scripts have DEBUG output for your benefit. This debug output
is written to the error stream. When first trying sample scripts, especially
if you modify them, we recommend that you look at this DEBUG output to ensure
that the script is doing what you want it to do. Once a script starts working
to your satisfaction, you can either comment out these DEBUG lines by inserting
a # in front of them, or by redirecting the error stream from the script to null,
as follows.
2 > null
Sample and all scripts, by default, do NOT list command lines in the
scripts. If you get an error, to see exactly which line is causing
the error, call the script with -l (list) option. The command line
directly above the error is the offending line.
See Also
help
comment
startup
SS_CountLines
SS_CureURL
SS_EmailsFromURL
SS_URLsFromURL
SS_Emails
SS_ExtractLines
SS_Find
SS_FindLines
SS_ListFiles
Note
that
the
list
of
sample
scripts
presented
here
is
not
exhaustive.
To
see
a
complete
list
use
the
help
command
without
any
options
or
arguments.
All
help
topics
listed
that
begin
with
SS_
are
sample
scripts.
|
© 2008-2010, biterScripting.com. All rights reserved.
biterScripting, biterScript, biterBrowser, biterScripting.com, FVA (Forward Variable Assignment) are trademarks of biterScripting.com. Is it biterScripting-compatible ? is a service mark of biterScripting.com.
Explorer, Unix, Windows are trademarks, service marks or other forms of intellectual property of their respective owners.
|