File: realpath-doc.m2

package info (click to toggle)
macaulay2 1.25.05%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 172,152 kB
  • sloc: cpp: 107,824; ansic: 16,193; javascript: 4,189; makefile: 3,899; lisp: 702; yacc: 604; sh: 476; xml: 177; perl: 114; lex: 65; python: 33
file content (34 lines) | stat: -rw-r--r-- 1,202 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
--- status: TODO
--- author(s): 
--- notes: 

document { 
     Key => realpath,
     Headline => "convert a filename to one passing through no symbolic links",
     Usage => "realpath fn",
     Inputs => { "fn" => String => "a filename, or path to a file" },
     Outputs => { String => { "a pathname to ", TT "fn", " passing through no symbolic links, and
	       ending with a slash if ", TT "fn", " refers to a directory" }},
     EXAMPLE lines ///
     	  realpath "."
     	  p = temporaryFileName()
	  q = temporaryFileName()
	  symlinkFile(p,q)
	  p << close
	  readlink q
	  realpath q
	  removeFile p
	  removeFile q
     ///,
     PARA {
	  "The empty string is interpreted as a reference to the current directory."
	  },
     EXAMPLE ///realpath ""///,
     SeeAlso => {readlink},
     Caveat => {
	  "Every component of the path must exist in the file system and be accessible to the user.
	  Terminal slashes will be dropped.  Warning: under most operating systems, the value returned
	  is an absolute path (one starting at the root of the file system), but under Solaris,
	  this system call may, in certain circumstances, return a relative path when given a relative path."
	  }
     }