source: rtems/doc/new_chapters/files.t @ 571a915

4.104.114.84.95
Last change on this file since 571a915 was 16bed8a, checked in by Joel Sherrill <joel.sherrill@…>, on 08/04/98 at 19:25:14

More complete shells generated.

  • Property mode set to 100644
File size: 7.7 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1998.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@chapter Files and Directories Manager
10
11@section Introduction
12
13The
14files and directories manager is ...
15
16The directives provided by the files and directories manager are:
17
18@itemize @bullet
19@item @code{opendir} -
20@item @code{readdir} -
21@item @code{readdir_r} -
22@item @code{rewinddir} -
23@item @code{closedir} -
24@item @code{chdir} -
25@item @code{getcwd} -
26@item @code{open} -
27@item @code{creat} -
28@item @code{umask} -
29@item @code{link} -
30@item @code{mkdir} -
31@item @code{mkfifo} -
32@item @code{unlink} -
33@item @code{rmdir} -
34@item @code{rename} -
35@item @code{stat} -
36@item @code{fstat} -
37@item @code{access} -
38@item @code{chmod} -
39@item @code{fchmod} -
40@item @code{chown} -
41@item @code{utime} -
42@item @code{ftrunctate} -
43@item @code{pathconf} -
44@item @code{fpathconf} -
45@end itemize
46
47@section Background
48
49@section Operations
50
51@section Directives
52
53This section details the files and directories manager's directives.
54A subsection is dedicated to each of this manager's directives
55and describes the calling sequence, related constants, usage,
56and status codes.
57
58@page
59@subsection opendir -
60
61@subheading CALLING SEQUENCE:
62
63@ifset is-C
64@example
65int opendir(
66);
67@end example
68@end ifset
69
70@ifset is-Ada
71@end ifset
72
73@subheading STATUS CODES:
74
75@table @b
76@item E
77The
78
79@end table
80
81@subheading DESCRIPTION:
82
83@subheading NOTES:
84
85@page
86@subsection readdir -
87
88@subheading CALLING SEQUENCE:
89
90@ifset is-C
91@example
92int readdir(
93);
94@end example
95@end ifset
96
97@ifset is-Ada
98@end ifset
99
100@subheading STATUS CODES:
101
102@table @b
103@item E
104The
105
106@end table
107
108@subheading DESCRIPTION:
109
110@subheading NOTES:
111
112@page
113@subsection readdir_r -
114
115@subheading CALLING SEQUENCE:
116
117@ifset is-C
118@example
119int readdir_r(
120);
121@end example
122@end ifset
123
124@ifset is-Ada
125@end ifset
126
127@subheading STATUS CODES:
128
129@table @b
130@item E
131The
132
133@end table
134
135@subheading DESCRIPTION:
136
137@subheading NOTES:
138
139@page
140@subsection rewinddir -
141
142@subheading CALLING SEQUENCE:
143
144@ifset is-C
145@example
146int rewinddir(
147);
148@end example
149@end ifset
150
151@ifset is-Ada
152@end ifset
153
154@subheading STATUS CODES:
155
156@table @b
157@item E
158The
159
160@end table
161
162@subheading DESCRIPTION:
163
164@subheading NOTES:
165
166@page
167@subsection closedir -
168
169@subheading CALLING SEQUENCE:
170
171@ifset is-C
172@example
173int closedir(
174);
175@end example
176@end ifset
177
178@ifset is-Ada
179@end ifset
180
181@subheading STATUS CODES:
182
183@table @b
184@item E
185The
186
187@end table
188
189@subheading DESCRIPTION:
190
191@subheading NOTES:
192
193@page
194@subsection chdir -
195
196@subheading CALLING SEQUENCE:
197
198@ifset is-C
199@example
200int chdir(
201);
202@end example
203@end ifset
204
205@ifset is-Ada
206@end ifset
207
208@subheading STATUS CODES:
209
210@table @b
211@item E
212The
213
214@end table
215
216@subheading DESCRIPTION:
217
218@subheading NOTES:
219
220@page
221@subsection getcwd -
222
223@subheading CALLING SEQUENCE:
224
225@ifset is-C
226@example
227int getcwd(
228);
229@end example
230@end ifset
231
232@ifset is-Ada
233@end ifset
234
235@subheading STATUS CODES:
236
237@table @b
238@item E
239The
240
241@end table
242
243@subheading DESCRIPTION:
244
245@subheading NOTES:
246
247@page
248@subsection open -
249
250@subheading CALLING SEQUENCE:
251
252@ifset is-C
253@example
254int open(
255);
256@end example
257@end ifset
258
259@ifset is-Ada
260@end ifset
261
262@subheading STATUS CODES:
263
264@table @b
265@item E
266The
267
268@end table
269
270@subheading DESCRIPTION:
271
272@subheading NOTES:
273
274@page
275@subsection creat -
276
277@subheading CALLING SEQUENCE:
278
279@ifset is-C
280@example
281int creat(
282);
283@end example
284@end ifset
285
286@ifset is-Ada
287@end ifset
288
289@subheading STATUS CODES:
290
291@table @b
292@item E
293The
294
295@end table
296
297@subheading DESCRIPTION:
298
299@subheading NOTES:
300
301@page
302@subsection umask -
303
304@subheading CALLING SEQUENCE:
305
306@ifset is-C
307@example
308int umask(
309);
310@end example
311@end ifset
312
313@ifset is-Ada
314@end ifset
315
316@subheading STATUS CODES:
317
318@table @b
319@item E
320The
321
322@end table
323
324@subheading DESCRIPTION:
325
326@subheading NOTES:
327
328@page
329@subsection link -
330
331@subheading CALLING SEQUENCE:
332
333@ifset is-C
334@example
335int link(
336);
337@end example
338@end ifset
339
340@ifset is-Ada
341@end ifset
342
343@subheading STATUS CODES:
344
345@table @b
346@item E
347The
348
349@end table
350
351@subheading DESCRIPTION:
352
353@subheading NOTES:
354
355@page
356@subsection mkdir -
357
358@subheading CALLING SEQUENCE:
359
360@ifset is-C
361@example
362int mkdir(
363);
364@end example
365@end ifset
366
367@ifset is-Ada
368@end ifset
369
370@subheading STATUS CODES:
371
372@table @b
373@item E
374The
375
376@end table
377
378@subheading DESCRIPTION:
379
380@subheading NOTES:
381
382@page
383@subsection mkfifo -
384
385@subheading CALLING SEQUENCE:
386
387@ifset is-C
388@example
389int mkfifo(
390);
391@end example
392@end ifset
393
394@ifset is-Ada
395@end ifset
396
397@subheading STATUS CODES:
398
399@table @b
400@item E
401The
402
403@end table
404
405@subheading DESCRIPTION:
406
407@subheading NOTES:
408
409@page
410@subsection unlink -
411
412@subheading CALLING SEQUENCE:
413
414@ifset is-C
415@example
416int unlink(
417);
418@end example
419@end ifset
420
421@ifset is-Ada
422@end ifset
423
424@subheading STATUS CODES:
425
426@table @b
427@item E
428The
429
430@end table
431
432@subheading DESCRIPTION:
433
434@subheading NOTES:
435
436@page
437@subsection rmdir -
438
439@subheading CALLING SEQUENCE:
440
441@ifset is-C
442@example
443int rmdir(
444);
445@end example
446@end ifset
447
448@ifset is-Ada
449@end ifset
450
451@subheading STATUS CODES:
452
453@table @b
454@item E
455The
456
457@end table
458
459@subheading DESCRIPTION:
460
461@subheading NOTES:
462
463@page
464@subsection rename -
465
466@subheading CALLING SEQUENCE:
467
468@ifset is-C
469@example
470int rename(
471);
472@end example
473@end ifset
474
475@ifset is-Ada
476@end ifset
477
478@subheading STATUS CODES:
479
480@table @b
481@item E
482The
483
484@end table
485
486@subheading DESCRIPTION:
487
488@subheading NOTES:
489
490@page
491@subsection stat -
492
493@subheading CALLING SEQUENCE:
494
495@ifset is-C
496@example
497int stat(
498);
499@end example
500@end ifset
501
502@ifset is-Ada
503@end ifset
504
505@subheading STATUS CODES:
506
507@table @b
508@item E
509The
510
511@end table
512
513@subheading DESCRIPTION:
514
515@subheading NOTES:
516
517@page
518@subsection fstat -
519
520@subheading CALLING SEQUENCE:
521
522@ifset is-C
523@example
524int fstat(
525);
526@end example
527@end ifset
528
529@ifset is-Ada
530@end ifset
531
532@subheading STATUS CODES:
533
534@table @b
535@item E
536The
537
538@end table
539
540@subheading DESCRIPTION:
541
542@subheading NOTES:
543
544@page
545@subsection access -
546
547@subheading CALLING SEQUENCE:
548
549@ifset is-C
550@example
551int access(
552);
553@end example
554@end ifset
555
556@ifset is-Ada
557@end ifset
558
559@subheading STATUS CODES:
560
561@table @b
562@item E
563The
564
565@end table
566
567@subheading DESCRIPTION:
568
569@subheading NOTES:
570
571@page
572@subsection chmod -
573
574@subheading CALLING SEQUENCE:
575
576@ifset is-C
577@example
578int chmod(
579);
580@end example
581@end ifset
582
583@ifset is-Ada
584@end ifset
585
586@subheading STATUS CODES:
587
588@table @b
589@item E
590The
591
592@end table
593
594@subheading DESCRIPTION:
595
596@subheading NOTES:
597
598@page
599@subsection fchmod -
600
601@subheading CALLING SEQUENCE:
602
603@ifset is-C
604@example
605int fchmod(
606);
607@end example
608@end ifset
609
610@ifset is-Ada
611@end ifset
612
613@subheading STATUS CODES:
614
615@table @b
616@item E
617The
618
619@end table
620
621@subheading DESCRIPTION:
622
623@subheading NOTES:
624
625@page
626@subsection chown -
627
628@subheading CALLING SEQUENCE:
629
630@ifset is-C
631@example
632int chown(
633);
634@end example
635@end ifset
636
637@ifset is-Ada
638@end ifset
639
640@subheading STATUS CODES:
641
642@table @b
643@item E
644The
645
646@end table
647
648@subheading DESCRIPTION:
649
650@subheading NOTES:
651
652@page
653@subsection utime -
654
655@subheading CALLING SEQUENCE:
656
657@ifset is-C
658@example
659int utime(
660);
661@end example
662@end ifset
663
664@ifset is-Ada
665@end ifset
666
667@subheading STATUS CODES:
668
669@table @b
670@item E
671The
672
673@end table
674
675@subheading DESCRIPTION:
676
677@subheading NOTES:
678
679@page
680@subsection ftrunctate -
681
682@subheading CALLING SEQUENCE:
683
684@ifset is-C
685@example
686int ftrunctate(
687);
688@end example
689@end ifset
690
691@ifset is-Ada
692@end ifset
693
694@subheading STATUS CODES:
695
696@table @b
697@item E
698The
699
700@end table
701
702@subheading DESCRIPTION:
703
704@subheading NOTES:
705
706@page
707@subsection pathconf -
708
709@subheading CALLING SEQUENCE:
710
711@ifset is-C
712@example
713int pathconf(
714);
715@end example
716@end ifset
717
718@ifset is-Ada
719@end ifset
720
721@subheading STATUS CODES:
722
723@table @b
724@item E
725The
726
727@end table
728
729@subheading DESCRIPTION:
730
731@subheading NOTES:
732
733@page
734@subsection fpathconf -
735
736@subheading CALLING SEQUENCE:
737
738@ifset is-C
739@example
740int fpathconf(
741);
742@end example
743@end ifset
744
745@ifset is-Ada
746@end ifset
747
748@subheading STATUS CODES:
749
750@table @b
751@item E
752The
753
754@end table
755
756@subheading DESCRIPTION:
757
758@subheading NOTES:
759
Note: See TracBrowser for help on using the repository browser.