Mercurial > hg > octave-nkf

annotate doc/interpreter/system.txi @ 14119:94e2a76f1e5a stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Final grammarcheck and spellcheck before 3.6.0 release. * container.txi, aspell-octave.en.pws, expr.txi, vectorize.txi, accumarray.m, accumdim.m, interpft.m, strread.m, parseparams.m, warning_ids.m, cellfun.cc, help.cc: grammarcheck and spellcheck docstrings.
author Rik <octave@nomad.inbox5.com>
date Thu, 29 Dec 2011 06:05:00 -0800
parents 5820f8ce683e
children 72c96de7a403
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11392
diff changeset
1 @c Copyright (C) 1996-2011 John W. Eaton
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
4 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
5 @c Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
6 @c under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
7 @c Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
8 @c your option) any later version.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
9 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
13 @c for more details.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
14 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
16 @c along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7007
diff changeset
17 @c <http://www.gnu.org/licenses/>.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
18
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
19 @node System Utilities
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
20 @chapter System Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
21
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
22 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
23 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
24 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
25 you can get information about environment variables, the current time,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
26 and even start other programs from the Octave prompt.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
27
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
28 @menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
29 * Timing Utilities::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
30 * Filesystem Utilities::
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
31 * File Archiving Utilities::
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
32 * Networking Utilities::
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
33 * Controlling Subprocesses::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
34 * Process ID Information::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
35 * Environment Variables::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
36 * Current Working Directory::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
37 * Password Database Functions::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
38 * Group Database Functions::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
39 * System Information::
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
40 * Hashing Functions::
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
41 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
42
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
43 @node Timing Utilities
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
44 @section Timing Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
45
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
46 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
47 patterned after the corresponding functions from the standard C library.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
48 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
49 the following elements:
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 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
52 @item usec
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
53 Microseconds after the second (0-999999).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
54
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
55 @item sec
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
56 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
57 for leap seconds.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
58
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
59 @item min
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
60 Minutes after the hour (0-59).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
61
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
62 @item hour
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
63 Hours since midnight (0-23).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
64
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
65 @item mday
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
66 Day of the month (1-31).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
67
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
68 @item mon
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
69 Months since January (0-11).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
70
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
71 @item year
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
72 Years since 1900.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
73
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
74 @item wday
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
75 Days since Sunday (0-6).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
76
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
77 @item yday
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
78 Days since January 1 (0-365).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
79
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
80 @item isdst
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
81 Daylight Savings Time flag.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
82
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
83 @item zone
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
84 Time zone.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
85 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
86
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
87 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
88 In the descriptions of the following functions, this structure is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
89 referred to as a @var{tm_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
90
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
91 @DOCSTRING(time)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
92
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
93 @DOCSTRING(now)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
94
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
95 @DOCSTRING(ctime)
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(gmtime)
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(localtime)
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(mktime)
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(asctime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
104
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
105 @DOCSTRING(strftime)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
106
4169
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
107 @DOCSTRING(strptime)
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
108
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
109 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
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
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
112 useful.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
113
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
114 @DOCSTRING(clock)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
115
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
116 @DOCSTRING(date)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
117
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
118 @DOCSTRING(etime)
3294
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(cputime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
121
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
122 @DOCSTRING(is_leap_year)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
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
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
125 @DOCSTRING(tic)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
126
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
127 @DOCSTRING(pause)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
128
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
129 @DOCSTRING(sleep)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
130
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
131 @DOCSTRING(usleep)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
132
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
133 @DOCSTRING(datenum)
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
134
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
135 @DOCSTRING(datestr)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
136
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
137 @DOCSTRING(datevec)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
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
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
141 @DOCSTRING(calendar)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
142
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
143 @DOCSTRING(weekday)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
144
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
145 @DOCSTRING(eomday)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
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
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
149 @node Filesystem Utilities
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
150 @section Filesystem Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
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
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
157
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
158 @DOCSTRING(rename)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
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
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
164 @DOCSTRING(link)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
165
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
166 @DOCSTRING(symlink)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
167
4169
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
168 @DOCSTRING(readlink)
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
169
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
170 @DOCSTRING(mkdir)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
171
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
172 @DOCSTRING(rmdir)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
173
6550
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
174 @DOCSTRING(confirm_recursive_rmdir)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
175
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
176 @DOCSTRING(mkfifo)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
177
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
178 @DOCSTRING(umask)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
179
8549
424ba638d8f1 [mq]: fstat
file-io.cc (Ffstat): new function
parents: 8286
diff changeset
180 @anchor{doc-lstat}
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
181 @DOCSTRING(stat)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
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
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
197 @DOCSTRING(fileattrib)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
198
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
199 @DOCSTRING(isdir)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
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
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
203 @DOCSTRING(glob)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
204
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3301
diff changeset
205 @DOCSTRING(fnmatch)
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3301
diff changeset
206
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
207 @DOCSTRING(file_in_path)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
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
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
217 @DOCSTRING(tilde_expand)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
218
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
219 @DOCSTRING(canonicalize_file_name)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
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
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
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
13843
c299b26d0e6b missing change from changeset 69afe121f07e
John W. Eaton <jwe@octave.org>
parents: 12580
diff changeset
233 @DOCSTRING(recycle)
c299b26d0e6b missing change from changeset 69afe121f07e
John W. Eaton <jwe@octave.org>
parents: 12580
diff changeset
234
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
235 @node File Archiving Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
236 @section File Archiving Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
237
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
238 @DOCSTRING(bunzip2)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
239
6868
975fcdfb0d2d [project @ 2007-09-06 16:34:29 by dbateman]
dbateman
parents: 6778
diff changeset
240 @DOCSTRING(gzip)
975fcdfb0d2d [project @ 2007-09-06 16:34:29 by dbateman]
dbateman
parents: 6778
diff changeset
241
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
242 @DOCSTRING(gunzip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
243
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
244 @DOCSTRING(tar)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
245
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
246 @DOCSTRING(untar)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
247
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
248 @DOCSTRING(zip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
249
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
250 @DOCSTRING(unzip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
251
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
252 @DOCSTRING(unpack)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
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
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
256 @node Networking Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
257 @section Networking Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
258
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
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
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
262 @end menu
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
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
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
268
9891
1506a17832c9 doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents: 9880
diff changeset
269 @DOCSTRING(@ftp/ftp)
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
270
9891
1506a17832c9 doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents: 9880
diff changeset
271 @DOCSTRING(@ftp/mget)
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
272
9891
1506a17832c9 doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents: 9880
diff changeset
273 @DOCSTRING(@ftp/mput)
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
274
9891
1506a17832c9 doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents: 9880
diff changeset
275 @DOCSTRING(@ftp/ascii)
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
276
9891
1506a17832c9 doc building fixes for class methods
John W. Eaton <jwe@octave.org>
parents: 9880
diff changeset
277 @DOCSTRING(@ftp/binary)
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
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
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents: 9079
diff changeset
281
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
282 @DOCSTRING(urlread)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
283
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
284 @DOCSTRING(urlwrite)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
285
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
286 @node Controlling Subprocesses
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
287 @section Controlling Subprocesses
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
288
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
289 Octave includes some high-level commands like @code{system} and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
290 @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
291 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
292 probably want to use these functions.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
293
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
294 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
295 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
296 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
297 higher-level functions.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
298
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
299 @DOCSTRING(system)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
300
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
301 @DOCSTRING(unix)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
302
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
303 @DOCSTRING(dos)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
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
13859
6d59b141e65d Add python to manual and respect format rules of copyright block
Carnë Draug <carandraug+dev@gmail.com>
parents: 12580
diff changeset
307 @DOCSTRING(python)
6d59b141e65d Add python to manual and respect format rules of copyright block
Carnë Draug <carandraug+dev@gmail.com>
parents: 12580
diff changeset
308
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
309 @DOCSTRING(popen)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
310
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
311 @DOCSTRING(pclose)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
312
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
313 @DOCSTRING(popen2)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
314
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
315 @DOCSTRING(EXEC_PATH)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
316
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
317 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
318 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
319 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
320
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
321 @DOCSTRING(fork)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
322
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
323 @DOCSTRING(exec)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
324
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
325 @DOCSTRING(pipe)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
326
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
327 @DOCSTRING(dup2)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
328
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
329 @DOCSTRING(waitpid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
330
8286
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7984
diff changeset
331 @DOCSTRING(WCONTINUE)
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(WCOREDUMP)
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(WEXITSTATUS)
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(WIFCONTINUED)
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(WIFSIGNALED)
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(WIFSTOPPED)
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(WIFEXITED)
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(WNOHANG)
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(WSTOPSIG)
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(WTERMSIG)
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7984
diff changeset
350
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7984
diff changeset
351 @DOCSTRING(WUNTRACED)
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7984
diff changeset
352
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
353 @DOCSTRING(fcntl)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
354
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
355 @DOCSTRING(kill)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
356
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
357 @DOCSTRING(SIG)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
358
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
359 @node Process ID Information
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
360 @section Process, Group, and User IDs
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
361
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
362 @DOCSTRING(getpgrp)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
363
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
364 @DOCSTRING(getpid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
365
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
366 @DOCSTRING(getppid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
367
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
368 @DOCSTRING(geteuid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
369
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
370 @DOCSTRING(getuid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
371
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
372 @DOCSTRING(getegid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
373
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
374 @DOCSTRING(getgid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
375
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
376 @node Environment Variables
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
377 @section Environment Variables
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
378
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
379 @DOCSTRING(getenv)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
380
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
381 @DOCSTRING(putenv)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
382
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
383 @node Current Working Directory
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
384 @section Current Working Directory
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
385
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
386 @DOCSTRING(cd)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
387
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
388 @DOCSTRING(ls)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
389
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
390 @DOCSTRING(ls_command)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
391
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
392 @DOCSTRING(dir)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
393
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
394 @DOCSTRING(pwd)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
395
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
396 @node Password Database Functions
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
397 @section Password Database Functions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
398
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
399 Octave's password database functions return information in a structure
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
400 with the following fields.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
401
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
402 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
403 @item name
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
404 The user name.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
405
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
406 @item passwd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
407 The encrypted password, if available.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
408
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
409 @item uid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
410 The numeric user id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
411
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
412 @item gid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
413 The numeric group id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
414
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
415 @item gecos
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
416 The GECOS field.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
417
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
418 @item dir
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
419 The home directory.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
420
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
421 @item shell
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
422 The initial shell.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
423 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
424
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
425 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
426 referred to as a @var{pw_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
427
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
428 @DOCSTRING(getpwent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
429
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
430 @DOCSTRING(getpwuid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
431
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
432 @DOCSTRING(getpwnam)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
433
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
434 @DOCSTRING(setpwent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
435
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
436 @DOCSTRING(endpwent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
437
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
438 @node Group Database Functions
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
439 @section Group Database Functions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
440
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
441 Octave's group database functions return information in a structure
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
442 with the following fields.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
443
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
444 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
445 @item name
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
446 The user name.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
447
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
448 @item passwd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
449 The encrypted password, if available.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
450
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
451 @item gid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
452 The numeric group id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
453
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
454 @item mem
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
455 The members of the group.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
456 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
457
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
458 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
459 referred to as a @var{grp_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
460
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
461 @DOCSTRING(getgrent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
462
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
463 @DOCSTRING(getgrgid)
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
464
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
465 @DOCSTRING(getgrnam)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
466
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
467 @DOCSTRING(setgrent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
468
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
469 @DOCSTRING(endgrent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
470
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
471 @node System Information
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
472 @section System Information
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
473
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
474 @DOCSTRING(computer)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
475
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
476 @DOCSTRING(uname)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
477
12512
77b14e634166 Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents: 12510
diff changeset
478 @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
479
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
480 @DOCSTRING(ispc)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
481
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
482 @DOCSTRING(isunix)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
483
8286
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7984
diff changeset
484 @DOCSTRING(ismac)
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7984
diff changeset
485
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
486 @DOCSTRING(isieee)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
487
12568
b22816427ce9 Add isdeployed function to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12514
diff changeset
488 @DOCSTRING(isdeployed)
b22816427ce9 Add isdeployed function to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12514
diff changeset
489
6623
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
490 @DOCSTRING(OCTAVE_HOME)
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
491
12208
9611014e7cf1 Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11535
diff changeset
492 @DOCSTRING(matlabroot)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
493
12208
9611014e7cf1 Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11535
diff changeset
494 @DOCSTRING(OCTAVE_VERSION)
8286
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7984
diff changeset
495
6623
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
496 @DOCSTRING(version)
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
497
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
498 @DOCSTRING(ver)
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
499
12208
9611014e7cf1 Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11535
diff changeset
500 @DOCSTRING(compare_versions)
9611014e7cf1 Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11535
diff changeset
501
9611014e7cf1 Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11535
diff changeset
502 @DOCSTRING(license)
9611014e7cf1 Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11535
diff changeset
503
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
504 @DOCSTRING(octave_config_info)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
505
13943
5820f8ce683e doc: Add undocumented functions to manual for 3.6.0 release
Rik <octave@nomad.inbox5.com>
parents: 13860
diff changeset
506 @DOCSTRING(usejava)
5820f8ce683e doc: Add undocumented functions to manual for 3.6.0 release
Rik <octave@nomad.inbox5.com>
parents: 13860
diff changeset
507
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
508 @DOCSTRING(getrusage)
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
509
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
510 @node Hashing Functions
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
511 @section Hashing Functions
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
512
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
513 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
514 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
515 and looking for differences. However, this can be slow, and so comparing
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
516 a hash of the string or file can be a rapid way of finding if the files
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
517 differ.
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
518
9079
4d610aba7347 Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
519 Another use of the hashing function is to check for file integrity. The
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
520 user can check the hash of the file against a known value and find if
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
521 the file they have is the same as the one that the original hash was
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
522 produced with.
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
523
7007
6304d9ea0a30 [project @ 2007-10-11 16:26:36 by jwe]
jwe
parents: 6939
diff changeset
524 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
525 strings and files. An example of the use of @code{md5sum} function might
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
526 be
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
527
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
528 @example
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
529 @group
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
530 if exist (file, "file")
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
531 hash = md5sum (file);
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
532 else
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
533 # Treat the variable "file" as a string
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
534 hash = md5sum (file, true);
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
535 endif
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
536 @end group
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
537 @end example
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
538
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
539 @DOCSTRING(md5sum)