diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2025-04-19 14:35:34 -0400 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2025-04-19 14:35:34 -0400 |
| commit | 67fd3c725e6511adf70345f0733ec0b948477a11 (patch) | |
| tree | 913d9f30d8ce3614a9ae3715281f8804323b24ff /man/man3/tomo-Path.changed.3 | |
| parent | 0974d632c3dda7874f01c58bfc342b73cd1634a4 (diff) | |
Make API documentation into YAML files and autogenerate markdown files
and manpages from those.
Diffstat (limited to 'man/man3/tomo-Path.changed.3')
| -rw-r--r-- | man/man3/tomo-Path.changed.3 | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/man/man3/tomo-Path.changed.3 b/man/man3/tomo-Path.changed.3 new file mode 100644 index 00000000..56d8fd97 --- /dev/null +++ b/man/man3/tomo-Path.changed.3 @@ -0,0 +1,40 @@ +'\" t +.\" Copyright (c) 2025 Bruce Hill +.\" All rights reserved. +.\" +.TH Path.changed 3 2025-04-19T14:30:40.365046 "Tomo man-pages" +.SH NAME +Path.changed \- Gets the file change time of a file. + +.SH LIBRARY +Tomo Standard Library +.SH SYNOPSIS +.nf +.BI "Path.changed : func(path: Path, follow_symlinks: Bool = yes -> Int64?)" +.fi + +.SH DESCRIPTION +Gets the file change time of a file. + + +.TS +allbox; +lb lb lbx lb +l l l l. +Name Type Description Default +path Path The path of the file whose change time you want. - +follow_symlinks Bool Whether to follow symbolic links. yes +.TE +.SH RETURN +A 64-bit unix epoch timestamp representing when the file or directory was last changed, or `none` if no such file or directory exists. + +.SH NOTES +This is the ["ctime"](https://en.wikipedia.org/wiki/Stat_(system_call)#ctime) of a file, which is _not_ the file creation time. + +.SH EXAMPLES +.EX +>> (./file.txt).changed() += 1704221100? +>> (./not-a-file).changed() += none +.EE |