File: fileTime-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 (23 lines) | stat: -rw-r--r-- 928 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
--- status: DRAFT
--- author(s): MES
--- notes: 

document { 
     Key => fileTime,
     Headline => "get or set file modified time",
     Usage => "fileTime s  or  fileTime(t,s)",
     Inputs => {
	  "t" => ZZ => "if present, the file-modified-time will be set to this value",
	  "s" => String => "the name of a file"
	  },
     Outputs => {
	  ZZ => { "the last modified date of the file with name ", TT "s" }
	  },
     Consequences => {
	  { TT "fileTime(t,s)", " sets the last modified time for the file ", TT "s", " to ", TT "t", ", and returns ", TT "null", " if no error occurs" }
	  },     
     "The value is the number of seconds since 00:00:00 1970-01-01 UTC, the beginning of the epoch, so the
     number of seconds ago a file or directory was modified may be found by using the following code.",
     EXAMPLE ///currentTime() - fileTime "."///,          
     SeeAlso => {currentTime, "file manipulation"}
     }