From 5c2a4c0235e7c8dd1cd362ea2d77029333a050d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrik=20Grubbstr=C3=B6m=20=28Grubba=29?= <grubba@grubba.org> Date: Wed, 22 Jan 1997 03:58:28 +0100 Subject: [PATCH] Some documentation Rev: src/modules/system/doc/getegid:1.1 Rev: src/modules/system/doc/geteuid:1.1 Rev: src/modules/system/doc/getgid:1.1 Rev: src/modules/system/doc/getpgrp:1.1 Rev: src/modules/system/doc/getpid:1.1 Rev: src/modules/system/doc/getppid:1.1 Rev: src/modules/system/doc/getuid:1.1 Rev: src/modules/system/doc/hardlink:1.1 Rev: src/modules/system/doc/initgroups:1.1 Rev: src/modules/system/doc/readlink:1.1 Rev: src/modules/system/doc/setegid:1.1 Rev: src/modules/system/doc/seteuid:1.1 Rev: src/modules/system/doc/setgid:1.1 Rev: src/modules/system/doc/setuid:1.1 Rev: src/modules/system/doc/symlink:1.1 --- src/modules/system/doc/getegid | 15 +++++++++++++++ src/modules/system/doc/geteuid | 15 +++++++++++++++ src/modules/system/doc/getgid | 15 +++++++++++++++ src/modules/system/doc/getpgrp | 19 +++++++++++++++++++ src/modules/system/doc/getpid | 14 ++++++++++++++ src/modules/system/doc/getppid | 14 ++++++++++++++ src/modules/system/doc/getuid | 15 +++++++++++++++ src/modules/system/doc/hardlink | 14 ++++++++++++++ src/modules/system/doc/initgroups | 19 +++++++++++++++++++ src/modules/system/doc/readlink | 14 ++++++++++++++ src/modules/system/doc/setegid | 15 +++++++++++++++ src/modules/system/doc/seteuid | 15 +++++++++++++++ src/modules/system/doc/setgid | 15 +++++++++++++++ src/modules/system/doc/setuid | 15 +++++++++++++++ src/modules/system/doc/symlink | 14 ++++++++++++++ 15 files changed, 228 insertions(+) create mode 100644 src/modules/system/doc/getegid create mode 100644 src/modules/system/doc/geteuid create mode 100644 src/modules/system/doc/getgid create mode 100644 src/modules/system/doc/getpgrp create mode 100644 src/modules/system/doc/getpid create mode 100644 src/modules/system/doc/getppid create mode 100644 src/modules/system/doc/getuid create mode 100644 src/modules/system/doc/hardlink create mode 100644 src/modules/system/doc/initgroups create mode 100644 src/modules/system/doc/readlink create mode 100644 src/modules/system/doc/setegid create mode 100644 src/modules/system/doc/seteuid create mode 100644 src/modules/system/doc/setgid create mode 100644 src/modules/system/doc/setuid create mode 100644 src/modules/system/doc/symlink diff --git a/src/modules/system/doc/getegid b/src/modules/system/doc/getegid new file mode 100644 index 0000000000..007da5b5da --- /dev/null +++ b/src/modules/system/doc/getegid @@ -0,0 +1,15 @@ +NAME + getegid - get the effective group ID + +SYNTAX + int getegid(); + +DESCRIPTION + Get the effective group ID. + +KEYWORDS + User security + +SEE ALSO + system/setuid, system/getuid, system/setgid, system/getgid, + system/seteuid, system/geteuid, system/setegid diff --git a/src/modules/system/doc/geteuid b/src/modules/system/doc/geteuid new file mode 100644 index 0000000000..12c90e47d5 --- /dev/null +++ b/src/modules/system/doc/geteuid @@ -0,0 +1,15 @@ +NAME + geteuid - get the effective user ID + +SYNTAX + int geteuid(); + +DESCRIPTION + Get the effective user ID. + +KEYWORDS + User security + +SEE ALSO + system/setuid, system/getuid, system/setgid, system/getgid, + system/seteuid, system/setegid, system/getegid diff --git a/src/modules/system/doc/getgid b/src/modules/system/doc/getgid new file mode 100644 index 0000000000..8f3015953b --- /dev/null +++ b/src/modules/system/doc/getgid @@ -0,0 +1,15 @@ +NAME + getgid - get the group ID + +SYNTAX + int getgid(); + +DESCRIPTION + Get the real group ID. + +KEYWORDS + User security + +SEE ALSO + system/setuid, system/getuid, system/setgid, system/seteuid, + system/geteuid, system/setegid, system/getegid diff --git a/src/modules/system/doc/getpgrp b/src/modules/system/doc/getpgrp new file mode 100644 index 0000000000..022d2b14ec --- /dev/null +++ b/src/modules/system/doc/getpgrp @@ -0,0 +1,19 @@ +NAME + getpgrp - get the process group ID + +SYNTAX + int getpgrp(); + or + int getpgrp(int pid); + +DESCRIPTION + With no argguments or with 'pid' equal to zero, returns the process + group ID of this process. + + If 'pid' is specified, returns the process group ID of that process. + +KEYWORDS + Processes + +SEE ALSO + system/getpid, system/getppid diff --git a/src/modules/system/doc/getpid b/src/modules/system/doc/getpid new file mode 100644 index 0000000000..7401c38e3b --- /dev/null +++ b/src/modules/system/doc/getpid @@ -0,0 +1,14 @@ +NAME + getpid - get the process ID + +SYNTAX + int getpid(); + +DESCRIPTION + Returns the process ID of this process. + +KEYWORDS + Processes + +SEE ALSO + system/getppid, system/getpgrp diff --git a/src/modules/system/doc/getppid b/src/modules/system/doc/getppid new file mode 100644 index 0000000000..78c0ced125 --- /dev/null +++ b/src/modules/system/doc/getppid @@ -0,0 +1,14 @@ +NAME + getppid - get the parent process ID + +SYNTAX + int getppid(); + +DESCRIPTION + Returns the process ID of the parent process. + +KEYWORDS + Processes + +SEE ALSO + system/getpid, system/getpgrp diff --git a/src/modules/system/doc/getuid b/src/modules/system/doc/getuid new file mode 100644 index 0000000000..4e75946bb7 --- /dev/null +++ b/src/modules/system/doc/getuid @@ -0,0 +1,15 @@ +NAME + getuid - get the user ID + +SYNTAX + int getuid(); + +DESCRIPTION + Get the real user ID. + +KEYWORDS + User security + +SEE ALSO + system/setuid, system/setgid, system/getgid, system/seteuid, + system/geteuid, system/setegid, system/getegid diff --git a/src/modules/system/doc/hardlink b/src/modules/system/doc/hardlink new file mode 100644 index 0000000000..3fbb914e9d --- /dev/null +++ b/src/modules/system/doc/hardlink @@ -0,0 +1,14 @@ +NAME + hardlink - create a hardlink + +SYNTAX + void hardlink(string from, string to); + +DESCRIPTION + Creates a hardlink named 'to' from the file 'from'. + +KEYWORDS + file + +SEE ALSO + system/symlink, files/mv, files/rm diff --git a/src/modules/system/doc/initgroups b/src/modules/system/doc/initgroups new file mode 100644 index 0000000000..c0558c8d76 --- /dev/null +++ b/src/modules/system/doc/initgroups @@ -0,0 +1,19 @@ +NAME + initgroups - initialize the group access list + +SYNTAX + void initgroups(string username, int base_gid); + +DESCRIPTION + Initializes the group access list according to the system + group database. 'base_gid' is also added to the group access + list. + +KEYWORDS + User security + +SEE ALSO + system/setuid, system/getuid, system/setgid, system/getgid, + system/seteuid, system/geteuid, system/setegid, system/getegid, + system/getgroups, system/setgroups + diff --git a/src/modules/system/doc/readlink b/src/modules/system/doc/readlink new file mode 100644 index 0000000000..b60f9dd406 --- /dev/null +++ b/src/modules/system/doc/readlink @@ -0,0 +1,14 @@ +NAME + readlink - read a symbolic link + +SYNTAX + string readlink(string linkname); + +DESCRIPTION + Returns what the symbolic link 'linkname' points to. + +KEYWORDS + file + +SEE ALSO + system/symlink diff --git a/src/modules/system/doc/setegid b/src/modules/system/doc/setegid new file mode 100644 index 0000000000..9fcd4dae2c --- /dev/null +++ b/src/modules/system/doc/setegid @@ -0,0 +1,15 @@ +NAME + setegid - set the effective group ID + +SYNTAX + void setegid(int uid); + +DESCRIPTION + Sets the effective group ID to 'gid'. + +KEYWORDS + User security + +SEE ALSO + system/setuid, system/getuid, system/setgid, system/getgid, + system/seteuid, system/geteuid, system/getegid diff --git a/src/modules/system/doc/seteuid b/src/modules/system/doc/seteuid new file mode 100644 index 0000000000..b599dbfdb1 --- /dev/null +++ b/src/modules/system/doc/seteuid @@ -0,0 +1,15 @@ +NAME + seteuid - set the effective user ID + +SYNTAX + void seteuid(int uid); + +DESCRIPTION + Sets the effective user ID to 'uid'. + +KEYWORDS + User security + +SEE ALSO + system/setuid, system/getuid, system/setgid, system/getgid, + system/geteuid, system/setegid, system/getegid diff --git a/src/modules/system/doc/setgid b/src/modules/system/doc/setgid new file mode 100644 index 0000000000..c7ddd19626 --- /dev/null +++ b/src/modules/system/doc/setgid @@ -0,0 +1,15 @@ +NAME + setgid - set the group ID + +SYNTAX + void setgid(int gid); + +DESCRIPTION + Sets the real group ID, effective group ID and saved group ID to 'gid'. + +KEYWORDS + User security + +SEE ALSO + system/setuid, system/getuid, system/getgid, system/seteuid, + system/geteuid, system/setegid, system/getegid diff --git a/src/modules/system/doc/setuid b/src/modules/system/doc/setuid new file mode 100644 index 0000000000..22cdf50616 --- /dev/null +++ b/src/modules/system/doc/setuid @@ -0,0 +1,15 @@ +NAME + setuid - set the user ID + +SYNTAX + void setuid(int uid); + +DESCRIPTION + Sets the real user ID, effective user ID and saved user ID to 'uid'. + +KEYWORDS + User security + +SEE ALSO + system/getuid, system/setgid, system/getgid, system/seteuid, + system/geteuid, system/setegid, system/getegid diff --git a/src/modules/system/doc/symlink b/src/modules/system/doc/symlink new file mode 100644 index 0000000000..12b5d5f05c --- /dev/null +++ b/src/modules/system/doc/symlink @@ -0,0 +1,14 @@ +NAME + symlink - create a symbolic link + +SYNTAX + void symlink(string from, string to); + +DESCRIPTION + Creates a symbolic link named 'to' pointing to 'from'. + +KEYWORDS + file + +SEE ALSO + system/hardlink, system/readlink, files/mv, files/rm -- GitLab