octave: doc/interpreter/system.txi annotate

annotate doc/interpreter/system.txi @ 20923:58263bea2fdf

Unified "sleep" functions to "octave_sleep" in C++ and "pause" in Octave. * doc/interpreter/system.txi: removed sleep and usleep from doc. * libinterp/corefcn/sysdep.cc (pause): updated docstring. * libinterp/corefcn/sysdep.cc (sleep): moved to deprecate sleep.m. * libinterp/corefcn/sysdep.cc (usleep): moved to deprecate usleep.m. * scripts/deprecated/sleep.m: moved here from sysdep.cc. * scripts/deprecated/usleep.m: moved here from sysdep.cc. * scripts/deprecated/module.mk: add sleep.m and usleep.m to build system. * NEWS: deprecation news for sleep and usleep. * libinterp/corefcn/data.cc: examples updated. * libinterp/corefcn/syscalls.cc: examples updated. * scripts/audio/@audioplayer/audioplayer.m: examples updated. * scripts/audio/@audiorecorder/audiorecorder.m: examples updated. * scripts/plot/util/ginput.m: examples updated. * scripts/plot/util/private/__gnuplot_get_var__.m: use pause. * scripts/plot/util/private/__gnuplot_ginput__.m: use pause. * libinterp/corefcn/utils.cc (octave_sleep): Unified "sleep" functions here. * libinterp/corefcn/utils.h: removed header cutils.h. * libinterp/corefcn/graphics.cc (drawnow): use octave_sleep. * libinterp/corefcn/graphics.cc (waitfor): use octave_sleep. * libinterp/corefcn/toplev.cc (clean_up_and_exit): use octave_sleep. * libinterp/corefcn/cutils.c: removed no longer needed code. * libinterp/corefcn/cutils.h: removed no longer needed header. * libinterp/corefcn/matherr.c: removed orphaned code. * libinterp/corefcn/module.mk: removed cutils.h, cutils.c, and matherr.c from build system.

author	Kai T. Ohlhus <k.ohlhus@gmail.com>
date	Thu, 17 Dec 2015 16:04:13 +0100
parents	69489c064cb7
children	1da428cbf401

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19596 diff changeset	1 @c Copyright (C) 1996-2015 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.
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	9 @c
7018 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.
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	14 @c
7018 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
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	29 * Timing Utilities::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 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::
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	33 * Controlling Subprocesses::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	34 * Process ID Information::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	35 * Environment Variables::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	36 * Current Working Directory::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	37 * Password Database Functions::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 diff changeset	38 * Group Database Functions::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17097 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
14570 d07d96e53612 seconds after the minute can be 0-60, not 0-61 John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	56 Seconds after the minute (0-60). This number can be 60 to account
3294 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
20375 31f89b12aaf7 strftime: Add support for "%z" conversion specifier (bug #45592) Mike Miller <mtmiller@octave.org> parents: 20024 diff changeset	83 @item gmtoff
31f89b12aaf7 strftime: Add support for "%z" conversion specifier (bug #45592) Mike Miller <mtmiller@octave.org> parents: 20024 diff changeset	84 Seconds offset from UTC.
31f89b12aaf7 strftime: Add support for "%z" conversion specifier (bug #45592) Mike Miller <mtmiller@octave.org> parents: 20024 diff changeset	85
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	86 @item zone
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	87 Time zone.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	88 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	89
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	90 @noindent
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	91 In the descriptions of the following functions, this structure is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	92 referred to as a @var{tm_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	93
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	94 @DOCSTRING(time)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	95
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	96 @DOCSTRING(now)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	97
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	98 @DOCSTRING(ctime)
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(gmtime)
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(localtime)
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(mktime)
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(asctime)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	107
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	108 @DOCSTRING(strftime)
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	109
4169 d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe] jwe parents: 4167 diff changeset	110 @DOCSTRING(strptime)
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe] jwe parents: 4167 diff changeset	111
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	112 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	113 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	114 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	115 useful.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	116
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	117 @DOCSTRING(clock)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	118
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	119 @DOCSTRING(date)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	120
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	121 @DOCSTRING(etime)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	122
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	123 @DOCSTRING(cputime)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	124
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	125 @DOCSTRING(is_leap_year)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	126
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16812 diff changeset	127 @anchor{XREFtoc}
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	128 @DOCSTRING(tic)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	129
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	130 @DOCSTRING(pause)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	131
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7018 diff changeset	132 @DOCSTRING(datenum)
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	133
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	134 @DOCSTRING(datestr)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	135
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	136 @DOCSTRING(datevec)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	137
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7018 diff changeset	138 @DOCSTRING(addtodate)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7018 diff changeset	139
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	140 @DOCSTRING(calendar)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	141
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	142 @DOCSTRING(weekday)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	143
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	144 @DOCSTRING(eomday)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 4169 diff changeset	145
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	146 @DOCSTRING(datetick)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	147
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3710 diff changeset	148 @node Filesystem Utilities
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	149 @section Filesystem Utilities
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	150
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12568 diff changeset	151 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	152 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	153 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	154
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	155 @DOCSTRING(movefile)
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(rename)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	158
12211 11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	159 @DOCSTRING(copyfile)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	160
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	161 @DOCSTRING(unlink)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	162
3710 9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3452 diff changeset	163 @DOCSTRING(link)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3452 diff changeset	164
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3452 diff changeset	165 @DOCSTRING(symlink)
9a77deefb8c9 [project @ 2000-08-02 20:47:44 by jwe] jwe parents: 3452 diff changeset	166
4169 d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe] jwe parents: 4167 diff changeset	167 @DOCSTRING(readlink)
d5667eaf8859 [project @ 2002-11-12 03:13:42 by jwe] jwe parents: 4167 diff changeset	168
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	169 @DOCSTRING(mkdir)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	170
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	171 @DOCSTRING(rmdir)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	172
6550 1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	173 @DOCSTRING(confirm_recursive_rmdir)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	174
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	175 @DOCSTRING(mkfifo)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	176
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	177 @DOCSTRING(umask)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	178
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16812 diff changeset	179 @anchor{XREFlstat}
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	180 @DOCSTRING(stat)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	181
12211 11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	182 @DOCSTRING(S_ISBLK)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	183
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	184 @DOCSTRING(S_ISCHR)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	185
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	186 @DOCSTRING(S_ISDIR)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	187
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	188 @DOCSTRING(S_ISFIFO)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	189
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	190 @DOCSTRING(S_ISLNK)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	191
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	192 @DOCSTRING(S_ISREG)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	193
12212 f1ab2a12b4f4 Add S_ISSOCK function to documentation. Rik <octave@nomad.inbox5.com> parents: 12211 diff changeset	194 @DOCSTRING(S_ISSOCK)
f1ab2a12b4f4 Add S_ISSOCK function to documentation. Rik <octave@nomad.inbox5.com> parents: 12211 diff changeset	195
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	196 @DOCSTRING(fileattrib)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	197
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	198 @DOCSTRING(isdir)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	199
12211 11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	200 @DOCSTRING(readdir)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	201
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	202 @DOCSTRING(glob)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	203
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	204 @DOCSTRING(file_in_path)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	205
12211 11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	206 @DOCSTRING(filesep)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	207
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	208 @DOCSTRING(filemarker)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	209
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	210 @DOCSTRING(fileparts)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	211
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	212 @DOCSTRING(fullfile)
11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	213
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	214 @DOCSTRING(tilde_expand)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	215
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	216 @DOCSTRING(canonicalize_file_name)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	217
12211 11faa69c4eaa Add S_ISBLK and family of functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12208 diff changeset	218 @DOCSTRING(make_absolute_filename)
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	219
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8653 diff changeset	220 @DOCSTRING(is_absolute_filename)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8653 diff changeset	221
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8653 diff changeset	222 @DOCSTRING(is_rooted_relative_filename)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8653 diff changeset	223
13843 c299b26d0e6b missing change from changeset 69afe121f07e John W. Eaton <jwe@octave.org> parents: 12580 diff changeset	224 @DOCSTRING(recycle)
c299b26d0e6b missing change from changeset 69afe121f07e John W. Eaton <jwe@octave.org> parents: 12580 diff changeset	225
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	226 @node File Archiving Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	227 @section File Archiving Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	228
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	229 @DOCSTRING(bunzip2)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	230
6868 975fcdfb0d2d [project @ 2007-09-06 16:34:29 by dbateman] dbateman parents: 6778 diff changeset	231 @DOCSTRING(gzip)
975fcdfb0d2d [project @ 2007-09-06 16:34:29 by dbateman] dbateman parents: 6778 diff changeset	232
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	233 @DOCSTRING(gunzip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	234
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	235 @DOCSTRING(tar)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	236
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	237 @DOCSTRING(untar)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	238
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	239 @DOCSTRING(zip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	240
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	241 @DOCSTRING(unzip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	242
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	243 @DOCSTRING(unpack)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	244
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	245 @DOCSTRING(bzip2)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	246
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	247 @node Networking Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	248 @section Networking Utilities
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	249
9880 7f77e5081e83 Add ftp objects David Bateman <dbateman@free.fr> parents: 9079 diff changeset	250 @menu
11255 d682cd6669ac Update info-based documentation menus to include new nodes. Rik <octave@nomad.inbox5.com> parents: 9891 diff changeset	251 * FTP Objects::
d682cd6669ac Update info-based documentation menus to include new nodes. Rik <octave@nomad.inbox5.com> parents: 9891 diff changeset	252 * URL Manipulation::
16812 366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	253 * Base64 and Binary Data Transmission::
9880 7f77e5081e83 Add ftp objects David Bateman <dbateman@free.fr> parents: 9079 diff changeset	254 @end menu
7f77e5081e83 Add ftp objects David Bateman <dbateman@free.fr> parents: 9079 diff changeset	255
12514 e5e66c389597 Add gethostname to documentation. Rik <octave@nomad.inbox5.com> parents: 12512 diff changeset	256 @DOCSTRING(gethostname)
e5e66c389597 Add gethostname to documentation. Rik <octave@nomad.inbox5.com> parents: 12512 diff changeset	257
11255 d682cd6669ac Update info-based documentation menus to include new nodes. Rik <octave@nomad.inbox5.com> parents: 9891 diff changeset	258 @node FTP Objects
d682cd6669ac Update info-based documentation menus to include new nodes. Rik <octave@nomad.inbox5.com> parents: 9891 diff changeset	259 @subsection FTP Objects
9880 7f77e5081e83 Add ftp objects David Bateman <dbateman@free.fr> parents: 9079 diff changeset	260
14217 7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	261 Octave supports the FTP protocol through an object-oriented interface.
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	262 Use the function @code{ftp} to create an FTP object which represents the
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	263 connection. All FTP functions take an FTP object as the first argument.
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	264
9891 1506a17832c9 doc building fixes for class methods John W. Eaton <jwe@octave.org> parents: 9880 diff changeset	265 @DOCSTRING(@ftp/ftp)
9880 7f77e5081e83 Add ftp objects David Bateman <dbateman@free.fr> parents: 9079 diff changeset	266
14217 7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	267 @DOCSTRING(@ftp/close)
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	268
9891 1506a17832c9 doc building fixes for class methods John W. Eaton <jwe@octave.org> parents: 9880 diff changeset	269 @DOCSTRING(@ftp/mget)
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/mput)
9880 7f77e5081e83 Add ftp objects David Bateman <dbateman@free.fr> parents: 9079 diff changeset	272
14217 7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	273 @DOCSTRING(@ftp/cd)
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	274
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	275 @DOCSTRING(@ftp/dir)
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	276
9891 1506a17832c9 doc building fixes for class methods John W. Eaton <jwe@octave.org> parents: 9880 diff changeset	277 @DOCSTRING(@ftp/ascii)
9880 7f77e5081e83 Add ftp objects David Bateman <dbateman@free.fr> parents: 9079 diff changeset	278
9891 1506a17832c9 doc building fixes for class methods John W. Eaton <jwe@octave.org> parents: 9880 diff changeset	279 @DOCSTRING(@ftp/binary)
9880 7f77e5081e83 Add ftp objects David Bateman <dbateman@free.fr> parents: 9079 diff changeset	280
14217 7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	281 @DOCSTRING(@ftp/delete)
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	282
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	283 @DOCSTRING(@ftp/rename)
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	284
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	285 @DOCSTRING(@ftp/mkdir)
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	286
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	287 @DOCSTRING(@ftp/rmdir)
7912e682aa30 doc: Update docstrings for @ftp class. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	288
11255 d682cd6669ac Update info-based documentation menus to include new nodes. Rik <octave@nomad.inbox5.com> parents: 9891 diff changeset	289 @node URL Manipulation
d682cd6669ac Update info-based documentation menus to include new nodes. Rik <octave@nomad.inbox5.com> parents: 9891 diff changeset	290 @subsection URL Manipulation
9880 7f77e5081e83 Add ftp objects David Bateman <dbateman@free.fr> parents: 9079 diff changeset	291
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	292 @DOCSTRING(urlread)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	293
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	294 @DOCSTRING(urlwrite)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	295
16812 366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	296 @node Base64 and Binary Data Transmission
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	297 @subsection Base64 and Binary Data Transmission
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	298
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	299 Some transmission channels can not accept binary data. It is customary to
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	300 encode binary data in Base64 for transmission and to decode the data upon
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	301 reception.
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	302
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	303 @DOCSTRING(base64_encode)
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	304
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	305 @DOCSTRING(base64_decode)
366a13bd71d5 doc: Add base64_encode()/base64_decode() to documentation. Rik <rik@octave.org> parents: 16772 diff changeset	306
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3710 diff changeset	307 @node Controlling Subprocesses
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	308 @section Controlling Subprocesses
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	309
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	310 Octave includes some high-level commands like @code{system} and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	311 @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	312 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	313 probably want to use these functions.
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 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	316 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	317 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	318 higher-level functions.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	319
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	320 @DOCSTRING(system)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	321
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	322 @DOCSTRING(unix)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	323
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	324 @DOCSTRING(dos)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	325
19271 030d56f67363 implement the open function John W. Eaton <jwe@octave.org> parents: 19167 diff changeset	326 @DOCSTRING(open)
030d56f67363 implement the open function John W. Eaton <jwe@octave.org> parents: 19167 diff changeset	327
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7018 diff changeset	328 @DOCSTRING(perl)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7018 diff changeset	329
13859 6d59b141e65d Add python to manual and respect format rules of copyright block Carnë Draug <carandraug+dev@gmail.com> parents: 12580 diff changeset	330 @DOCSTRING(python)
6d59b141e65d Add python to manual and respect format rules of copyright block Carnë Draug <carandraug+dev@gmail.com> parents: 12580 diff changeset	331
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	332 @DOCSTRING(popen)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	333
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	334 @DOCSTRING(pclose)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	335
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	336 @DOCSTRING(popen2)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	337
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	338 @DOCSTRING(EXEC_PATH)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	339
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	340 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	341 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	342 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	343
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	344 @DOCSTRING(fork)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	345
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	346 @DOCSTRING(exec)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	347
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	348 @DOCSTRING(pipe)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	349
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	350 @DOCSTRING(dup2)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	351
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	352 @DOCSTRING(waitpid)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	353
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	354 @DOCSTRING(WCONTINUE)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	355
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	356 @DOCSTRING(WCOREDUMP)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	357
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	358 @DOCSTRING(WEXITSTATUS)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	359
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	360 @DOCSTRING(WIFCONTINUED)
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	361
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	362 @DOCSTRING(WIFSIGNALED)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	363
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	364 @DOCSTRING(WIFSTOPPED)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	365
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	366 @DOCSTRING(WIFEXITED)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	367
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	368 @DOCSTRING(WNOHANG)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	369
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	370 @DOCSTRING(WSTOPSIG)
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	371
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	372 @DOCSTRING(WTERMSIG)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	373
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	374 @DOCSTRING(WUNTRACED)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	375
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	376 @DOCSTRING(fcntl)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	377
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	378 @DOCSTRING(kill)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	379
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	380 @DOCSTRING(SIG)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	381
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3710 diff changeset	382 @node Process ID Information
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	383 @section Process, Group, and User IDs
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	384
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	385 @DOCSTRING(getpgrp)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	386
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	387 @DOCSTRING(getpid)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	388
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	389 @DOCSTRING(getppid)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	390
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	391 @DOCSTRING(geteuid)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	392
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	393 @DOCSTRING(getuid)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	394
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	395 @DOCSTRING(getegid)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	396
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	397 @DOCSTRING(getgid)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	398
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3710 diff changeset	399 @node Environment Variables
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	400 @section Environment Variables
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	401
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	402 @DOCSTRING(getenv)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	403
19167 6f0290863d50 Add new function unsetenv from gnulib to Octave. Rik <rik@octave.org> parents: 19128 diff changeset	404 @DOCSTRING(setenv)
6f0290863d50 Add new function unsetenv from gnulib to Octave. Rik <rik@octave.org> parents: 19128 diff changeset	405
6f0290863d50 Add new function unsetenv from gnulib to Octave. Rik <rik@octave.org> parents: 19128 diff changeset	406 @DOCSTRING(unsetenv)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	407
20024 cf9b94a89620 Document get_home_directory in Octave manual and NEWS file. Rik <rik@octave.org> parents: 19697 diff changeset	408 @DOCSTRING(get_home_directory)
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file. Rik <rik@octave.org> parents: 19697 diff changeset	409
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3710 diff changeset	410 @node Current Working Directory
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	411 @section Current Working Directory
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	412
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	413 @DOCSTRING(cd)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	414
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	415 @DOCSTRING(ls)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	416
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	417 @DOCSTRING(ls_command)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	418
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	419 @DOCSTRING(dir)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	420
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	421 @DOCSTRING(pwd)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	422
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3710 diff changeset	423 @node Password Database Functions
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	424 @section Password Database Functions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	425
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	426 Octave's password database functions return information in a structure
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	427 with the following fields.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	428
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	429 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	430 @item name
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	431 The user name.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	432
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	433 @item passwd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	434 The encrypted password, if available.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	435
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	436 @item uid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	437 The numeric user id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	438
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	439 @item gid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	440 The numeric group id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	441
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	442 @item gecos
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	443 The GECOS field.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	444
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	445 @item dir
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	446 The home directory.
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 shell
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	449 The initial shell.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	450 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	451
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	452 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	453 referred to as a @var{pw_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	454
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	455 @DOCSTRING(getpwent)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	456
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	457 @DOCSTRING(getpwuid)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	458
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	459 @DOCSTRING(getpwnam)
3294 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(setpwent)
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(endpwent)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	464
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3710 diff changeset	465 @node Group Database Functions
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	466 @section Group Database Functions
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	467
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	468 Octave's group database functions return information in a structure
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	469 with the following fields.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	470
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	471 @table @code
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	472 @item name
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	473 The user name.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	474
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	475 @item passwd
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	476 The encrypted password, if available.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	477
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	478 @item gid
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	479 The numeric group id.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	480
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	481 @item mem
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	482 The members of the group.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	483 @end table
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	484
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	485 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	486 referred to as a @var{grp_struct}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	487
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	488 @DOCSTRING(getgrent)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	489
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	490 @DOCSTRING(getgrgid)
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17152 diff changeset	491
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	492 @DOCSTRING(getgrnam)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	493
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	494 @DOCSTRING(setgrent)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	495
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	496 @DOCSTRING(endgrent)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	497
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3710 diff changeset	498 @node System Information
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	499 @section System Information
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	500
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	501 @DOCSTRING(computer)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	502
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	503 @DOCSTRING(uname)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	504
12512 77b14e634166 Replace nprocs with nproc function. Use gnulib module for portability across platforms. Iain Murray <iain@iainmurray.net> parents: 12510 diff changeset	505 @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	506
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	507 @DOCSTRING(ispc)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	508
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	509 @DOCSTRING(isunix)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6502 diff changeset	510
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	511 @DOCSTRING(ismac)
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	512
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	513 @DOCSTRING(isieee)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	514
12568 b22816427ce9 Add isdeployed function to documentation. Rik <octave@nomad.inbox5.com> parents: 12514 diff changeset	515 @DOCSTRING(isdeployed)
b22816427ce9 Add isdeployed function to documentation. Rik <octave@nomad.inbox5.com> parents: 12514 diff changeset	516
19128 4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19120 diff changeset	517 @DOCSTRING(isstudent)
4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19120 diff changeset	518
6623 545847da3b88 [project @ 2007-05-15 02:23:08 by jwe] jwe parents: 6550 diff changeset	519 @DOCSTRING(OCTAVE_HOME)
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe] jwe parents: 6550 diff changeset	520
12208 9611014e7cf1 Add function compare_versions to documentation. Rik <octave@nomad.inbox5.com> parents: 11535 diff changeset	521 @DOCSTRING(matlabroot)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	522
12208 9611014e7cf1 Add function compare_versions to documentation. Rik <octave@nomad.inbox5.com> parents: 11535 diff changeset	523 @DOCSTRING(OCTAVE_VERSION)
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7984 diff changeset	524
6623 545847da3b88 [project @ 2007-05-15 02:23:08 by jwe] jwe parents: 6550 diff changeset	525 @DOCSTRING(version)
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe] jwe parents: 6550 diff changeset	526
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe] jwe parents: 6550 diff changeset	527 @DOCSTRING(ver)
545847da3b88 [project @ 2007-05-15 02:23:08 by jwe] jwe parents: 6550 diff changeset	528
12208 9611014e7cf1 Add function compare_versions to documentation. Rik <octave@nomad.inbox5.com> parents: 11535 diff changeset	529 @DOCSTRING(compare_versions)
9611014e7cf1 Add function compare_versions to documentation. Rik <octave@nomad.inbox5.com> parents: 11535 diff changeset	530
9611014e7cf1 Add function compare_versions to documentation. Rik <octave@nomad.inbox5.com> parents: 11535 diff changeset	531 @DOCSTRING(license)
9611014e7cf1 Add function compare_versions to documentation. Rik <octave@nomad.inbox5.com> parents: 11535 diff changeset	532
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	533 @DOCSTRING(octave_config_info)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	534
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3294 diff changeset	535 @DOCSTRING(getrusage)
6702 b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman] dbateman parents: 6623 diff changeset	536
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman] dbateman parents: 6623 diff changeset	537 @node Hashing Functions
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman] dbateman parents: 6623 diff changeset	538 @section Hashing Functions
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman] dbateman parents: 6623 diff changeset	539
20913 69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20375 diff changeset	540 It is often necessary to find if two strings or files are identical.
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20375 diff changeset	541 This might be done by comparing them character by character and looking
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20375 diff changeset	542 for differences. However, this can be slow, and so comparing a hash of
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20375 diff changeset	543 the string or file can be a rapid way of finding if the files differ.
6702 b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman] dbateman parents: 6623 diff changeset	544
9079 4d610aba7347 Cleanup documentation for system.texi, package.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	545 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	546 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	547 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	548 produced with.
b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman] dbateman parents: 6623 diff changeset	549
20913 69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20375 diff changeset	550 Octave supplies the @code{hash} function to calculate hash values of
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20375 diff changeset	551 strings and files, the latter in combination with the @code{fileread}
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20375 diff changeset	552 function. The @code{hash} function supports the most common used
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20375 diff changeset	553 cryptographic hash functions, namely MD5 and SHA-1.
6702 b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman] dbateman parents: 6623 diff changeset	554
20913 69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20375 diff changeset	555 @DOCSTRING(hash)
6702 b2391d403ed2 [project @ 2007-06-12 21:39:26 by dbateman] dbateman parents: 6623 diff changeset	556

Mercurial > octave

annotate doc/interpreter/system.txi @ 20923:58263bea2fdf