annotate docs/ccguide/unlink.refentry @ 2106:c4c7facbd082

Fixed up some warnings
author boisy
date Sat, 07 Oct 2006 12:11:22 +0000
parents dc9fb26efbad
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
579
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
1 <!--
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
2 Too much inspiration from UNIX version 7 manuals, as you can see:
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
3 DESCRIPTION
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
4 Unlink removes the entry for the file pointed to by name from
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
5 its directory. If this entry was the last link to the file,
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
6 the contents of the file are freed and the file is destroyed.
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
7 If, however, the file was open in any process, the actual
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
8 destruction is delayed until it is closed, even though the
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
9 directory entry has disappeared.
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
10
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
11 SEE ALSO
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
12 rm(1), link(2)
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
13
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
14 DIAGNOSTICS
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
15 Zero is normally returned; -1 indicates that the file does not exist,
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
16 that its directory cannot be written, or that the file contains pure
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
17 procedure text that is currently in use. Write permission is not
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
18 required on the file itself. It is also illegal to unlink a directory
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
19 (except for the super-user).
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
20
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
21 -->
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
22 <refentry id="unlink">
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
23 <refnamediv>
468
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
24 <refname>Unlink</refname>
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
25 <refpurpose>remove directory entry</refpurpose>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
26 </refnamediv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
27
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
28 <refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
29 <funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
30 <funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
31 <funcdef><function>unlink</function></funcdef>
579
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
32 <paramdef>char *<parameter>fname</parameter></paramdef>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
33 </funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
34 </funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
35
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
36 </refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
37
546
8b99a9882961 All "See Also" implemented
roug
parents: 468
diff changeset
38 <refsect1><title>Assembler Equivalent</title>
8b99a9882961 All "See Also" implemented
roug
parents: 468
diff changeset
39 <para>
8b99a9882961 All "See Also" implemented
roug
parents: 468
diff changeset
40 os9 I$DELETE
8b99a9882961 All "See Also" implemented
roug
parents: 468
diff changeset
41 </para>
8b99a9882961 All "See Also" implemented
roug
parents: 468
diff changeset
42 </refsect1>
8b99a9882961 All "See Also" implemented
roug
parents: 468
diff changeset
43
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
44 <refsect1><title>Description</title>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
45 <para>
579
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
46 Unlink deletes the directory entry whose name is pointed to by
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
47 "fname". If the entry was the last link to the file, the file
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
48 itself is deleted and the disc space occupied made available
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
49 for re-use. If, however the file is open, in any active task,
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
50 the deletion of the actual file is delayed until the file is
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
51 closed.
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
52 </para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
53 </refsect1>
552
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
54
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
55 <refsect1><title>Diagnostics</title>
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
56 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
57 Zero is returned from a successful call, -1 if the file does
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
58 not exist, if its directory is write-protected, or cannot be
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
59 searched, if the file is a non-empty directory or a device.
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
60 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
61 </refsect1>
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
62
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
63 <refsect1><title>See Also</title>
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
64 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
65 OS-9 command "kill"
579
dc9fb26efbad All function prototypes are added.
roug
parents: 552
diff changeset
66 <!-- The original manual referenced link() here, but no such system call exists. -->
552
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
67 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 546
diff changeset
68 </refsect1>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
69 </refentry>