Changeset 9173 in project


Ignore:
Timestamp:
03/06/08 00:57:16 (12 years ago)
Author:
elf
Message:

new function documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/Unit posix

    r8521 r9173  
    118118file-patterns (with {{*}} matching zero or more characters and
    119119{{?}} matching zero or one character).
     120
     121==== canonical-path
     122
     123 [procedure] (canonical-path NAME)
     124
     125Returns a canonical path for {{NAME}}, which should be a string
     126containing a path-or-filename.  The string returned by
     127{{canonical-path}} is OS dependent; it may be quoted and used in
     128a shell on the calling machine. (Quoting is suggested as shell
     129special characters, including space, are not escaped.)  However,
     130all path separators and prefixes are handled in an OS independent
     131fashion.  Any appearance of {{/}} below imply {{\\}} is also handled.
     132
     133The prefix for {{NAME}} determines what path to prepend.  If {{NAME}}
     134begins with a {{"~/"}}, this prefix is stripped and the user's
     135home directory is added.  If beginning with {{/}} or a DRIVE-LETTER:\\
     136combination, no additional path is added.  Otherwise, the current
     137directory and separator are added.  All relative path elements and
     138duplicate separators are processed and removed.  If {{NAME}} ends with
     139a {{/}} or is empty, the appropriate slash is appended to the tail.
     140
     141No directories or files are actually tested for existence; this
     142procedure only canonicalises path syntax.
    120143
    121144==== set-root-directory!
Note: See TracChangeset for help on using the changeset viewer.