File: readlink-doc.m2

package info (click to toggle)
macaulay2 1.24.11%2Bds-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 171,648 kB
  • sloc: cpp: 107,850; ansic: 16,307; javascript: 4,188; makefile: 3,947; lisp: 682; yacc: 604; sh: 476; xml: 177; perl: 114; lex: 65; python: 33
file content (17 lines) | stat: -rw-r--r-- 453 bytes parent folder | download | duplicates (3) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
 
--- status: TODO
--- author(s): 
--- notes: 

document { 
     Key => readlink,
     Headline => "readlink fn",
     Usage => "read the contents of a symbolic link",
     Inputs => { "fn" => String => "a filename or path to a file" },
     Outputs => { Boolean => { "whether ", TT "fn", " is the path to a symbolic link" }},
     EXAMPLE lines ///
     	  p = temporaryFileName ()
	  symlinkFile ("foo", p)
	  readlink p
	  removeFile p
     ///
     }