.\" $HeadURL$ $LastChangedRevision$ .\" vim: filetype=nroff .\" .TH ADEPERLF 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN" .ne 5 .SH NAME adeperlf \- call an ADE Perl function .br .ne 5 .SH SYNOPSIS .B adeperlf \*[ade_standard_synopsis_component] .I code .br .ne 5 .SH DESCRIPTION .B Adeperlf provides a command line interface to the ADE Perl library. .I code should return (see .B perlsyn\fR(1)). .br .ne 5 .SH CONFIGURATION None. .ne 5 .SH OPTIONS \*[ade_standard_options_component] .br .ne 5 .SH EXIT STATUS On success .B adeperlf returns zero. On failure it returns non-zero and displays a diagnostic message. .br .ne 5 .SH FILES None. .br .ne 5 .SH ENVIRONMENT VARIABLES None. .br .ne 5 .SH EXAMPLES This shows how to call ADE functions (in this case to create a lock file and then remove it), handle their return codes and illustrates how to return from the code: .IP .nf .fam C .B adeperlf \[aq]$rc=&ade_lck_lock($errstack_ref, \[dq]/tmp/x.lock\[dq]); return($rc) if ($rc!=$ade_ok); print(scalar(localtime) . \[dq]\en\[dq]); sleep(10); print(scalar(localtime) . \[dq]\en\[dq]); &ade_lck_unlock($errstack_ref, \[dq]/tmp/x.lock\[dq]); return($ade_ok);\[aq] .fam T .fi .ne 5 .SH CAVEATS None. .br .ne 5 .SH STANDARDS This manual page documents version ADE_APP_TOKEN_RELEASE_ID of .B adeperlf\fR. .br .ne 5 .SH SEE ALSO adepyf(1), adeshf(1), ade-config(1) .br .ne 5 .SH AUTHOR ADE_APP_TOKEN_AUTHOR_NAME .br .ne 5 .SH COPYRIGHT & DISTRIBUTION POLICY Copyright (C) 2003-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME \*[ade_standard_copyright_component]