source: rtems/doc/posix_users/procenv.t @ 6449498

4.104.114.84.95
Last change on this file since 6449498 was 6449498, checked in by Joel Sherrill <joel.sherrill@…>, on Jan 17, 2002 at 9:47:47 PM

2001-01-17 Joel Sherrill <joel@…>

  • SUPPORT, LICENSE: New files.
  • Numerous files touched as part of merging the 4.5 branch onto the mainline development trunk and ensuring that the script that cuts snapshots and releases works on the documentation.
  • Property mode set to 100644
File size: 9.6 KB
Line 
1@c
2@c COPYRIGHT (c) 1988-2002.
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 process environment manager is ...
14
15The directives provided by the process environment manager are:
16
17@itemize @bullet
18@item @code{getpid} - Get Process ID
19@item @code{getppid} - Get Parent Process ID
20@item @code{getuid} - Get User ID
21@item @code{geteuid} - Get Effective User ID
22@item @code{getgid} - Get Real Group ID
23@item @code{getegid} - Get Effective Group ID
24@item @code{setuid} - Set User ID
25@item @code{setgid} - Set Group ID
26@item @code{getgroups} - Get Supplementary Group IDs
27@item @code{getlogin} - Get User Name
28@item @code{getlogin_r} - Reentrant Get User Name
29@item @code{getpgrp} - Get Process Group ID
30@item @code{setsid} - Create Session and Set Process Group ID
31@item @code{setpgid} - Set Process Group ID for Job Control
32@item @code{uname} - Get System Name
33@item @code{times} - Get Process Times
34@item @code{getenv} - Get Environment Variables
35@item @code{setenv} - Set Environment Variables
36@item @code{ctermid} - Generate Terminal Pathname
37@item @code{ttyname} - Determine Terminal Device Name
38@item @code{ttyname_r} - Reentrant Determine Terminal Device Name
39@item @code{isatty} - Determine if File Descriptor is Terminal
40@item @code{sysconf} - Get Configurable System Variables
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@c
59@c
60@c
61@page
62@subsection getpid - Get Process ID
63
64@findex getpid
65@cindex  get process id
66
67@subheading CALLING SEQUENCE:
68
69@ifset is-C
70@example
71int getpid(
72);
73@end example
74@end ifset
75
76@ifset is-Ada
77@end ifset
78
79@subheading STATUS CODES:
80
81@table @b
82@item E
83The
84
85@end table
86
87@subheading DESCRIPTION:
88
89@subheading NOTES:
90
91@c
92@c
93@c
94@page
95@subsection getppid - Get Parent Process ID
96
97@findex getppid
98@cindex  get parent process id
99
100@subheading CALLING SEQUENCE:
101
102@ifset is-C
103@example
104int getppid(
105);
106@end example
107@end ifset
108
109@ifset is-Ada
110@end ifset
111
112@subheading STATUS CODES:
113
114@table @b
115@item E
116The
117
118@end table
119
120@subheading DESCRIPTION:
121
122@subheading NOTES:
123
124@c
125@c
126@c
127@page
128@subsection getuid - Get User ID
129
130@findex getuid
131@cindex  get user id
132
133@subheading CALLING SEQUENCE:
134
135@ifset is-C
136@example
137int getuid(
138);
139@end example
140@end ifset
141
142@ifset is-Ada
143@end ifset
144
145@subheading STATUS CODES:
146
147@table @b
148@item E
149The
150
151@end table
152
153@subheading DESCRIPTION:
154
155@subheading NOTES:
156
157@c
158@c
159@c
160@page
161@subsection geteuid - Get Effective User ID
162
163@findex geteuid
164@cindex  get effective user id
165
166@subheading CALLING SEQUENCE:
167
168@ifset is-C
169@example
170int geteuid(
171);
172@end example
173@end ifset
174
175@ifset is-Ada
176@end ifset
177
178@subheading STATUS CODES:
179
180@table @b
181@item E
182The
183
184@end table
185
186@subheading DESCRIPTION:
187
188@subheading NOTES:
189
190@c
191@c
192@c
193@page
194@subsection getgid - Get Real Group ID
195
196@findex getgid
197@cindex  get real group id
198
199@subheading CALLING SEQUENCE:
200
201@ifset is-C
202@example
203int getgid(
204);
205@end example
206@end ifset
207
208@ifset is-Ada
209@end ifset
210
211@subheading STATUS CODES:
212
213@table @b
214@item E
215The
216
217@end table
218
219@subheading DESCRIPTION:
220
221@subheading NOTES:
222
223@c
224@c
225@c
226@page
227@subsection getegid - Get Effective Group ID
228
229@findex getegid
230@cindex  get effective group id
231
232@subheading CALLING SEQUENCE:
233
234@ifset is-C
235@example
236int getegid(
237);
238@end example
239@end ifset
240
241@ifset is-Ada
242@end ifset
243
244@subheading STATUS CODES:
245
246@table @b
247@item E
248The
249
250@end table
251
252@subheading DESCRIPTION:
253
254@subheading NOTES:
255
256@c
257@c
258@c
259@page
260@subsection setuid - Set User ID
261
262@findex setuid
263@cindex  set user id
264
265@subheading CALLING SEQUENCE:
266
267@ifset is-C
268@example
269int setuid(
270);
271@end example
272@end ifset
273
274@ifset is-Ada
275@end ifset
276
277@subheading STATUS CODES:
278
279@table @b
280@item E
281The
282
283@end table
284
285@subheading DESCRIPTION:
286
287@subheading NOTES:
288
289@c
290@c
291@c
292@page
293@subsection setgid - Set Group ID
294
295@findex setgid
296@cindex  set group id
297
298@subheading CALLING SEQUENCE:
299
300@ifset is-C
301@example
302int setgid(
303);
304@end example
305@end ifset
306
307@ifset is-Ada
308@end ifset
309
310@subheading STATUS CODES:
311
312@table @b
313@item E
314The
315
316@end table
317
318@subheading DESCRIPTION:
319
320@subheading NOTES:
321
322@c
323@c
324@c
325@page
326@subsection getgroups - Get Supplementary Group IDs
327
328@findex getgroups
329@cindex  get supplementary group ids
330
331@subheading CALLING SEQUENCE:
332
333@ifset is-C
334@example
335int getgroups(
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@c
356@c
357@c
358@page
359@subsection getlogin - Get User Name
360
361@findex getlogin
362@cindex  get user name
363
364@subheading CALLING SEQUENCE:
365
366@ifset is-C
367@example
368int getlogin(
369);
370@end example
371@end ifset
372
373@ifset is-Ada
374@end ifset
375
376@subheading STATUS CODES:
377
378@table @b
379@item E
380The
381
382@end table
383
384@subheading DESCRIPTION:
385
386@subheading NOTES:
387
388@c
389@c
390@c
391@page
392@subsection getlogin_r - Reentrant Get User Name
393
394@findex getlogin_r
395@cindex  reentrant get user name
396
397@subheading CALLING SEQUENCE:
398
399@ifset is-C
400@example
401int getlogin_r(
402);
403@end example
404@end ifset
405
406@ifset is-Ada
407@end ifset
408
409@subheading STATUS CODES:
410
411@table @b
412@item E
413The
414
415@end table
416
417@subheading DESCRIPTION:
418
419@subheading NOTES:
420
421@c
422@c
423@c
424@page
425@subsection getpgrp - Get Process Group ID
426
427@findex getpgrp
428@cindex  get process group id
429
430@subheading CALLING SEQUENCE:
431
432@ifset is-C
433@example
434int getpgrp(
435);
436@end example
437@end ifset
438
439@ifset is-Ada
440@end ifset
441
442@subheading STATUS CODES:
443
444@table @b
445@item E
446The
447
448@end table
449
450@subheading DESCRIPTION:
451
452@subheading NOTES:
453
454@c
455@c
456@c
457@page
458@subsection setsid - Create Session and Set Process Group ID
459
460@findex setsid
461@cindex  create session and set process group id
462
463@subheading CALLING SEQUENCE:
464
465@ifset is-C
466@example
467int setsid(
468);
469@end example
470@end ifset
471
472@ifset is-Ada
473@end ifset
474
475@subheading STATUS CODES:
476
477@table @b
478@item E
479The
480
481@end table
482
483@subheading DESCRIPTION:
484
485@subheading NOTES:
486
487@c
488@c
489@c
490@page
491@subsection setpgid - Set Process Group ID for Job Control
492
493@findex setpgid
494@cindex  set process group id for job control
495
496@subheading CALLING SEQUENCE:
497
498@ifset is-C
499@example
500int setpgid(
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@c
521@c
522@c
523@page
524@subsection uname - Get System Name
525
526@findex uname
527@cindex  get system name
528
529@subheading CALLING SEQUENCE:
530
531@ifset is-C
532@example
533int uname(
534);
535@end example
536@end ifset
537
538@ifset is-Ada
539@end ifset
540
541@subheading STATUS CODES:
542
543@table @b
544@item E
545The
546
547@end table
548
549@subheading DESCRIPTION:
550
551@subheading NOTES:
552
553@c
554@c
555@c
556@page
557@subsection times - Get process times
558
559@findex times
560@cindex  get process times
561
562@subheading CALLING SEQUENCE:
563
564@example
565#include <sys/time.h>
566
567clock_t times(
568  struct tms *buf
569);
570@end example
571
572@subheading STATUS CODES:
573
574This routine returns the process times
575
576@subheading DESCRIPTION:
577
578@code{times} stores the current process times in @code{buf}.
579
580@code{struct tms} is as defined in @code{/usr/include/sys/times.h}
581
582@code{times} returns the number of clock ticks that have elapsed
583since the systm has been up.
584
585@subheading NOTES:
586
587NONE
588
589@c
590@c
591@c
592@page
593@subsection getenv - Get Environment Variables
594
595@findex getenv
596@cindex  get environment variables
597
598@subheading CALLING SEQUENCE:
599
600@ifset is-C
601@example
602int getenv(
603);
604@end example
605@end ifset
606
607@ifset is-Ada
608@end ifset
609
610@subheading STATUS CODES:
611
612@table @b
613@item E
614The
615
616@end table
617
618@subheading DESCRIPTION:
619
620@subheading NOTES:
621
622@c
623@c
624@c
625@page
626@subsection setenv - Set Environment Variables
627
628@findex setenv
629@cindex  set environment variables
630
631@subheading CALLING SEQUENCE:
632
633@ifset is-C
634@example
635int setenv(
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
655@c
656@c
657@c
658@page
659@subsection ctermid - Generate Terminal Pathname
660
661@findex ctermid
662@cindex  generate terminal pathname
663
664@subheading CALLING SEQUENCE:
665
666@ifset is-C
667@example
668int ctermid(
669);
670@end example
671@end ifset
672
673@ifset is-Ada
674@end ifset
675
676@subheading STATUS CODES:
677
678@table @b
679@item E
680The
681
682@end table
683
684@subheading DESCRIPTION:
685
686@subheading NOTES:
687
688@c
689@c
690@c
691@page
692@subsection ttyname - Determine Terminal Device Name
693
694@findex ttyname
695@cindex  determine terminal device name
696
697@subheading CALLING SEQUENCE:
698
699@ifset is-C
700@example
701int ttyname(
702);
703@end example
704@end ifset
705
706@ifset is-Ada
707@end ifset
708
709@subheading STATUS CODES:
710
711@table @b
712@item E
713The
714
715@end table
716
717@subheading DESCRIPTION:
718
719@subheading NOTES:
720
721@c
722@c
723@c
724@page
725@subsection ttyname_r - Reentrant Determine Terminal Device Name
726
727@findex ttyname_r
728@cindex  reentrant determine terminal device name
729
730@subheading CALLING SEQUENCE:
731
732@ifset is-C
733@example
734int ttyname_r(
735);
736@end example
737@end ifset
738
739@ifset is-Ada
740@end ifset
741
742@subheading STATUS CODES:
743
744@table @b
745@item E
746The
747
748@end table
749
750@subheading DESCRIPTION:
751
752@subheading NOTES:
753
754@c
755@c
756@c
757@page
758@subsection isatty - Determine if File Descriptor is Terminal
759
760@findex isatty
761@cindex  determine if file descriptor is terminal
762
763@subheading CALLING SEQUENCE:
764
765@ifset is-C
766@example
767int isatty(
768);
769@end example
770@end ifset
771
772@ifset is-Ada
773@end ifset
774
775@subheading STATUS CODES:
776
777@table @b
778@item E
779The
780
781@end table
782
783@subheading DESCRIPTION:
784
785@subheading NOTES:
786
787@c
788@c
789@c
790@page
791@subsection sysconf - Get Configurable System Variables
792
793@findex sysconf
794@cindex  get configurable system variables
795
796@subheading CALLING SEQUENCE:
797
798@ifset is-C
799@example
800int sysconf(
801);
802@end example
803@end ifset
804
805@ifset is-Ada
806@end ifset
807
808@subheading STATUS CODES:
809
810@table @b
811@item E
812The
813
814@end table
815
816@subheading DESCRIPTION:
817
818@subheading NOTES:
819
Note: See TracBrowser for help on using the repository browser.