source: rtems/doc/new_chapters/procenv.t @ 77f0853

4.104.114.84.95
Last change on this file since 77f0853 was 77f0853, checked in by Joel Sherrill <joel.sherrill@…>, on 10/19/98 at 21:52:56

Enhanced times() with copy from the other chapter.

  • Property mode set to 100644
File size: 7.0 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 Process Environment Manager
10
11@section Introduction
12
13The
14process environment manager is ...
15
16The directives provided by the process environment manager are:
17
18@itemize @bullet
19@item @code{getpid} -
20@item @code{getppid} -
21@item @code{getuid} -
22@item @code{geteuid} -
23@item @code{getgid} -
24@item @code{getegid} -
25@item @code{setuid} -
26@item @code{setgid} -
27@item @code{getgroups} -
28@item @code{getlogin} -
29@item @code{getlogin_r} -
30@item @code{getpgrp} -
31@item @code{setsid} -
32@item @code{setpgid} -
33@item @code{uname} -
34@item @code{times} - Get process times
35@item @code{getenv} -
36@item @code{ctermid} -
37@item @code{ttyname} -
38@item @code{ttyname_r} -
39@item @code{isatty} -
40@item @code{sysconf} -
41@end itemize
42
43@section Background
44
45There is currently no text in this section.
46
47@section Operations
48
49There is currently no text in this section.
50
51@section Directives
52
53This section details the process environment 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 getpid -
60
61@subheading CALLING SEQUENCE:
62
63@ifset is-C
64@example
65int getpid(
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 getppid -
87
88@subheading CALLING SEQUENCE:
89
90@ifset is-C
91@example
92int getppid(
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 getuid -
114
115@subheading CALLING SEQUENCE:
116
117@ifset is-C
118@example
119int getuid(
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 geteuid -
141
142@subheading CALLING SEQUENCE:
143
144@ifset is-C
145@example
146int geteuid(
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 getgid -
168
169@subheading CALLING SEQUENCE:
170
171@ifset is-C
172@example
173int getgid(
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 getegid -
195
196@subheading CALLING SEQUENCE:
197
198@ifset is-C
199@example
200int getegid(
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 setuid -
222
223@subheading CALLING SEQUENCE:
224
225@ifset is-C
226@example
227int setuid(
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 setgid -
249
250@subheading CALLING SEQUENCE:
251
252@ifset is-C
253@example
254int setgid(
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 getgroups -
276
277@subheading CALLING SEQUENCE:
278
279@ifset is-C
280@example
281int getgroups(
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 getlogin -
303
304@subheading CALLING SEQUENCE:
305
306@ifset is-C
307@example
308int getlogin(
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 getlogin_r -
330
331@subheading CALLING SEQUENCE:
332
333@ifset is-C
334@example
335int getlogin_r(
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 getpgrp -
357
358@subheading CALLING SEQUENCE:
359
360@ifset is-C
361@example
362int getpgrp(
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 setsid -
384
385@subheading CALLING SEQUENCE:
386
387@ifset is-C
388@example
389int setsid(
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 setpgid -
411
412@subheading CALLING SEQUENCE:
413
414@ifset is-C
415@example
416int setpgid(
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 uname -
438
439@subheading CALLING SEQUENCE:
440
441@ifset is-C
442@example
443int uname(
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 times - Get process times
465
466@subheading CALLING SEQUENCE:
467
468@example
469#include <sys/time.h>
470
471clock_t times(
472  struct tms *buf
473);
474@end example
475
476@subheading STATUS CODES:
477
478This routine returns the process times
479
480@subheading DESCRIPTION:
481
482@code{times} stores the current process times in @code{buf}.
483
484@code{struct tms} is as defined in @code{/usr/include/sys/times.h}
485
486@code{times} returns the number of clock ticks that have elapsed
487since the systm has been up.
488
489@subheading NOTES:
490
491NONE
492
493@page
494@subsection getenv -
495
496@subheading CALLING SEQUENCE:
497
498@ifset is-C
499@example
500int getenv(
501);
502@end example
503@end ifset
504
505@ifset is-Ada
506@end ifset
507
508@subheading STATUS CODES:
509
510@table @b
511@item E
512The
513
514@end table
515
516@subheading DESCRIPTION:
517
518@subheading NOTES:
519
520@page
521@subsection ctermid -
522
523@subheading CALLING SEQUENCE:
524
525@ifset is-C
526@example
527int ctermid(
528);
529@end example
530@end ifset
531
532@ifset is-Ada
533@end ifset
534
535@subheading STATUS CODES:
536
537@table @b
538@item E
539The
540
541@end table
542
543@subheading DESCRIPTION:
544
545@subheading NOTES:
546
547@page
548@subsection ttyname -
549
550@subheading CALLING SEQUENCE:
551
552@ifset is-C
553@example
554int ttyname(
555);
556@end example
557@end ifset
558
559@ifset is-Ada
560@end ifset
561
562@subheading STATUS CODES:
563
564@table @b
565@item E
566The
567
568@end table
569
570@subheading DESCRIPTION:
571
572@subheading NOTES:
573
574@page
575@subsection ttyname_r -
576
577@subheading CALLING SEQUENCE:
578
579@ifset is-C
580@example
581int ttyname_r(
582);
583@end example
584@end ifset
585
586@ifset is-Ada
587@end ifset
588
589@subheading STATUS CODES:
590
591@table @b
592@item E
593The
594
595@end table
596
597@subheading DESCRIPTION:
598
599@subheading NOTES:
600
601@page
602@subsection isatty -
603
604@subheading CALLING SEQUENCE:
605
606@ifset is-C
607@example
608int isatty(
609);
610@end example
611@end ifset
612
613@ifset is-Ada
614@end ifset
615
616@subheading STATUS CODES:
617
618@table @b
619@item E
620The
621
622@end table
623
624@subheading DESCRIPTION:
625
626@subheading NOTES:
627
628@page
629@subsection sysconf -
630
631@subheading CALLING SEQUENCE:
632
633@ifset is-C
634@example
635int sysconf(
636);
637@end example
638@end ifset
639
640@ifset is-Ada
641@end ifset
642
643@subheading STATUS CODES:
644
645@table @b
646@item E
647The
648
649@end table
650
651@subheading DESCRIPTION:
652
653@subheading NOTES:
654
Note: See TracBrowser for help on using the repository browser.