summaryrefslogtreecommitdiff
path: root/man/2/sys-remove
diff options
context:
space:
mode:
Diffstat (limited to 'man/2/sys-remove')
-rw-r--r--man/2/sys-remove23
1 files changed, 23 insertions, 0 deletions
diff --git a/man/2/sys-remove b/man/2/sys-remove
new file mode 100644
index 00000000..083ec6b4
--- /dev/null
+++ b/man/2/sys-remove
@@ -0,0 +1,23 @@
+.TH SYS-REMOVE 2
+.SH NAME
+remove \- remove a file
+.SH SYNOPSIS
+.EX
+include "sys.m";
+sys := load Sys Sys->PATH;
+
+remove: fn(file: string): int;
+.EE
+.SH DESCRIPTION
+.B Remove
+removes
+.I file
+from the directory containing it and discards the contents of the file.
+The user must have write permission in the containing directory.
+If
+.I file
+is a directory, it must be empty.
+.B Remove
+returns zero if it deletes the file, \-1 otherwise.
+.SH SEE ALSO
+.IR sys-intro (2)