annotate doc/interpreter/system.txi @ 4169:d5667eaf8859

[project @ 2002-11-12 03:13:42 by jwe]
author jwe
date Tue, 12 Nov 2002 03:13:42 +0000
parents aae05d51353c
children 6ab0a8767780
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
1 @c Copyright (C) 1996, 1997 John W. Eaton
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
2 @c This is part of the Octave manual.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
3 @c For copying conditions, see the file gpl.texi.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
4
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
5 @node System Utilities
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
6 @chapter System Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
7
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
8 This chapter describes the functions that are available to allow you to
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
9 get information about what is happening outside of Octave, while it is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
10 still running, and use this information in your program. For example,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
11 you can get information about environment variables, the current time,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
12 and even start other programs from the Octave prompt.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
13
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
14 @menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
15 * Timing Utilities::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
16 * Filesystem Utilities::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
17 * Controlling Subprocesses::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
18 * Process ID Information::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
19 * Environment Variables::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
20 * Current Working Directory::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
21 * Password Database Functions::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
22 * Group Database Functions::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
23 * System Information::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
24 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
25
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
26 @node Timing Utilities
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
27 @section Timing Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
28
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
29 Octave's core set of functions for manipulating time values are
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
30 patterned after the corresponding functions from the standard C library.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
31 Several of these functions use a data structure for time that includes
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
32 the following elements:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
33
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
34 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
35 @item usec
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
36 Microseconds after the second (0-999999).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
37
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
38 @item sec
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
39 Seconds after the minute (0-61). This number can be 61 to account
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
40 for leap seconds.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
41
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
42 @item min
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
43 Minutes after the hour (0-59).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
44
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
45 @item hour
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
46 Hours since midnight (0-23).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
47
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
48 @item mday
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
49 Day of the month (1-31).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
50
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
51 @item mon
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
52 Months since January (0-11).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
53
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
54 @item year
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
55 Years since 1900.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
56
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
57 @item wday
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
58 Days since Sunday (0-6).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
59
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
60 @item yday
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
61 Days since January 1 (0-365).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
62
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
63 @item isdst
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
64 Daylight Savings Time flag.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
65
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
66 @item zone
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
67 Time zone.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
68 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
69
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
70 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
71 In the descriptions of the following functions, this structure is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
72 referred to as a @var{tm_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
73
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
74 @DOCSTRING(time)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
75
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
76 @DOCSTRING(ctime)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
77
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
78 @DOCSTRING(gmtime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
79
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
80 @DOCSTRING(localtime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
81
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
82 @DOCSTRING(mktime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
83
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
84 @DOCSTRING(asctime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
85
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
86 @DOCSTRING(strftime)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
87
4169
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
88 @DOCSTRING(strptime)
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
89
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
90 Most of the remaining functions described in this section are not
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
91 patterned after the standard C library. Some are available for
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
92 compatiblity with @sc{Matlab} and others are provided because they are
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
93 useful.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
94
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
95 @DOCSTRING(clock)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
96
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
97 @DOCSTRING(date)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
98
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
99 @DOCSTRING(etime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
100
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
101 @DOCSTRING(cputime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
102
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
103 @DOCSTRING(is_leap_year)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
104
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
105 @DOCSTRING(tic)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
106
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
107 @DOCSTRING(pause)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
108
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
109 @DOCSTRING(sleep)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
110
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
111 @DOCSTRING(usleep)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
112
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
113 @node Filesystem Utilities
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
114 @section Filesystem Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
115
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
116 Octave includes the following functions for renaming and deleting files,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
117 creating, deleting, and reading directories, and for getting information
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
118 about the status of files.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
119
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
120 @DOCSTRING(rename)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
121
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
122 @DOCSTRING(link)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
123
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
124 @DOCSTRING(symlink)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
125
4169
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
126 @DOCSTRING(readlink)
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
127
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
128 @DOCSTRING(unlink)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
129
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
130 @DOCSTRING(readdir)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
131
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
132 @DOCSTRING(mkdir)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
133
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
134 @DOCSTRING(rmdir)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
135
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
136 @DOCSTRING(mkfifo)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
137
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
138 @DOCSTRING(umask)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
139
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
140 @DOCSTRING(stat)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
141
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
142 @DOCSTRING(glob)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
143
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3301
diff changeset
144 @DOCSTRING(fnmatch)
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3301
diff changeset
145
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
146 @DOCSTRING(file_in_path)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
147
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
148 @DOCSTRING(tilde_expand)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
149
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
150 @node Controlling Subprocesses
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
151 @section Controlling Subprocesses
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
152
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
153 Octave includes some high-level commands like @code{system} and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
154 @code{popen} for starting subprocesses. If you want to run another
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
155 program to perform some task and then look at its output, you will
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
156 probably want to use these functions.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
157
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
158 Octave also provides several very low-level Unix-like functions which
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
159 can also be used for starting subprocesses, but you should probably only
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
160 use them if you can't find any way to do what you need with the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
161 higher-level functions.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
162
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
163 @DOCSTRING(system)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
164
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
165 @DOCSTRING(popen)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
166
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
167 @DOCSTRING(pclose)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
168
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
169 @DOCSTRING(popen2)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
170
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
171 @DOCSTRING(EXEC_PATH)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
172
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
173 In most cases, the following functions simply decode their arguments and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
174 make the corresponding Unix system calls. For a complete example of how
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
175 they can be used, look at the definition of the function @code{popen2}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
176
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
177 @DOCSTRING(fork)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
178
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
179 @DOCSTRING(exec)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
180
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
181 @DOCSTRING(pipe)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
182
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
183 @DOCSTRING(dup2)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
184
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
185 @DOCSTRING(waitpid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
186
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
187 @DOCSTRING(fcntl)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
188
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
189 @node Process ID Information
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
190 @section Process, Group, and User IDs
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
191
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
192 @DOCSTRING(getpgrp)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
193
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
194 @DOCSTRING(getpid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
195
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
196 @DOCSTRING(getppid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
197
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
198 @DOCSTRING(geteuid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
199
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
200 @DOCSTRING(getuid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
201
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
202 @DOCSTRING(getegid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
203
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
204 @DOCSTRING(getgid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
205
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
206 @node Environment Variables
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
207 @section Environment Variables
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
208
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
209 @DOCSTRING(getenv)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
210
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
211 @DOCSTRING(putenv)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
212
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
213 @node Current Working Directory
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
214 @section Current Working Directory
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
215
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
216 @DOCSTRING(cd)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
217
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
218 @DOCSTRING(ls)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
219
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
220 @DOCSTRING(pwd)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
221
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
222 @node Password Database Functions
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
223 @section Password Database Functions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
224
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
225 Octave's password database functions return information in a structure
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
226 with the following fields.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
227
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
228 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
229 @item name
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
230 The user name.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
231
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
232 @item passwd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
233 The encrypted password, if available.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
234
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
235 @item uid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
236 The numeric user id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
237
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
238 @item gid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
239 The numeric group id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
240
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
241 @item gecos
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
242 The GECOS field.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
243
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
244 @item dir
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
245 The home directory.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
246
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
247 @item shell
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
248 The initial shell.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
249 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
250
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
251 In the descriptions of the following functions, this data structure is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
252 referred to as a @var{pw_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
253
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
254 @DOCSTRING(getpwent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
255
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
256 @DOCSTRING(getpwuid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
257
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
258 @DOCSTRING(getpwnam)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
259
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
260 @DOCSTRING(setpwent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
261
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
262 @DOCSTRING(endpwent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
263
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
264 @node Group Database Functions
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
265 @section Group Database Functions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
266
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
267 Octave's group database functions return information in a structure
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
268 with the following fields.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
269
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
270 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
271 @item name
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
272 The user name.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
273
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
274 @item passwd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
275 The encrypted password, if available.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
276
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
277 @item gid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
278 The numeric group id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
279
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
280 @item mem
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
281 The members of the group.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
282 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
283
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
284 In the descriptions of the following functions, this data structure is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
285 referred to as a @var{grp_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
286
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
287 @DOCSTRING(getgrent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
288
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
289 @DOCSTRING(getgrgid)
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
290
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
291 @DOCSTRING(getgrnam)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
292
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
293 @DOCSTRING(setgrent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
294
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
295 @DOCSTRING(endgrent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
296
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
297 @node System Information
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
298 @section System Information
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
299
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
300 @DOCSTRING(computer)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
301
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
302 @DOCSTRING(isieee)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
303
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
304 @DOCSTRING(OCTAVE_VERSION)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
305
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
306 @DOCSTRING(octave_config_info)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
307
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
308 @DOCSTRING(getrusage)