diff options
Diffstat (limited to 'pkg/language/doc/osfn.hlp')
| -rw-r--r-- | pkg/language/doc/osfn.hlp | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/pkg/language/doc/osfn.hlp b/pkg/language/doc/osfn.hlp new file mode 100644 index 00000000..f544a821 --- /dev/null +++ b/pkg/language/doc/osfn.hlp @@ -0,0 +1,34 @@ +.help osfn Feb86 language +.ih +NAME +osfn -- convert an IRAF filename to a host system filename +.ih +USAGE +string = osfn (vfn) +.ih +PARAMETERS +.ls vfn +The IRAF virtual filename to be translated into a host filename. +.le +.ih +DESCRIPTION +\fIOsfn\fR is a string valued intrinsic function which takes an IRAF virtual +filename as input and returns the equivalent host system filename as output. +\fIOsfn\fR can only be called as a function. +.ih +EXAMPLES +1. Print the host equivalent of the vfn "hlib$login.cl". + + cl> = osfn ("hlib$login.cl") + +2. Compute a host filename for use as an argument to a foreign task +(see help \fItask\fR for more information on foreign tasks). + +.nf + cl> task $vdir = "$directory" # VMS directory lister + cl> vdir /size osfn("bin$") +.fi +.ih +SEE ALSO +pathnames, task +.endhelp |