Mercurial > octave-nkf
annotate doc/interpreter/system.txi @ 12575:d0b799dafede
Grammarcheck files for 3.4.1 release.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 04 Apr 2011 15:33:46 -0700 |
parents | b22816427ce9 |
children | 2c4e52c83b64 |
rev | line source |
---|---|
11523 | 1 @c Copyright (C) 1996-2011 John W. Eaton |
7018 | 2 @c |
3 @c This file is part of Octave. | |
4 @c | |
5 @c Octave is free software; you can redistribute it and/or modify it | |
6 @c under the terms of the GNU General Public License as published by the | |
7 @c Free Software Foundation; either version 3 of the License, or (at | |
8 @c your option) any later version. | |
9 @c | |
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT | |
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
13 @c for more details. | |
14 @c | |
15 @c You should have received a copy of the GNU General Public License | |
16 @c along with Octave; see the file COPYING. If not, see | |
17 @c <http://www.gnu.org/licenses/>. | |
3294 | 18 |
4167 | 19 @node System Utilities |
3294 | 20 @chapter System Utilities |
21 | |
22 This chapter describes the functions that are available to allow you to | |
23 get information about what is happening outside of Octave, while it is | |
24 still running, and use this information in your program. For example, | |
25 you can get information about environment variables, the current time, | |
26 and even start other programs from the Octave prompt. | |
27 | |
28 @menu | |
29 * Timing Utilities:: | |
30 * Filesystem Utilities:: | |
6549 | 31 * File Archiving Utilities:: |
32 * Networking Utilities:: | |
3294 | 33 * Controlling Subprocesses:: |
34 * Process ID Information:: | |
35 * Environment Variables:: | |
36 * Current Working Directory:: | |
37 * Password Database Functions:: | |
38 * Group Database Functions:: | |
39 * System Information:: | |
6702 | 40 * Hashing Functions:: |
3294 | 41 @end menu |
42 | |
4167 | 43 @node Timing Utilities |
3294 | 44 @section Timing Utilities |
45 | |
46 Octave's core set of functions for manipulating time values are | |
47 patterned after the corresponding functions from the standard C library. | |
48 Several of these functions use a data structure for time that includes | |
49 the following elements: | |
50 | |
51 @table @code | |
52 @item usec | |
53 Microseconds after the second (0-999999). | |
54 | |
55 @item sec | |
56 Seconds after the minute (0-61). This number can be 61 to account | |
57 for leap seconds. | |
58 | |
59 @item min | |
60 Minutes after the hour (0-59). | |
61 | |
62 @item hour | |
63 Hours since midnight (0-23). | |
64 | |
65 @item mday | |
66 Day of the month (1-31). | |
67 | |
68 @item mon | |
69 Months since January (0-11). | |
70 | |
71 @item year | |
72 Years since 1900. | |
73 | |
74 @item wday | |
75 Days since Sunday (0-6). | |
76 | |
77 @item yday | |
78 Days since January 1 (0-365). | |
79 | |
80 @item isdst | |
81 Daylight Savings Time flag. | |
82 | |
83 @item zone | |
84 Time zone. | |
85 @end table | |
86 | |
87 @noindent | |
88 In the descriptions of the following functions, this structure is | |
89 referred to as a @var{tm_struct}. | |
90 | |
3301 | 91 @DOCSTRING(time) |
3294 | 92 |
6502 | 93 @DOCSTRING(now) |
94 | |
3294 | 95 @DOCSTRING(ctime) |
96 | |
3301 | 97 @DOCSTRING(gmtime) |
3294 | 98 |
3301 | 99 @DOCSTRING(localtime) |
3294 | 100 |
3301 | 101 @DOCSTRING(mktime) |
3294 | 102 |
3301 | 103 @DOCSTRING(asctime) |
3294 | 104 |
105 @DOCSTRING(strftime) | |
106 | |
4169 | 107 @DOCSTRING(strptime) |
108 | |
3294 | 109 Most of the remaining functions described in this section are not |
110 patterned after the standard C library. Some are available for | |
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
111 compatibility with @sc{matlab} and others are provided because they are |
3294 | 112 useful. |
113 | |
3301 | 114 @DOCSTRING(clock) |
3294 | 115 |
3301 | 116 @DOCSTRING(date) |
3294 | 117 |
3301 | 118 @DOCSTRING(etime) |
3294 | 119 |
3301 | 120 @DOCSTRING(cputime) |
3294 | 121 |
3301 | 122 @DOCSTRING(is_leap_year) |
3294 | 123 |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
124 @anchor{doc-toc} |
3301 | 125 @DOCSTRING(tic) |
3294 | 126 |
3301 | 127 @DOCSTRING(pause) |
3294 | 128 |
3301 | 129 @DOCSTRING(sleep) |
3294 | 130 |
3301 | 131 @DOCSTRING(usleep) |
3294 | 132 |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7018
diff
changeset
|
133 @DOCSTRING(datenum) |
6502 | 134 |
135 @DOCSTRING(datestr) | |
136 | |
137 @DOCSTRING(datevec) | |
138 | |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7018
diff
changeset
|
139 @DOCSTRING(addtodate) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7018
diff
changeset
|
140 |
6502 | 141 @DOCSTRING(calendar) |
142 | |
143 @DOCSTRING(weekday) | |
144 | |
145 @DOCSTRING(eomday) | |
146 | |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
147 @DOCSTRING(datetick) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
148 |
4167 | 149 @node Filesystem Utilities |
3294 | 150 @section Filesystem Utilities |
151 | |
12575
d0b799dafede
Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents:
12568
diff
changeset
|
152 Octave includes many utility functions for copying, moving, renaming, and |
d0b799dafede
Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents:
12568
diff
changeset
|
153 deleting files; for creating, reading, and deleting directories; for retrieving |
12211
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
154 status information on files; and for manipulating file and path names. |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
155 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
156 @DOCSTRING(movefile) |
3294 | 157 |
3301 | 158 @DOCSTRING(rename) |
3294 | 159 |
12211
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
160 @DOCSTRING(copyfile) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
161 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
162 @DOCSTRING(unlink) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
163 |
3710 | 164 @DOCSTRING(link) |
165 | |
166 @DOCSTRING(symlink) | |
167 | |
4169 | 168 @DOCSTRING(readlink) |
169 | |
3301 | 170 @DOCSTRING(mkdir) |
3294 | 171 |
3301 | 172 @DOCSTRING(rmdir) |
3294 | 173 |
6550 | 174 @DOCSTRING(confirm_recursive_rmdir) |
175 | |
3301 | 176 @DOCSTRING(mkfifo) |
3294 | 177 |
3301 | 178 @DOCSTRING(umask) |
3294 | 179 |
8549 | 180 @anchor{doc-lstat} |
3301 | 181 @DOCSTRING(stat) |
3294 | 182 |
12211
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
183 @DOCSTRING(S_ISBLK) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
184 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
185 @DOCSTRING(S_ISCHR) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
186 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
187 @DOCSTRING(S_ISDIR) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
188 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
189 @DOCSTRING(S_ISFIFO) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
190 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
191 @DOCSTRING(S_ISLNK) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
192 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
193 @DOCSTRING(S_ISREG) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
194 |
12212
f1ab2a12b4f4
Add S_ISSOCK function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12211
diff
changeset
|
195 @DOCSTRING(S_ISSOCK) |
f1ab2a12b4f4
Add S_ISSOCK function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12211
diff
changeset
|
196 |
6549 | 197 @DOCSTRING(fileattrib) |
198 | |
199 @DOCSTRING(isdir) | |
200 | |
12211
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
201 @DOCSTRING(readdir) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
202 |
3301 | 203 @DOCSTRING(glob) |
3294 | 204 |
3428 | 205 @DOCSTRING(fnmatch) |
206 | |
3301 | 207 @DOCSTRING(file_in_path) |
3294 | 208 |
12211
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
209 @DOCSTRING(filesep) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
210 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
211 @DOCSTRING(filemarker) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
212 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
213 @DOCSTRING(fileparts) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
214 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
215 @DOCSTRING(fullfile) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
216 |
3301 | 217 @DOCSTRING(tilde_expand) |
3294 | 218 |
6549 | 219 @DOCSTRING(canonicalize_file_name) |
220 | |
12211
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
221 @DOCSTRING(make_absolute_filename) |
6549 | 222 |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
223 @DOCSTRING(is_absolute_filename) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
224 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
225 @DOCSTRING(is_rooted_relative_filename) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
226 |
12211
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
227 @DOCSTRING(P_tmpdir) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
228 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
229 @DOCSTRING(tempdir) |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
230 |
11faa69c4eaa
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12208
diff
changeset
|
231 @DOCSTRING(tempname) |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
232 |
6549 | 233 @node File Archiving Utilities |
234 @section File Archiving Utilities | |
235 | |
236 @DOCSTRING(bunzip2) | |
237 | |
6868 | 238 @DOCSTRING(gzip) |
239 | |
6549 | 240 @DOCSTRING(gunzip) |
241 | |
242 @DOCSTRING(tar) | |
243 | |
244 @DOCSTRING(untar) | |
245 | |
246 @DOCSTRING(zip) | |
247 | |
248 @DOCSTRING(unzip) | |
249 | |
250 @DOCSTRING(pack) | |
251 | |
252 @DOCSTRING(unpack) | |
253 | |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
254 @DOCSTRING(bzip2) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
255 |
6549 | 256 @node Networking Utilities |
257 @section Networking Utilities | |
258 | |
9880 | 259 @menu |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
260 * FTP Objects:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
261 * URL Manipulation:: |
9880 | 262 @end menu |
263 | |
12514
e5e66c389597
Add gethostname to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12512
diff
changeset
|
264 @DOCSTRING(gethostname) |
e5e66c389597
Add gethostname to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12512
diff
changeset
|
265 |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
266 @node FTP Objects |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
267 @subsection FTP Objects |
9880 | 268 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
269 @DOCSTRING(@ftp/ftp) |
9880 | 270 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
271 @DOCSTRING(@ftp/mget) |
9880 | 272 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
273 @DOCSTRING(@ftp/mput) |
9880 | 274 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
275 @DOCSTRING(@ftp/ascii) |
9880 | 276 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
277 @DOCSTRING(@ftp/binary) |
9880 | 278 |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
279 @node URL Manipulation |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
280 @subsection URL Manipulation |
9880 | 281 |
6549 | 282 @DOCSTRING(urlread) |
283 | |
284 @DOCSTRING(urlwrite) | |
285 | |
4167 | 286 @node Controlling Subprocesses |
3294 | 287 @section Controlling Subprocesses |
288 | |
289 Octave includes some high-level commands like @code{system} and | |
290 @code{popen} for starting subprocesses. If you want to run another | |
291 program to perform some task and then look at its output, you will | |
292 probably want to use these functions. | |
293 | |
294 Octave also provides several very low-level Unix-like functions which | |
295 can also be used for starting subprocesses, but you should probably only | |
296 use them if you can't find any way to do what you need with the | |
297 higher-level functions. | |
298 | |
3301 | 299 @DOCSTRING(system) |
3294 | 300 |
6549 | 301 @DOCSTRING(unix) |
302 | |
303 @DOCSTRING(dos) | |
304 | |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7018
diff
changeset
|
305 @DOCSTRING(perl) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7018
diff
changeset
|
306 |
3301 | 307 @DOCSTRING(popen) |
3294 | 308 |
3301 | 309 @DOCSTRING(pclose) |
3294 | 310 |
3301 | 311 @DOCSTRING(popen2) |
3294 | 312 |
3301 | 313 @DOCSTRING(EXEC_PATH) |
3294 | 314 |
315 In most cases, the following functions simply decode their arguments and | |
316 make the corresponding Unix system calls. For a complete example of how | |
317 they can be used, look at the definition of the function @code{popen2}. | |
318 | |
3301 | 319 @DOCSTRING(fork) |
3294 | 320 |
3301 | 321 @DOCSTRING(exec) |
3294 | 322 |
3301 | 323 @DOCSTRING(pipe) |
3294 | 324 |
3301 | 325 @DOCSTRING(dup2) |
3294 | 326 |
3301 | 327 @DOCSTRING(waitpid) |
3294 | 328 |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
329 @DOCSTRING(WCONTINUE) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
330 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
331 @DOCSTRING(WCOREDUMP) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
332 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
333 @DOCSTRING(WEXITSTATUS) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
334 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
335 @DOCSTRING(WIFCONTINUED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
336 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
337 @DOCSTRING(WIFSIGNALED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
338 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
339 @DOCSTRING(WIFSTOPPED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
340 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
341 @DOCSTRING(WIFEXITED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
342 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
343 @DOCSTRING(WNOHANG) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
344 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
345 @DOCSTRING(WSTOPSIG) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
346 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
347 @DOCSTRING(WTERMSIG) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
348 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
349 @DOCSTRING(WUNTRACED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
350 |
3301 | 351 @DOCSTRING(fcntl) |
3294 | 352 |
6549 | 353 @DOCSTRING(kill) |
354 | |
355 @DOCSTRING(SIG) | |
356 | |
4167 | 357 @node Process ID Information |
3294 | 358 @section Process, Group, and User IDs |
359 | |
3301 | 360 @DOCSTRING(getpgrp) |
3294 | 361 |
3301 | 362 @DOCSTRING(getpid) |
3294 | 363 |
3301 | 364 @DOCSTRING(getppid) |
3294 | 365 |
3301 | 366 @DOCSTRING(geteuid) |
3294 | 367 |
3301 | 368 @DOCSTRING(getuid) |
3294 | 369 |
3301 | 370 @DOCSTRING(getegid) |
3294 | 371 |
3301 | 372 @DOCSTRING(getgid) |
3294 | 373 |
4167 | 374 @node Environment Variables |
3294 | 375 @section Environment Variables |
376 | |
3301 | 377 @DOCSTRING(getenv) |
3294 | 378 |
3301 | 379 @DOCSTRING(putenv) |
3294 | 380 |
4167 | 381 @node Current Working Directory |
3294 | 382 @section Current Working Directory |
383 | |
3301 | 384 @DOCSTRING(cd) |
3294 | 385 |
3301 | 386 @DOCSTRING(ls) |
3294 | 387 |
6549 | 388 @DOCSTRING(ls_command) |
389 | |
390 @DOCSTRING(dir) | |
391 | |
3301 | 392 @DOCSTRING(pwd) |
3294 | 393 |
4167 | 394 @node Password Database Functions |
3294 | 395 @section Password Database Functions |
396 | |
397 Octave's password database functions return information in a structure | |
398 with the following fields. | |
399 | |
400 @table @code | |
401 @item name | |
402 The user name. | |
403 | |
404 @item passwd | |
405 The encrypted password, if available. | |
406 | |
407 @item uid | |
408 The numeric user id. | |
409 | |
410 @item gid | |
411 The numeric group id. | |
412 | |
413 @item gecos | |
414 The GECOS field. | |
415 | |
416 @item dir | |
417 The home directory. | |
418 | |
419 @item shell | |
420 The initial shell. | |
421 @end table | |
422 | |
423 In the descriptions of the following functions, this data structure is | |
424 referred to as a @var{pw_struct}. | |
425 | |
3301 | 426 @DOCSTRING(getpwent) |
3294 | 427 |
3301 | 428 @DOCSTRING(getpwuid) |
3294 | 429 |
3301 | 430 @DOCSTRING(getpwnam) |
3294 | 431 |
3301 | 432 @DOCSTRING(setpwent) |
3294 | 433 |
3301 | 434 @DOCSTRING(endpwent) |
3294 | 435 |
4167 | 436 @node Group Database Functions |
3294 | 437 @section Group Database Functions |
438 | |
439 Octave's group database functions return information in a structure | |
440 with the following fields. | |
441 | |
442 @table @code | |
443 @item name | |
444 The user name. | |
445 | |
446 @item passwd | |
447 The encrypted password, if available. | |
448 | |
449 @item gid | |
450 The numeric group id. | |
451 | |
452 @item mem | |
453 The members of the group. | |
454 @end table | |
455 | |
456 In the descriptions of the following functions, this data structure is | |
457 referred to as a @var{grp_struct}. | |
458 | |
3301 | 459 @DOCSTRING(getgrent) |
3294 | 460 |
3301 | 461 @DOCSTRING(getgrgid) |
462 | |
463 @DOCSTRING(getgrnam) | |
3294 | 464 |
3301 | 465 @DOCSTRING(setgrent) |
3294 | 466 |
3301 | 467 @DOCSTRING(endgrent) |
3294 | 468 |
4167 | 469 @node System Information |
3294 | 470 @section System Information |
471 | |
3301 | 472 @DOCSTRING(computer) |
3294 | 473 |
6549 | 474 @DOCSTRING(uname) |
475 | |
12512
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
476 @DOCSTRING(nproc) |
12510
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
12212
diff
changeset
|
477 |
6549 | 478 @DOCSTRING(ispc) |
479 | |
480 @DOCSTRING(isunix) | |
481 | |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
482 @DOCSTRING(ismac) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
483 |
3301 | 484 @DOCSTRING(isieee) |
3294 | 485 |
12568
b22816427ce9
Add isdeployed function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12514
diff
changeset
|
486 @DOCSTRING(isdeployed) |
b22816427ce9
Add isdeployed function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12514
diff
changeset
|
487 |
6623 | 488 @DOCSTRING(OCTAVE_HOME) |
489 | |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
490 @DOCSTRING(matlabroot) |
3294 | 491 |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
492 @DOCSTRING(OCTAVE_VERSION) |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
493 |
6623 | 494 @DOCSTRING(version) |
495 | |
496 @DOCSTRING(ver) | |
497 | |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
498 @DOCSTRING(compare_versions) |
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
499 |
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
500 @DOCSTRING(license) |
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
501 |
3301 | 502 @DOCSTRING(octave_config_info) |
3294 | 503 |
3301 | 504 @DOCSTRING(getrusage) |
6702 | 505 |
506 @node Hashing Functions | |
507 @section Hashing Functions | |
508 | |
509 It is often necessary to find if two strings or files are | |
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
510 identical. This might be done by comparing them character by character |
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
511 and looking for differences. However, this can be slow, and so comparing |
6702 | 512 a hash of the string or file can be a rapid way of finding if the files |
513 differ. | |
514 | |
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
515 Another use of the hashing function is to check for file integrity. The |
6702 | 516 user can check the hash of the file against a known value and find if |
517 the file they have is the same as the one that the original hash was | |
518 produced with. | |
519 | |
7007 | 520 Octave supplies the @code{md5sum} function to perform MD5 hashes on |
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
521 strings and files. An example of the use of @code{md5sum} function might |
6702 | 522 be |
523 | |
524 @example | |
525 @group | |
526 if exist (file, "file") | |
527 hash = md5sum (file); | |
528 else | |
529 # Treat the variable "file" as a string | |
530 hash = md5sum (file, true); | |
531 endif | |
532 @end group | |
533 @end example | |
534 | |
535 @DOCSTRING(md5sum) |