RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 07:27:45 +00:00
Code Issues Activity Actions

Help+Base: Add help://man URLs for links between man pages

Browse source 
The URLs of the form `help://man/<section>/<page>` link to another help
page inside the help application. All previous relative page links are
replaced by this new form. This doesn't change any behavior but it looks
much nicer :^)

Note that man doesn't handle these new links, but the previous relative
links didn't work either.
This commit is contained in:
kleines Filmröllchen 2022-01-07 14:15:44 +01:00 • committed by Linus Groh
parent becf74097e
commit 98c0c5e9e6
73 changed files with 177 additions and 165 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Base/usr/share/man/man2/get_process_name.md
View file

@ -25,4 +25,4 @@ In pledged programs, the `stdio` promise is required for this system call.
## See also
* [`set_process_name`(2)](../man2/set_process_name.md)
* [`set_process_name`(2)](help://man/2/set_process_name)

12
Base/usr/share/man/man2/geteuid.md
View file

@ -17,9 +17,9 @@ Returns the effective user or group id.
## See also
* [`setuid_overview`(7)](../man7/setuid_overview.md)
* [`getuid`(2) / `getgid`(2)](getuid.md)
* [`getresuid`(2) / `getresgid`(2)](getresuid.md)
* [`seteuid`(2) / `setegid`(2)](seteuid.md)
* [`setuid`(2) / `setgid`(2)](setuid.md)
* [`setresuid`(2) / `setresgid`(2)](setresuid.md)
* [`setuid_overview`(7)](help://man/7/setuid_overview)
* [`getuid`(2) / `getgid`(2)](help://man/2/getuid)
* [`getresuid`(2) / `getresgid`(2)](help://man/2/getresuid)
* [`seteuid`(2) / `setegid`(2)](help://man/2/seteuid)
* [`setuid`(2) / `setgid`(2)](help://man/2/setuid)
* [`setresuid`(2) / `setresgid`(2)](help://man/2/setresuid)

4
Base/usr/share/man/man2/getpid.md
View file

@ -24,5 +24,5 @@ None.
## See also
* [`getppid`(2)](getppid.md)
* [`gettid`(2)](gettid.md)
* [`getppid`(2)](help://man/2/getppid)
* [`gettid`(2)](help://man/2/gettid)

4
Base/usr/share/man/man2/getppid.md
View file

@ -24,5 +24,5 @@ None.
## See also
* [`getpid`(2)](getpid.md)
* [`gettid`(2)](gettid.md)
* [`getpid`(2)](help://man/2/getpid)
* [`gettid`(2)](help://man/2/gettid)

12
Base/usr/share/man/man2/getresuid.md
View file

@ -26,9 +26,9 @@ Otherwise, returns -1 and sets `errno` to describe the error.
## See also
* [`setuid_overview`(7)](../man7/setuid_overview.md)
* [`geteuid`(2) / `getegid`(2)](geteuid.md)
* [`getuid`(2) / `getgid`(2)](getuid.md)
* [`seteuid`(2) / `setegid`(2)](seteuid.md)
* [`setuid`(2) / `setgid`(2)](setuid.md)
* [`setresuid`(2) / `setresgid`(2)](setresuid.md)
* [`setuid_overview`(7)](help://man/7/setuid_overview)
* [`geteuid`(2) / `getegid`(2)](help://man/2/geteuid)
* [`getuid`(2) / `getgid`(2)](help://man/2/getuid)
* [`seteuid`(2) / `setegid`(2)](help://man/2/seteuid)
* [`setuid`(2) / `setgid`(2)](help://man/2/setuid)
* [`setresuid`(2) / `setresgid`(2)](help://man/2/setresuid)

4
Base/usr/share/man/man2/gettid.md
View file

@ -24,5 +24,5 @@ None.
## See also
* [`getpid`(2)](getpid.md)
* [`getppid`(2)](getppid.md)
* [`getpid`(2)](help://man/2/getpid)
* [`getppid`(2)](help://man/2/getppid)

12
Base/usr/share/man/man2/getuid.md
View file

@ -17,9 +17,9 @@ Returns the real user or group id.
## See also
* [`setuid_overview`(7)](../man7/setuid_overview.md)
* [`geteuid`(2) / `getegid`(2)](geteuid.md)
* [`getresuid`(2) / `getresgid`(2)](getresuid.md)
* [`seteuid`(2) / `setegid`(2)](seteuid.md)
* [`setuid`(2) / `setgid`(2)](setuid.md)
* [`setresuid`(2) / `setresgid`(2)](setresuid.md)
* [`setuid_overview`(7)](help://man/7/setuid_overview)
* [`geteuid`(2) / `getegid`(2)](help://man/2/geteuid)
* [`getresuid`(2) / `getresgid`(2)](help://man/2/getresuid)
* [`seteuid`(2) / `setegid`(2)](help://man/2/seteuid)
* [`setuid`(2) / `setgid`(2)](help://man/2/setuid)
* [`setresuid`(2) / `setresgid`(2)](help://man/2/setresuid)

2
Base/usr/share/man/man2/mkdir.md
View file

@ -21,4 +21,4 @@ it returns -1 and sets `errno` to describe the error.
## See also
* [`mkdir`(1)](../man1/mkdir.md)
* [`mkdir`(1)](help://man/1/mkdir)

2
Base/usr/share/man/man2/mount.md
View file

@ -95,4 +95,4 @@ All of the usual path resolution errors may also occur.
## See also
* [`mount`(8)](../man8/mount.md)
* [`mount`(8)](help://man/8/mount)

20
Base/usr/share/man/man2/pledge.md
View file

@ -18,9 +18,9 @@ Functionality is divided into a curated set of promises (described below), which
Note that `pledge()` can be called repeatedly to remove previously-pledged promises, but it can never regain capabilities once lost.
`promises` are applied to the current process, and will also be inherited by children created by [`fork`(2)](fork.md).
`promises` are applied to the current process, and will also be inherited by children created by [`fork`(2)](help://man/2/fork).
`execpromises` are applied if/when a new process image is created with [`exec`(2)](exec.md).
`execpromises` are applied if/when a new process image is created with [`exec`(2)](help://man/2/exec).
If `promises` or `execpromises` is null, the corresponding value is unchanged.
@ -35,25 +35,25 @@ If the process later attempts to use any system functionality it has previously
* `id`: Ability to change UID/GID
* `tty`: TTY related functionality
* `proc`: Process and scheduling related functionality
* `exec`: The [`exec`(2)](exec.md) syscall
* `exec`: The [`exec`(2)](help://man/2/exec) syscall
* `unix`: UNIX local domain sockets
* `inet`: IPv4 domain sockets
* `accept`: May use [`accept`(2)](accept.md) to accept incoming socket connections on already listening sockets (\*)
* `accept`: May use [`accept`(2)](help://man/2/accept) to accept incoming socket connections on already listening sockets (\*)
* `rpath`: "Read" filesystem access
* `wpath`: "Write" filesystem access
* `cpath`: "Create" filesystem access
* `dpath`: Creating new device files
* `chown`: Changing file owner/group
* `fattr`: Changing file attributes/permissions
* `video`: May use [`ioctl`(2)](ioctl.md) and [`mmap`(2)](mmap.md) on framebuffer video devices
* `video`: May use [`ioctl`(2)](help://man/2/ioctl) and [`mmap`(2)](help://man/2/mmap) on framebuffer video devices
* `settime`: Changing the system time and date
* `setkeymap`: Changing the system keyboard layout (\*)
* `sigaction`: Change signal handlers and dispositions (\*)
* `sendfd`: Send file descriptors over a local socket
* `recvfd`: Receive file descriptors over a local socket
* `ptrace`: The [`ptrace`(2)](ptrace.md) syscall (\*)
* `prot_exec`: [`mmap`(2)](mmap.md) and [`mprotect`(2)](mprotect.md) with `PROT_EXEC`
* `map_fixed`: [`mmap`(2)](mmap.md) with `MAP_FIXED` or `MAP_FIXED_NOREPLACE` (\*)
* `ptrace`: The [`ptrace`(2)](help://man/2/ptrace) syscall (\*)
* `prot_exec`: [`mmap`(2)](help://man/2/mmap) and [`mprotect`(2)](help://man/2/mprotect) with `PROT_EXEC`
* `map_fixed`: [`mmap`(2)](help://man/2/mmap) with `MAP_FIXED` or `MAP_FIXED_NOREPLACE` (\*)
Promises marked with an asterisk (\*) are SerenityOS specific extensions not supported by the original OpenBSD `pledge()`.
@ -69,5 +69,5 @@ The `pledge()` system call was first introduced by OpenBSD. The implementation i
## See also
* [`unveil`(2)](unveil.md)
* [`Mitigations`(7)](../man7/Mitigations.md)
* [`unveil`(2)](help://man/2/unveil)
* [`Mitigations`(7)](help://man/7/Mitigations)

2
Base/usr/share/man/man2/readlink.md
View file

@ -66,4 +66,4 @@ pid_t read_pid_using_core_file()
## See also
* [`readlink`(1)](../man1/readlink.md)
* [`readlink`(1)](help://man/1/readlink)

4
Base/usr/share/man/man2/recvfd.md
View file

@ -18,7 +18,7 @@ File descriptors are sent out-of-band and do not affect the regular data streams
The *options* argument accepts a bitmask of the following flags:
* `O_CLOEXEC`: The opened fd shall be closed on [`exec`(2)](../man2/exec.md).
* `O_CLOEXEC`: The opened fd shall be closed on [`exec`(2)](help://man/2/exec).
## Return value
@ -38,4 +38,4 @@ If a file descriptor is successfully received, it is returned as a non-negative
## See also
* [`sendfd`(2)](sendfd.md)
* [`sendfd`(2)](help://man/2/sendfd)

2
Base/usr/share/man/man2/sendfd.md
View file

@ -35,4 +35,4 @@ If a file descriptor is successfully sent, `sendfd()` returns 0. Otherwise, -1 i
## See also
* [`recvfd`(2)](recvfd.md)
* [`recvfd`(2)](help://man/2/recvfd)

2
Base/usr/share/man/man2/set_process_name.md
View file

@ -25,4 +25,4 @@ In pledged programs, the `proc` promise is required for this system call.
## See also
* [`get_process_name`(2)](../man2/get_process_name.md)
* [`get_process_name`(2)](help://man/2/get_process_name)

12
Base/usr/share/man/man2/seteuid.md
View file

@ -31,9 +31,9 @@ Otherwise, returns -1 and sets `errno` to describe the error.
## See also
* [`setuid_overview`(7)](../man7/setuid_overview.md)
* [`geteuid`(2) / `getegid`(2)](geteuid.md)
* [`getuid`(2) / `getgid`(2)](getuid.md)
* [`getresuid`(2) / `getresgid`(2)](getresuid.md)
* [`setuid`(2) / `setgid`(2)](setuid.md)
* [`setresuid`(2) / `setresgid`(2)](setresuid.md)
* [`setuid_overview`(7)](help://man/7/setuid_overview)
* [`geteuid`(2) / `getegid`(2)](help://man/2/geteuid)
* [`getuid`(2) / `getgid`(2)](help://man/2/getuid)
* [`getresuid`(2) / `getresgid`(2)](help://man/2/getresuid)
* [`setuid`(2) / `setgid`(2)](help://man/2/setuid)
* [`setresuid`(2) / `setresgid`(2)](help://man/2/setresuid)

12
Base/usr/share/man/man2/setresuid.md
View file

@ -30,9 +30,9 @@ Otherwise, returns -1 and sets `errno` to describe the error.
## See also
* [`setuid_overview`(7)](../man7/setuid_overview.md)
* [`geteuid`(2) / `getegid`(2)](geteuid.md)
* [`getuid`(2) / `getgid`(2)](getuid.md)
* [`getresuid`(2) / `getresgid`(2)](getresuid.md)
* [`seteuid`(2) / `setegid`(2)](seteuid.md)
* [`setuid`(2) / `setgid`(2)](setuid.md)
* [`setuid_overview`(7)](help://man/7/setuid_overview)
* [`geteuid`(2) / `getegid`(2)](help://man/2/geteuid)
* [`getuid`(2) / `getgid`(2)](help://man/2/getuid)
* [`getresuid`(2) / `getresgid`(2)](help://man/2/getresuid)
* [`seteuid`(2) / `setegid`(2)](help://man/2/seteuid)
* [`setuid`(2) / `setgid`(2)](help://man/2/setuid)

12
Base/usr/share/man/man2/setuid.md
View file

@ -29,9 +29,9 @@ Otherwise, returns -1 and sets `errno` to describe the error.
## See also
* [`setuid_overview`(7)](../man7/setuid_overview.md)
* [`geteuid`(2) / `getegid`(2)](geteuid.md)
* [`getuid`(2) / `getgid`(2)](getuid.md)
* [`getresuid`(2) / `getresgid`(2)](getresuid.md)
* [`seteuid`(2) / `setegid`(2)](seteuid.md)
* [`setresuid`(2) / `setresgid`(2)](setresuid.md)
* [`setuid_overview`(7)](help://man/7/setuid_overview)
* [`geteuid`(2) / `getegid`(2)](help://man/2/geteuid)
* [`getuid`(2) / `getgid`(2)](help://man/2/getuid)
* [`getresuid`(2) / `getresgid`(2)](help://man/2/getresuid)
* [`seteuid`(2) / `setegid`(2)](help://man/2/seteuid)
* [`setresuid`(2) / `setresgid`(2)](help://man/2/setresuid)

2
Base/usr/share/man/man2/uname.md
View file

@ -35,4 +35,4 @@ If successful, returns 0. Otherwise, returns -1 and sets `errno` to describe the
## See also
* [`uname`(1)](../man1/uname.md)
* [`uname`(1)](help://man/1/uname)

4
Base/usr/share/man/man2/unveil.md
View file

@ -96,5 +96,5 @@ unveil(nullptr, nullptr);
## See also
* [`pledge`(2)](pledge.md)
* [`Mitigations`(7)](../man7/Mitigations.md)
* [`pledge`(2)](help://man/2/pledge)
* [`Mitigations`(7)](help://man/7/Mitigations)