aboutsummaryrefslogtreecommitdiff
path: root/unix/os/doc/zfpath.hlp
diff options
context:
space:
mode:
authorJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
committerJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
commit40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch)
tree4464880c571602d54f6ae114729bf62a89518057 /unix/os/doc/zfpath.hlp
downloadiraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'unix/os/doc/zfpath.hlp')
-rw-r--r--unix/os/doc/zfpath.hlp32
1 files changed, 32 insertions, 0 deletions
diff --git a/unix/os/doc/zfpath.hlp b/unix/os/doc/zfpath.hlp
new file mode 100644
index 00000000..920caab3
--- /dev/null
+++ b/unix/os/doc/zfpath.hlp
@@ -0,0 +1,32 @@
+.help zfpath May84 "System Interface"
+.ih
+NAME
+zfpath -- convert an OSFN into an absolute pathname
+.ih
+SYNOPSIS
+.nf
+zfpath (osfn, pathname, maxch, status)
+
+char osfn[ARB] # OS filename
+char pathname[maxch] # absolute pathname equiv. of OSFN
+int maxch, status
+.fi
+.ih
+DESCRIPTION
+Return the absolute pathname equivalent of an OS filename. An absolute pathname
+is an OSFN which does not depend on the current working directory.
+If the argument \fIosfn\fR is null the pathname of the current working
+directory is returned.
+.ih
+RETURN VALUE
+ERR is returned if the translation cannot be performed for any reason,
+or if the output string overflows. If the operation is successful the
+number of characters in the output string is returned.
+.ih
+NOTES
+This primitive is normally coded in SPP since it does not communicate
+with the host system. Character string arguments are therefore not packed.
+.ih
+SEE ALSO
+zfxdir, zfsubd
+.endhelp