Mercurial > octave-nkf
annotate doc/interpreter/system.txi @ 12292:76617b82cf4c release-3-4-x
Add S_ISSOCK function to documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sat, 29 Jan 2011 21:38:33 -0800 |
parents | b6840c49fbdb |
children | a1b2da4967ac |
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 | |
12291
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
152 Octave includes many utility functions for copying, moving, renaming, and deleting files; for creating, reading, and deleting directories; for retrieving |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
153 status information on files; and for manipulating file and path names. |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
154 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
155 @DOCSTRING(movefile) |
3294 | 156 |
3301 | 157 @DOCSTRING(rename) |
3294 | 158 |
12291
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
159 @DOCSTRING(copyfile) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
160 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
161 @DOCSTRING(unlink) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
162 |
3710 | 163 @DOCSTRING(link) |
164 | |
165 @DOCSTRING(symlink) | |
166 | |
4169 | 167 @DOCSTRING(readlink) |
168 | |
3301 | 169 @DOCSTRING(mkdir) |
3294 | 170 |
3301 | 171 @DOCSTRING(rmdir) |
3294 | 172 |
6550 | 173 @DOCSTRING(confirm_recursive_rmdir) |
174 | |
3301 | 175 @DOCSTRING(mkfifo) |
3294 | 176 |
3301 | 177 @DOCSTRING(umask) |
3294 | 178 |
8549 | 179 @anchor{doc-lstat} |
3301 | 180 @DOCSTRING(stat) |
3294 | 181 |
12291
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
182 @DOCSTRING(S_ISBLK) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
183 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
184 @DOCSTRING(S_ISCHR) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
185 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
186 @DOCSTRING(S_ISDIR) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
187 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
188 @DOCSTRING(S_ISFIFO) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
189 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
190 @DOCSTRING(S_ISLNK) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
191 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
192 @DOCSTRING(S_ISREG) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
193 |
12292
76617b82cf4c
Add S_ISSOCK function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12291
diff
changeset
|
194 @DOCSTRING(S_ISSOCK) |
76617b82cf4c
Add S_ISSOCK function to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12291
diff
changeset
|
195 |
6549 | 196 @DOCSTRING(fileattrib) |
197 | |
198 @DOCSTRING(isdir) | |
199 | |
12291
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
200 @DOCSTRING(readdir) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
201 |
3301 | 202 @DOCSTRING(glob) |
3294 | 203 |
3428 | 204 @DOCSTRING(fnmatch) |
205 | |
3301 | 206 @DOCSTRING(file_in_path) |
3294 | 207 |
12291
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
208 @DOCSTRING(filesep) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
209 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
210 @DOCSTRING(filemarker) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
211 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
212 @DOCSTRING(fileparts) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
213 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
214 @DOCSTRING(fullfile) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
215 |
3301 | 216 @DOCSTRING(tilde_expand) |
3294 | 217 |
6549 | 218 @DOCSTRING(canonicalize_file_name) |
219 | |
12291
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
220 @DOCSTRING(make_absolute_filename) |
6549 | 221 |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
222 @DOCSTRING(is_absolute_filename) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
223 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
224 @DOCSTRING(is_rooted_relative_filename) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
225 |
12291
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
226 @DOCSTRING(P_tmpdir) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
227 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
228 @DOCSTRING(tempdir) |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
229 |
b6840c49fbdb
Add S_ISBLK and family of functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12288
diff
changeset
|
230 @DOCSTRING(tempname) |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8653
diff
changeset
|
231 |
6549 | 232 @node File Archiving Utilities |
233 @section File Archiving Utilities | |
234 | |
235 @DOCSTRING(bunzip2) | |
236 | |
6868 | 237 @DOCSTRING(gzip) |
238 | |
6549 | 239 @DOCSTRING(gunzip) |
240 | |
241 @DOCSTRING(tar) | |
242 | |
243 @DOCSTRING(untar) | |
244 | |
245 @DOCSTRING(zip) | |
246 | |
247 @DOCSTRING(unzip) | |
248 | |
249 @DOCSTRING(pack) | |
250 | |
251 @DOCSTRING(unpack) | |
252 | |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
253 @DOCSTRING(bzip2) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
254 |
6549 | 255 @node Networking Utilities |
256 @section Networking Utilities | |
257 | |
9880 | 258 @menu |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
259 * FTP Objects:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
260 * URL Manipulation:: |
9880 | 261 @end menu |
262 | |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
263 @node FTP Objects |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
264 @subsection FTP Objects |
9880 | 265 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
266 @DOCSTRING(@ftp/ftp) |
9880 | 267 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
268 @DOCSTRING(@ftp/mget) |
9880 | 269 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
270 @DOCSTRING(@ftp/mput) |
9880 | 271 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
272 @DOCSTRING(@ftp/ascii) |
9880 | 273 |
9891
1506a17832c9
doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents:
9880
diff
changeset
|
274 @DOCSTRING(@ftp/binary) |
9880 | 275 |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
276 @node URL Manipulation |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
9891
diff
changeset
|
277 @subsection URL Manipulation |
9880 | 278 |
6549 | 279 @DOCSTRING(urlread) |
280 | |
281 @DOCSTRING(urlwrite) | |
282 | |
4167 | 283 @node Controlling Subprocesses |
3294 | 284 @section Controlling Subprocesses |
285 | |
286 Octave includes some high-level commands like @code{system} and | |
287 @code{popen} for starting subprocesses. If you want to run another | |
288 program to perform some task and then look at its output, you will | |
289 probably want to use these functions. | |
290 | |
291 Octave also provides several very low-level Unix-like functions which | |
292 can also be used for starting subprocesses, but you should probably only | |
293 use them if you can't find any way to do what you need with the | |
294 higher-level functions. | |
295 | |
3301 | 296 @DOCSTRING(system) |
3294 | 297 |
6549 | 298 @DOCSTRING(unix) |
299 | |
300 @DOCSTRING(dos) | |
301 | |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7018
diff
changeset
|
302 @DOCSTRING(perl) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7018
diff
changeset
|
303 |
3301 | 304 @DOCSTRING(popen) |
3294 | 305 |
3301 | 306 @DOCSTRING(pclose) |
3294 | 307 |
3301 | 308 @DOCSTRING(popen2) |
3294 | 309 |
3301 | 310 @DOCSTRING(EXEC_PATH) |
3294 | 311 |
312 In most cases, the following functions simply decode their arguments and | |
313 make the corresponding Unix system calls. For a complete example of how | |
314 they can be used, look at the definition of the function @code{popen2}. | |
315 | |
3301 | 316 @DOCSTRING(fork) |
3294 | 317 |
3301 | 318 @DOCSTRING(exec) |
3294 | 319 |
3301 | 320 @DOCSTRING(pipe) |
3294 | 321 |
3301 | 322 @DOCSTRING(dup2) |
3294 | 323 |
3301 | 324 @DOCSTRING(waitpid) |
3294 | 325 |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
326 @DOCSTRING(WCONTINUE) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
327 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
328 @DOCSTRING(WCOREDUMP) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
329 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
330 @DOCSTRING(WEXITSTATUS) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
331 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
332 @DOCSTRING(WIFCONTINUED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
333 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
334 @DOCSTRING(WIFSIGNALED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
335 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
336 @DOCSTRING(WIFSTOPPED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
337 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
338 @DOCSTRING(WIFEXITED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
339 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
340 @DOCSTRING(WNOHANG) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
341 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
342 @DOCSTRING(WSTOPSIG) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
343 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
344 @DOCSTRING(WTERMSIG) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
345 |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
346 @DOCSTRING(WUNTRACED) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
347 |
3301 | 348 @DOCSTRING(fcntl) |
3294 | 349 |
6549 | 350 @DOCSTRING(kill) |
351 | |
352 @DOCSTRING(SIG) | |
353 | |
4167 | 354 @node Process ID Information |
3294 | 355 @section Process, Group, and User IDs |
356 | |
3301 | 357 @DOCSTRING(getpgrp) |
3294 | 358 |
3301 | 359 @DOCSTRING(getpid) |
3294 | 360 |
3301 | 361 @DOCSTRING(getppid) |
3294 | 362 |
3301 | 363 @DOCSTRING(geteuid) |
3294 | 364 |
3301 | 365 @DOCSTRING(getuid) |
3294 | 366 |
3301 | 367 @DOCSTRING(getegid) |
3294 | 368 |
3301 | 369 @DOCSTRING(getgid) |
3294 | 370 |
4167 | 371 @node Environment Variables |
3294 | 372 @section Environment Variables |
373 | |
3301 | 374 @DOCSTRING(getenv) |
3294 | 375 |
3301 | 376 @DOCSTRING(putenv) |
3294 | 377 |
4167 | 378 @node Current Working Directory |
3294 | 379 @section Current Working Directory |
380 | |
3301 | 381 @DOCSTRING(cd) |
3294 | 382 |
3301 | 383 @DOCSTRING(ls) |
3294 | 384 |
6549 | 385 @DOCSTRING(ls_command) |
386 | |
387 @DOCSTRING(dir) | |
388 | |
3301 | 389 @DOCSTRING(pwd) |
3294 | 390 |
4167 | 391 @node Password Database Functions |
3294 | 392 @section Password Database Functions |
393 | |
394 Octave's password database functions return information in a structure | |
395 with the following fields. | |
396 | |
397 @table @code | |
398 @item name | |
399 The user name. | |
400 | |
401 @item passwd | |
402 The encrypted password, if available. | |
403 | |
404 @item uid | |
405 The numeric user id. | |
406 | |
407 @item gid | |
408 The numeric group id. | |
409 | |
410 @item gecos | |
411 The GECOS field. | |
412 | |
413 @item dir | |
414 The home directory. | |
415 | |
416 @item shell | |
417 The initial shell. | |
418 @end table | |
419 | |
420 In the descriptions of the following functions, this data structure is | |
421 referred to as a @var{pw_struct}. | |
422 | |
3301 | 423 @DOCSTRING(getpwent) |
3294 | 424 |
3301 | 425 @DOCSTRING(getpwuid) |
3294 | 426 |
3301 | 427 @DOCSTRING(getpwnam) |
3294 | 428 |
3301 | 429 @DOCSTRING(setpwent) |
3294 | 430 |
3301 | 431 @DOCSTRING(endpwent) |
3294 | 432 |
4167 | 433 @node Group Database Functions |
3294 | 434 @section Group Database Functions |
435 | |
436 Octave's group database functions return information in a structure | |
437 with the following fields. | |
438 | |
439 @table @code | |
440 @item name | |
441 The user name. | |
442 | |
443 @item passwd | |
444 The encrypted password, if available. | |
445 | |
446 @item gid | |
447 The numeric group id. | |
448 | |
449 @item mem | |
450 The members of the group. | |
451 @end table | |
452 | |
453 In the descriptions of the following functions, this data structure is | |
454 referred to as a @var{grp_struct}. | |
455 | |
3301 | 456 @DOCSTRING(getgrent) |
3294 | 457 |
3301 | 458 @DOCSTRING(getgrgid) |
459 | |
460 @DOCSTRING(getgrnam) | |
3294 | 461 |
3301 | 462 @DOCSTRING(setgrent) |
3294 | 463 |
3301 | 464 @DOCSTRING(endgrent) |
3294 | 465 |
4167 | 466 @node System Information |
3294 | 467 @section System Information |
468 | |
3301 | 469 @DOCSTRING(computer) |
3294 | 470 |
6549 | 471 @DOCSTRING(uname) |
472 | |
473 @DOCSTRING(ispc) | |
474 | |
475 @DOCSTRING(isunix) | |
476 | |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
477 @DOCSTRING(ismac) |
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
478 |
3301 | 479 @DOCSTRING(isieee) |
3294 | 480 |
6623 | 481 @DOCSTRING(OCTAVE_HOME) |
482 | |
12288
f07e6b4d34c7
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
483 @DOCSTRING(matlabroot) |
3294 | 484 |
12288
f07e6b4d34c7
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
485 @DOCSTRING(OCTAVE_VERSION) |
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7984
diff
changeset
|
486 |
6623 | 487 @DOCSTRING(version) |
488 | |
489 @DOCSTRING(ver) | |
490 | |
12288
f07e6b4d34c7
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
491 @DOCSTRING(compare_versions) |
f07e6b4d34c7
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
492 |
f07e6b4d34c7
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
493 @DOCSTRING(license) |
f07e6b4d34c7
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11535
diff
changeset
|
494 |
3301 | 495 @DOCSTRING(octave_config_info) |
3294 | 496 |
3301 | 497 @DOCSTRING(getrusage) |
6702 | 498 |
499 @node Hashing Functions | |
500 @section Hashing Functions | |
501 | |
502 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
|
503 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
|
504 and looking for differences. However, this can be slow, and so comparing |
6702 | 505 a hash of the string or file can be a rapid way of finding if the files |
506 differ. | |
507 | |
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
508 Another use of the hashing function is to check for file integrity. The |
6702 | 509 user can check the hash of the file against a known value and find if |
510 the file they have is the same as the one that the original hash was | |
511 produced with. | |
512 | |
7007 | 513 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
|
514 strings and files. An example of the use of @code{md5sum} function might |
6702 | 515 be |
516 | |
517 @example | |
518 @group | |
519 if exist (file, "file") | |
520 hash = md5sum (file); | |
521 else | |
522 # Treat the variable "file" as a string | |
523 hash = md5sum (file, true); | |
524 endif | |
525 @end group | |
526 @end example | |
527 | |
528 @DOCSTRING(md5sum) |