Mercurial > octave-antonio

annotate doc/interpreter/system.txi @ 6939:46d1ad37d943

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2007-10-01 16:12:20 by jwe]
author jwe
date Mon, 01 Oct 2007 16:12:20 +0000
parents 975fcdfb0d2d
children 6304d9ea0a30
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6778
083721ae3dfa [project @ 2007-07-18 17:03:10 by jwe]
jwe
parents: 6702
diff changeset
1 @c Copyright (C) 1996, 1997, 2007 John W. Eaton
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
2 @c This is part of the Octave manual.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
3 @c For copying conditions, see the file gpl.texi.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
4
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
5 @node System Utilities
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
6 @chapter System Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
7
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
8 This chapter describes the functions that are available to allow you to
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
9 get information about what is happening outside of Octave, while it is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
10 still running, and use this information in your program. For example,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
11 you can get information about environment variables, the current time,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
12 and even start other programs from the Octave prompt.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
13
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
14 @menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
15 * Timing Utilities::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
16 * Filesystem Utilities::
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
17 * File Archiving Utilities::
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
18 * Networking Utilities::
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
19 * Controlling Subprocesses::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
20 * Process ID Information::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
21 * Environment Variables::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
22 * Current Working Directory::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
23 * Password Database Functions::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
24 * Group Database Functions::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
25 * System Information::
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
26 * Hashing Functions::
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
27 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
28
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
29 @node Timing Utilities
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
30 @section Timing Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
31
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
32 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
33 patterned after the corresponding functions from the standard C library.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
34 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
35 the following elements:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
36
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
37 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
38 @item usec
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
39 Microseconds after the second (0-999999).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
40
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
41 @item sec
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
42 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
43 for leap seconds.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
44
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
45 @item min
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
46 Minutes after the hour (0-59).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
47
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
48 @item hour
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
49 Hours since midnight (0-23).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
50
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
51 @item mday
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
52 Day of the month (1-31).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
53
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
54 @item mon
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
55 Months since January (0-11).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
56
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
57 @item year
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
58 Years since 1900.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
59
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
60 @item wday
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
61 Days since Sunday (0-6).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
62
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
63 @item yday
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
64 Days since January 1 (0-365).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
65
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
66 @item isdst
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
67 Daylight Savings Time flag.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
68
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
69 @item zone
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
70 Time zone.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
71 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
72
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
73 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
74 In the descriptions of the following functions, this structure is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
75 referred to as a @var{tm_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
76
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
77 @DOCSTRING(time)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
78
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
79 @DOCSTRING(now)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
80
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
81 @DOCSTRING(ctime)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
82
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
83 @DOCSTRING(gmtime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
84
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
85 @DOCSTRING(localtime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
86
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
87 @DOCSTRING(mktime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
88
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
89 @DOCSTRING(asctime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
90
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
91 @DOCSTRING(strftime)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
92
4169
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
93 @DOCSTRING(strptime)
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
94
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
95 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
96 patterned after the standard C library. Some are available for
6939
46d1ad37d943 [project @ 2007-10-01 16:12:20 by jwe]
jwe
parents: 6868
diff changeset
97 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
98 useful.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
99
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
100 @DOCSTRING(clock)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
101
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
102 @DOCSTRING(date)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
103
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
104 @DOCSTRING(etime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
105
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
106 @DOCSTRING(cputime)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
107
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
108 @DOCSTRING(is_leap_year)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
109
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
110 @DOCSTRING(tic)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
111
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
112 @DOCSTRING(pause)
3294
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(sleep)
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(usleep)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
117
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
118 @DOCSTRING( datenum)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
119
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
120 @DOCSTRING(datestr)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
121
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
122 @DOCSTRING(datevec)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
123
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
124 @DOCSTRING(calendar)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
125
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
126 @DOCSTRING(weekday)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
127
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
128 @DOCSTRING(eomday)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 4169
diff changeset
129
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
130 @node Filesystem Utilities
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
131 @section Filesystem Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
132
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
133 Octave includes the following functions for renaming and deleting files,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
134 creating, deleting, and reading directories, and for getting information
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
135 about the status of files.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
136
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
137 @DOCSTRING(rename)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
138
3710
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
139 @DOCSTRING(link)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
140
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
141 @DOCSTRING(symlink)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe]
jwe
parents: 3452
diff changeset
142
4169
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
143 @DOCSTRING(readlink)
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe]
jwe
parents: 4167
diff changeset
144
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
145 @DOCSTRING(unlink)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
146
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
147 @DOCSTRING(readdir)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
148
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
149 @DOCSTRING(mkdir)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
150
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
151 @DOCSTRING(rmdir)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
152
6550
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
153 @DOCSTRING(confirm_recursive_rmdir)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
154
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
155 @DOCSTRING(mkfifo)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
156
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
157 @DOCSTRING(umask)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
158
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
159 @DOCSTRING(stat)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
160
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
161 @DOCSTRING(lstat)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
162
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
163 @DOCSTRING(fileattrib)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
164
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
165 @DOCSTRING(isdir)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
166
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
167 @DOCSTRING(glob)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
168
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3301
diff changeset
169 @DOCSTRING(fnmatch)
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3301
diff changeset
170
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
171 @DOCSTRING(file_in_path)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
172
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
173 @DOCSTRING(tilde_expand)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
174
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
175 @DOCSTRING(canonicalize_file_name)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
176
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
177 @DOCSTRING(movefile)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
178
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
179 @DOCSTRING(copyfile)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
180
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
181 @DOCSTRING(fileparts)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
182
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
183 @DOCSTRING(filesep)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
184
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
185 @DOCSTRING(fullfile)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
186
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
187 @DOCSTRING(tempdir)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
188
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
189 @DOCSTRING(tempname)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
190
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
191 @DOCSTRING(P_tmpdir)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
192
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
193 @node File Archiving Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
194 @section File Archiving Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
195
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
196 @DOCSTRING(bunzip2)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
197
6868
975fcdfb0d2d [project @ 2007-09-06 16:34:29 by dbateman]
dbateman
parents: 6778
diff changeset
198 @DOCSTRING(gzip)
975fcdfb0d2d [project @ 2007-09-06 16:34:29 by dbateman]
dbateman
parents: 6778
diff changeset
199
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
200 @DOCSTRING(gunzip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
201
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
202 @DOCSTRING(tar)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
203
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
204 @DOCSTRING(untar)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
205
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
206 @DOCSTRING(zip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
207
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
208 @DOCSTRING(unzip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
209
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
210 @DOCSTRING(pack)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
211
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
212 @DOCSTRING(unpack)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
213
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
214 @node Networking Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
215 @section Networking Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
216
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
217 @DOCSTRING(urlread)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
218
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
219 @DOCSTRING(urlwrite)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
220
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
221 @node Controlling Subprocesses
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
222 @section Controlling Subprocesses
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
223
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
224 Octave includes some high-level commands like @code{system} and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
225 @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
226 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
227 probably want to use these functions.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
228
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
229 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
230 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
231 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
232 higher-level functions.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
233
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
234 @DOCSTRING(system)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
235
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
236 @DOCSTRING(unix)
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(dos)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
239
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
240 @DOCSTRING(popen)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
241
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
242 @DOCSTRING(pclose)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
243
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
244 @DOCSTRING(popen2)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
245
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
246 @DOCSTRING(EXEC_PATH)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
247
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
248 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
249 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
250 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
251
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
252 @DOCSTRING(fork)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
253
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
254 @DOCSTRING(exec)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
255
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
256 @DOCSTRING(pipe)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
257
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
258 @DOCSTRING(dup2)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
259
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
260 @DOCSTRING(waitpid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
261
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
262 @DOCSTRING(fcntl)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
263
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
264 @DOCSTRING(kill)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
265
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
266 @DOCSTRING(SIG)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
267
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
268 @node Process ID Information
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
269 @section Process, Group, and User IDs
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
270
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
271 @DOCSTRING(getpgrp)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
272
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
273 @DOCSTRING(getpid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
274
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
275 @DOCSTRING(getppid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
276
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
277 @DOCSTRING(geteuid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
278
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
279 @DOCSTRING(getuid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
280
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
281 @DOCSTRING(getegid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
282
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
283 @DOCSTRING(getgid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
284
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
285 @node Environment Variables
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
286 @section Environment Variables
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
287
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
288 @DOCSTRING(getenv)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
289
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
290 @DOCSTRING(putenv)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
291
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
292 @node Current Working Directory
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
293 @section Current Working Directory
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
294
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
295 @DOCSTRING(cd)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
296
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
297 @DOCSTRING(ls)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
298
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
299 @DOCSTRING(ls_command)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
300
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
301 @DOCSTRING(dir)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
302
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
303 @DOCSTRING(pwd)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
304
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
305 @node Password Database Functions
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
306 @section Password Database Functions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
307
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
308 Octave's password database functions return information in a structure
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
309 with the following fields.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
310
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
311 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
312 @item name
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
313 The user name.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
314
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
315 @item passwd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
316 The encrypted password, if available.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
317
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
318 @item uid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
319 The numeric user id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
320
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
321 @item gid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
322 The numeric group id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
323
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
324 @item gecos
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
325 The GECOS field.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
326
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
327 @item dir
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
328 The home directory.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
329
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
330 @item shell
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
331 The initial shell.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
332 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
333
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
334 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
335 referred to as a @var{pw_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
336
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
337 @DOCSTRING(getpwent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
338
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
339 @DOCSTRING(getpwuid)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
340
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
341 @DOCSTRING(getpwnam)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
342
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
343 @DOCSTRING(setpwent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
344
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
345 @DOCSTRING(endpwent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
346
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
347 @node Group Database Functions
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
348 @section Group Database Functions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
349
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
350 Octave's group database functions return information in a structure
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
351 with the following fields.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
352
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
353 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
354 @item name
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
355 The user name.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
356
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
357 @item passwd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
358 The encrypted password, if available.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
359
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
360 @item gid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
361 The numeric group id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
362
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
363 @item mem
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
364 The members of the group.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
365 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
366
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
367 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
368 referred to as a @var{grp_struct}.
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(getgrent)
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(getgrgid)
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
373
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
374 @DOCSTRING(getgrnam)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
375
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
376 @DOCSTRING(setgrent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
377
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
378 @DOCSTRING(endgrent)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
379
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3710
diff changeset
380 @node System Information
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
381 @section System Information
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
382
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
383 @DOCSTRING(computer)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
384
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
385 @DOCSTRING(uname)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
386
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
387 @DOCSTRING(ispc)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
388
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
389 @DOCSTRING(isunix)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6502
diff changeset
390
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
391 @DOCSTRING(isieee)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
392
6623
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
393 @DOCSTRING(OCTAVE_HOME)
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
394
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
395 @DOCSTRING(OCTAVE_VERSION)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
396
6623
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
397 @DOCSTRING(version)
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
398
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
399 @DOCSTRING(ver)
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe]
jwe
parents: 6550
diff changeset
400
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
401 @DOCSTRING(octave_config_info)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
402
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 3294
diff changeset
403 @DOCSTRING(getrusage)
6702
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
404
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
405 @node Hashing Functions
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
406 @section Hashing Functions
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
407
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
408 It is often necessary to find if two strings or files are
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
409 identical. This might be done by comparing them character by character
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
410 and looking for differences. However, this can be slow, and so comparing
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
411 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
412 differ.
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
413
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
414 Another use of the hashing function is to check for file integrity. The
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
415 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
416 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
417 produced with.
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
418
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
419 Octave supplies the @code{md5sum} function to perfrom MD5 hashes on
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
420 strings and files. An example of the use of @code{md5sum} function might
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
421 be
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
422
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
423 @example
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
424 @group
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
425 if exist (file, "file")
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
426 hash = md5sum (file);
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
427 else
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
428 # Treat the variable "file" as a string
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
429 hash = md5sum (file, true);
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
430 endif
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
431 @end group
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
432 @end example
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
433
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman]
dbateman
parents: 6623
diff changeset
434 @DOCSTRING(md5sum)