From a89e8854916bb03633fd47a58e51bceb539ce540 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fredrik=20H=C3=BCbinette=20=28Hubbe=29?= <hubbe@hubbe.net>
Date: Sun, 18 Feb 1996 05:57:49 +0100
Subject: [PATCH] keywords added
Rev: doc/files/cd:1.1.1.2
Rev: doc/files/file:1.1.1.3
Rev: doc/files/file_stat:1.1.1.3
Rev: doc/files/get_dir:1.1.1.2
Rev: doc/files/getcwd:1.1.1.2
Rev: doc/files/mkdir:1.1.1.2
Rev: doc/files/mv:1.1.1.2
Rev: doc/files/port:1.1.1.2
Rev: doc/files/rm:1.1.1.2
Rev: doc/math/acos:1.1.1.2
Rev: doc/math/asin:1.1.1.2
Rev: doc/math/atan:1.1.1.2
Rev: doc/math/ceil:1.1.1.2
Rev: doc/math/cos:1.1.1.2
Rev: doc/math/exp:1.1.1.2
Rev: doc/math/floor:1.1.1.2
Rev: doc/math/log:1.1.1.2
Rev: doc/math/pow:1.1.1.3
Rev: doc/math/sin:1.1.1.2
Rev: doc/math/sqrt:1.1.1.2
Rev: doc/math/tan:1.1.1.2
Rev: doc/regexp/regexp:1.1.1.2
Rev: doc/sprintf/sprintf:1.1.1.4
---
doc/files/cd | 3 +++
doc/files/file | 24 ++++++++++++------------
doc/files/file_stat | 26 ++++++++++++++------------
doc/files/get_dir | 3 +++
doc/files/getcwd | 3 +++
doc/files/mkdir | 3 +++
doc/files/mv | 3 +++
doc/files/port | 2 +-
doc/files/rm | 4 +++-
doc/math/acos | 3 +++
doc/math/asin | 3 +++
doc/math/atan | 3 +++
doc/math/ceil | 3 +++
doc/math/cos | 3 +++
doc/math/exp | 3 +++
doc/math/floor | 3 +++
doc/math/log | 3 +++
doc/math/pow | 3 +++
doc/math/sin | 3 +++
doc/math/sqrt | 3 +++
doc/math/tan | 3 +++
doc/regexp/regexp | 26 +++++++++++++-------------
doc/sprintf/sprintf | 3 +++
23 files changed, 97 insertions(+), 39 deletions(-)
diff --git a/doc/files/cd b/doc/files/cd
index e7a7e7eea6..e1b63bbf40 100644
--- a/doc/files/cd
+++ b/doc/files/cd
@@ -8,5 +8,8 @@ DESCRIPTION
Change the current directory for the whole LPC process, return
1 for success, 0 otherwise.
+KEYWORDS
+ file
+
SEE ALSO
files/getcwd
\ No newline at end of file
diff --git a/doc/files/file b/doc/files/file
index 251a6202c9..53fc4eb76d 100644
--- a/doc/files/file
+++ b/doc/files/file
@@ -38,12 +38,12 @@ DESCRIPTION
Open a file for read write or append. The variable how should
contain one or more of the following letters:
- 'r' : open file for reading
- 'w' : open file for writing
- 'a' : open file for append (use with 'w')
- 't' : truncate file at close (use with 'w')
- 'c' : create file if it doesn't exist (use with 'w')
- 'x' : fail if file already exist (use with 'c')
+ 'r' open file for reading
+ 'w' open file for writing
+ 'a' open file for append (use with 'w')
+ 't' truncate file at close (use with 'w')
+ 'c' create file if it doesn't exist (use with 'w')
+ 'x' fail if file already exist (use with 'c')
How should _always_ contain at least one of 'r' or 'w'.
@@ -171,17 +171,17 @@ DESCRIPTION
transfer speed when it does.
SEE ALSO
- files/socket, port/accept
-
+ file->open_socket, port->accept
============================================================================
NAME
set_nonblocking - make stream nonblocking
SYNTAX
- void file->set_nonblocking(function read_callback,
- function write_callback,
- function close_callback);
+ void file->set_nonblocking(
+ function read_callback,
+ function write_callback,
+ function close_callback);
DESCRIPTION
This function sets a stream to nonblocking mode. When data arrives on
@@ -305,7 +305,7 @@ DESCRIPTION
the argument a reference to the same file, it creates a new file
with the same properties and places it in the argument.
-EXAMPLE
+EXAMPLE
/* Redirect stdin to come from the file 'foo' */
object o;
o=clone((program)"/precompiled/file");
diff --git a/doc/files/file_stat b/doc/files/file_stat
index c911ac1354..8cccd143ad 100644
--- a/doc/files/file_stat
+++ b/doc/files/file_stat
@@ -10,24 +10,26 @@ SYNTAX
DESCRIPTION
file_stat returns an array of integers describing some properties
- about the file. Currently file_stat return 5 entries:
+ about the file. Currently file_stat return 7 entries:
({
- mode, /* file mode, protection bits etc. etc. */
- size, /* file size for regular files,
- * -2 for dirs,
- * -3 for links,
- * -4 for otherwise
- */
- atime, /* last access time */
- mtime, /* last modify time */
- ctime, /* last status time change */
- uid, /* The user who owns this file */
- gid /* The group this file belongs to */
+ mode, /* file mode, protection bits etc. etc. */
+ size, /* file size for regular files,
+ -2 for dirs,
+ -3 for links,
+ -4 for otherwise */
+ atime, /* last access time */
+ mtime, /* last modify time */
+ ctime, /* last status time change */
+ uid, /* The user who owns this file */
+ gid /* The group this file belongs to */
})
If you give 1 as a second argument, stat does not follow links.
You can never get -3 as size if you don't give a second argument.
If there is no such file or directory, zero is returned.
+KEYWORDS
+ file
+
SEE ALSO
files/get_dir
diff --git a/doc/files/get_dir b/doc/files/get_dir
index c344114abd..aa7aa6df87 100644
--- a/doc/files/get_dir
+++ b/doc/files/get_dir
@@ -8,5 +8,8 @@ DESCRIPTION
Return an array of all filenames in the directory dir, or zero if
no such directory exists.
+KEYWORDS
+ file
+
SEE ALSO
files/mkdir, files/cd
diff --git a/doc/files/getcwd b/doc/files/getcwd
index d3c010ec8e..7d6ec4b385 100644
--- a/doc/files/getcwd
+++ b/doc/files/getcwd
@@ -7,5 +7,8 @@ SYNTAX
DESCRIPTION
getcwd returns the current working directory.
+KEYWORDS
+ file
+
SEE ALSO
files/cd
diff --git a/doc/files/mkdir b/doc/files/mkdir
index 780d8ed253..49c9ae7596 100644
--- a/doc/files/mkdir
+++ b/doc/files/mkdir
@@ -7,5 +7,8 @@ SYNTAX
DESCRIPTION
Create a directory, return zero if it fails and nonzero if it fails.
+KEYWORDS
+ file
+
SEE ALSO
files/rm, files/cd
diff --git a/doc/files/mv b/doc/files/mv
index c76ea4cb86..679710b241 100644
--- a/doc/files/mv
+++ b/doc/files/mv
@@ -9,5 +9,8 @@ DESCRIPTION
file already exists, it will be overwritten. Returns 1 on sucess,
0 otherwise.
+KEYWORDS
+ file
+
SEE ALSO
files/rm
diff --git a/doc/files/port b/doc/files/port
index fa3c67fab7..92ebfd2b68 100644
--- a/doc/files/port
+++ b/doc/files/port
@@ -133,6 +133,6 @@ DESCRIPTION
/precompiled/file. The new file is by default set to blocking.
SEE ALSO
- file
+ /precompiled/file
============================================================================
diff --git a/doc/files/rm b/doc/files/rm
index fdfbef9ff5..a7a86fef89 100644
--- a/doc/files/rm
+++ b/doc/files/rm
@@ -7,6 +7,8 @@ SYNTAX
DESCRIPTION
Remove a file or directory, return 0 if it fails. Nonzero otherwise.
+KEYWORDS
+ file
+
SEE ALSO
files/mkdir
-
\ No newline at end of file
diff --git a/doc/math/acos b/doc/math/acos
index 0c2f758e37..bd3ca9225b 100644
--- a/doc/math/acos
+++ b/doc/math/acos
@@ -7,5 +7,8 @@ SYNTAX
DESCRIPTION
Return the arcus cosinus value for f.
+KEYWORDS
+ float
+
SEE ALSO
math/cos, math/asin
diff --git a/doc/math/asin b/doc/math/asin
index c71c06156a..af772d5b39 100644
--- a/doc/math/asin
+++ b/doc/math/asin
@@ -7,5 +7,8 @@ SYNTAX
DESCRIPTION
Return the arcus sinus value for f.
+KEYWORDS
+ float
+
SEE ALSO
math/sin, math/acos
diff --git a/doc/math/atan b/doc/math/atan
index 64092f422d..d6ebcb7002 100644
--- a/doc/math/atan
+++ b/doc/math/atan
@@ -7,5 +7,8 @@ SYNTAX
DESCRIPTION
Return the arcus tangent value for f.
+KEYWORDS
+ float
+
SEE ALSO
math/tan, math/asin, math/acos
diff --git a/doc/math/ceil b/doc/math/ceil
index c560d878d0..5017676469 100644
--- a/doc/math/ceil
+++ b/doc/math/ceil
@@ -8,5 +8,8 @@ DESCRIPTION
Return the closest integral value higher or equal to x.
Note that ceil() does _not_ return an int, merely an integral value.
+KEYWORDS
+ float
+
SEE ALSO
math/floor
diff --git a/doc/math/cos b/doc/math/cos
index e8d9536639..921c46ded2 100644
--- a/doc/math/cos
+++ b/doc/math/cos
@@ -7,5 +7,8 @@ SYNTAX
DESCRIPTION
Return the cosinus value for f.
+KEYWORDS
+ float
+
SEE ALSO
math/acos, math/sin
diff --git a/doc/math/exp b/doc/math/exp
index 45698f298f..13963c29de 100644
--- a/doc/math/exp
+++ b/doc/math/exp
@@ -8,5 +8,8 @@ DESCRIPTION
Return the natural exponent of f.
log( exp( x ) ) == x as long as exp(x) doesn't overflow an int.
+KEYWORDS
+ float
+
SEE ALSO
math/pow, math/log
diff --git a/doc/math/floor b/doc/math/floor
index 3dc6cd8826..b257489c99 100644
--- a/doc/math/floor
+++ b/doc/math/floor
@@ -8,5 +8,8 @@ DESCRIPTION
Return the closest integral value lower or equal to x.
Note that floor() does _not_ return an int, merely an integral value.
+KEYWORDS
+ float
+
SEE ALSO
math/ceil
diff --git a/doc/math/log b/doc/math/log
index 80dee7c7f9..e58c48f673 100644
--- a/doc/math/log
+++ b/doc/math/log
@@ -8,5 +8,8 @@ DESCRIPTION
Return the natural logarithm of f.
exp( log(x) ) == x for x > 0.
+KEYWORDS
+ float
+
SEE ALSO
math/pow, math/exp
diff --git a/doc/math/pow b/doc/math/pow
index ad87a22ad4..8bc39e252f 100644
--- a/doc/math/pow
+++ b/doc/math/pow
@@ -7,5 +7,8 @@ SYNTAX
DESCRIPTION
Return n raised to the power of x.
+KEYWORDS
+ float
+
SEE ALSO
math/exp, math/log
diff --git a/doc/math/sin b/doc/math/sin
index 8944254e81..e3d6ae96bf 100644
--- a/doc/math/sin
+++ b/doc/math/sin
@@ -7,5 +7,8 @@ SYNTAX
DESCRIPTION
Return the sinus value for f.
+KEYWORDS
+ float
+
SEE ALSO
math/asin, math/cos
diff --git a/doc/math/sqrt b/doc/math/sqrt
index 6bfa0d6784..c84faca6dc 100644
--- a/doc/math/sqrt
+++ b/doc/math/sqrt
@@ -10,5 +10,8 @@ DESCRIPTION
Return the square root of f, or in the second case, the square root
truncated to the closest lower integer.
+KEYWORDS
+ float, int
+
SEE ALSO
math/pow, math/log, math/exp, math/floor
diff --git a/doc/math/tan b/doc/math/tan
index f78b014e4f..0672360e6f 100644
--- a/doc/math/tan
+++ b/doc/math/tan
@@ -7,5 +7,8 @@ SYNTAX
DESCRIPTION
Return the tangent value for f.
+KEYWORDS
+ float
+
SEE ALSO
math/atan, math/sin, math/cos
diff --git a/doc/regexp/regexp b/doc/regexp/regexp
index a9c0faf941..f2c5b06389 100644
--- a/doc/regexp/regexp
+++ b/doc/regexp/regexp
@@ -6,18 +6,18 @@ DESCRIPTION
regexp package written in C. It contains a few simple functions to
handle regexps. A short description of regexp follows:
- . Matches any character
- [abc] Matches a, b or c
- [a-z] Matches any character a to z inclusive
- [^ac] Matches any character except a and c
- (x) Matches x (x might be any regexp)
- x* Matches zero or more occurances of 'x' (x may be anything)
- x|y Matches x or y. (x or y may be any regexp)
- xy Matches xy (x and y may be any regexp)
- ^ Matches beginning of string (but no characters)
- $ Matches end of string (but no characters)
- <x> Used with split() to put the string matching x into the
- result array.
+ . Matches any character
+ [abc] Matches a, b or c
+ [a-z] Matches any character a to z inclusive
+ [^ac] Matches any character except a and c
+ (x) Matches x (x might be any regexp)
+ x* Matches zero or more occurances of 'x' (x may be anything)
+ x|y Matches x or y. (x or y may be any regexp)
+ xy Matches xy (x and y may be any regexp)
+ ^ Matches beginning of string (but no characters)
+ $ Matches end of string (but no characters)
+ <x> Used with split() to put the string matching x into the
+ result array.
Note that \ can be used to quote these characters in which case
they match themselves, nothing else. Also note that when quoting
@@ -27,7 +27,7 @@ DESCRIPTION
For more information about regexps, refer to your unix manuals such
as sed or ed.
- Descriptions of all functions in /precompiled/file follows:
+ Descriptions of all functions in /precompiled/regexp follows:
============================================================================
NAME
diff --git a/doc/sprintf/sprintf b/doc/sprintf/sprintf
index 87312b54b3..65b26021dc 100644
--- a/doc/sprintf/sprintf
+++ b/doc/sprintf/sprintf
@@ -174,5 +174,8 @@ EXAMPLES
> quit
Exiting.
+KEYWORDS
+ string
+
SEE ALSO
sscanf
--
GitLab