mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-09 13:30:26 +02:00
Code Activity

doc: Document file name separator procedures.

Browse source 
* doc/ref/posix.texi (File System): Document
  `system-file-name-convention', `file-name-separator?',
  `absolute-file-name?', and `file-name-separator-string'.
This commit is contained in:
Ludovic Courtès 2013-04-06 12:41:26 +02:00
parent 3f1362adb5
commit 66750b78c7
1 changed files with 32 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

32
doc/ref/posix.texi
View file

@ -1009,6 +1009,38 @@ Return @code{#t} if the file named @var{filename} exists, @code{#f} if
not.
@end deffn
@cindex file name separator
@cindex absolute file name
Many operating systems, such as GNU, use @code{/} (forward slash) to
separate the components of a file name; any file name starting with
@code{/} is considered an @dfn{absolute file name}. These conventions
are specified by the POSIX Base Definitions, which refer to conforming
file names as ``pathnames''. Some operating systems use a different
convention; in particular, Windows uses @code{\} (backslash) as the file
name separator, and also has the notion of @dfn{volume names} like
@code{C:\} for absolute file names. The following procedures and
variables provide support for portable file name manipulations.
@deffn {Scheme Procedure} system-file-name-convention
Return either @code{posix} or @code{windows}, depending on
what kind of system this Guile is running on.
@end deffn
@deffn {Scheme Procedure} file-name-separator? c
Return true if character @var{c} is a file name separator on the host
platform.
@end deffn
@deffn {Scheme Procedure} absolute-file-name? file-name
Return true if @var{file-name} denotes an absolute file name on the host
platform.
@end deffn
@defvr {Scheme Variable} file-name-separator-string
The standard file name separator.
@end defvr
@node User Information
@subsection User Information