From e973770660df0027582a576fa2de5e77aad7b395 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Tue, 1 Apr 2025 15:33:44 +0800 Subject: Rename man pages to start with lindenii-forge- --- Makefile | 2 +- man/forge-mail.5 | 31 ----------- man/forge.1 | 35 ------------ man/forge.5 | 133 --------------------------------------------- man/hookc.1 | 74 ------------------------- man/lindenii-forge-hookc.1 | 74 +++++++++++++++++++++++++ man/lindenii-forge-mail.5 | 31 +++++++++++ man/lindenii-forge.1 | 35 ++++++++++++ man/lindenii-forge.5 | 133 +++++++++++++++++++++++++++++++++++++++++++++ 9 files changed, 274 insertions(+), 274 deletions(-) delete mode 100644 man/forge-mail.5 delete mode 100644 man/forge.1 delete mode 100644 man/forge.5 delete mode 100644 man/hookc.1 create mode 100644 man/lindenii-forge-hookc.1 create mode 100644 man/lindenii-forge-mail.5 create mode 100644 man/lindenii-forge.1 create mode 100644 man/lindenii-forge.5 diff --git a/Makefile b/Makefile index 7d91c60..cac574d 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ .PHONY: clean version.go man source.tar.gz CFLAGS = -Wall -Wextra -Werror -pedantic -std=c99 -D_GNU_SOURCE -MAN_PAGES = forge.5 hookc.1 forge.1 forge-mail.5 +MAN_PAGES = lindenii-forge.5 lindenii-forge-hookc.1 lindenii-forge.1 lindenii-forge-mail.5 forge: source.tar.gz version.go hookc/*.c hookc/hookc man # TODO go build . diff --git a/man/forge-mail.5 b/man/forge-mail.5 deleted file mode 100644 index 58e3580..0000000 --- a/man/forge-mail.5 +++ /dev/null @@ -1,31 +0,0 @@ -.\" SPDX-License-Identifier: AGPL-3.0-only -.\" SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu -.Dd March 30, 2025 -.Dt FORGE-MAIL 5 -.Os Lindenii Forge -.Sh NAME -.Nm forge-mail -.Nd configuring Lindenii Forge email integration -.Sh DESCRIPTION -.Nm -is a guide to configuring Lindenii Forge for email integration. -.Pp -This is currently a stub. Here is a working configuration that works -for the Lindenii Project itself, though. -.Sh /etc/smtpd/smtpd.conf -.Bd -literal -table forge file:/etc/smtpd/forge -action "FORGE" lmtp "/srv/forge/lmtp.sock" rcpt-to virtual -match from any for domain "forge.lindenii.runxiyu.org" action "FORGE" -.Ed -.Sh /etc/smtpd/forge -.Bd -literal -@ forge -.Ed -.Sh SEE ALSO -.Xr forge 1 , -.Xr forge 5 , -.Xr smtpd.conf 5 -.Sh AUTHORS -.An Runxi Yu Aq Mt https://runxiyu.org -.An Test_User Aq Mt hax@runxiyu.org diff --git a/man/forge.1 b/man/forge.1 deleted file mode 100644 index dd1960f..0000000 --- a/man/forge.1 +++ /dev/null @@ -1,35 +0,0 @@ -.\" SPDX-License-Identifier: AGPL-3.0-only -.\" SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu -.Dd March 30, 2025 -.Dt FORGE 1 -.Os Lindenii Forge -.Sh NAME -.Nm forge -.Nd Lindenii Forge server daemon -.Sh SYNOPSIS -.Nm -.Op Fl config Ar path -.Sh DESCRIPTION -.Nm -is the main server daemon for Lindenii Forge. -.Pp -All configuration is loaded from a configuration file; see -.Xr forge 5 . -.Pp -All listeners are long-lived; the process runs until interrupted. -.Sh OPTIONS -.Bl -tag -width Ds -.It Fl config Ar path -The path to the configuration file. Defaults to -.Pa /etc/lindenii/forge.scfg . -.El -.Sh FILES -.Bl -tag -width Ds -.It Pa /etc/lindenii/forge.scfg -Default configuration file. -.El -.Sh SEE ALSO -.Xr forge 5 -.Sh AUTHORS -.An Runxi Yu Aq Mt https://runxiyu.org -.An Test_User Aq Mt hax@runxiyu.org diff --git a/man/forge.5 b/man/forge.5 deleted file mode 100644 index 177c7f4..0000000 --- a/man/forge.5 +++ /dev/null @@ -1,133 +0,0 @@ -.\" SPDX-License-Identifier: AGPL-3.0-only -.\" SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu -.Dd March 30, 2025 -.Dt FORGE 5 -.Os Lindenii Forge -.Sh NAME -.Nm forge.scfg -.Nd configuration file for Lindenii Forge -.Sh DESCRIPTION -.Nm -describes the configuration for -.Xr forge 1 -instance using the -scfg -format. -.Pp -Each directive consists of a name followed by zero or more parameters. Directives may also introduce blocks of subdirectives using braces. -.Pp -Comments begin with -.Sq # -and extend to the end of the line. -.Sh DIRECTIVES -.Bl -tag -width Ds -.It Ic http -Configures the ingress HTTP server. -.Bl -tag -width Ds -.It Ic net -Network type to listen on (e.g., -.Dq tcp , -.Dq tcp4 , -.Dq unix ) . -.It Ic addr -Address to listen on (e.g., -.Dq :8080 -or -.Dq /var/run/lindenii/forge/http.sock ) . -.It Ic cookie_expiry -How long (in seconds) to keep session cookies. -.It Ic root -Canonical root URL of the web interface (e.g., -.Dq https://forge.example.org ) . -.It Ic read_timeout , write_timeout , idle_timeout -Timeouts, in seconds, for the general HTTP server context. -.It Ic reverse_proxy -Boolean indicating whether to trust X-Forwarded-For headers. -.El -.It Ic ssh -Configures the SSH server. -.Bl -tag -width Ds -.It Ic net -Network type to listen on -.Dq ( tcp -is recommended). -.It Ic addr -Address to listen on (e.g., -.Dq :22 ) . -.It Ic key -Path to the SSH host key (must be passwordless). -.It Ic root -Canonical SSH URL prefix (e.g., -.Dq ssh://forge.example.org ) . -.El -.It Ic git -Configures Git repository storage. -.Bl -tag -width Ds -.It Ic repo_dir -Filesystem path under which new repositories are stored. -.El -.It Ic db -Configures database connection. -.Bl -tag -width Ds -.It Ic type -Database type (currently must be -.Dq postgres ) . -.It Ic conn -Connection string, e.g., -.Dq postgresql:///lindenii-forge?host=/var/run/postgresql . -.El -.It Ic general -Miscellaneous settings. -.Bl -tag -width Ds -.It Ic title -A user-facing name for the instance. -.El -.It Ic hooks -Configures Git hook communication with the forge daemon. -.Bl -tag -width Ds -.It Ic socket -Path to a UNIX domain socket for receiving hook events. -.It Ic execs -Directory where Git hook executables are stored. -.El -.It Ic irc -Optional configuration for IRC presence. -.Bl -tag -width Ds -.It Ic tls -Boolean indicating whether to use TLS. -.It Ic net , addr -Network type and address (e.g., -.Dq tcp , -.Dq irc.example.org:6697 ) . -.It Ic sendq -Maximum send queue size. -.It Ic nick , user , gecos -Identity fields for the IRC connection. -.El -.It Ic lmtp -Configuration for the LMTP/MX component. You may wish to refer to -.Xr forge-mail 5 -for information on configuring your SMTP server. -.Bl -tag -width Ds -.It Ic socket -The path to the UNIX domain socket to listen on. -.It Ic max_size -The maximum acceptable ingress message size. -.It Ic domain -The domain-part of our LMTP server. -.It Ic read_timeout , write_timeout -General timeouts for LMTP connections. -.El -.El -.Sh FILES -.Bl -tag -width Ds -.It Pa /etc/lindenii/forge.scfg -Default path to the configuration file. -.El -.Sh SEE ALSO -.Xr forge 1 , -.Xr hookc 1 , -.Lk https://git.sr.ht/~emersion/scfg scfg -.Sh AUTHORS -.An Runxi Yu Aq Mt https://runxiyu.org -.An Test_User Aq Mt hax@runxiyu.org diff --git a/man/hookc.1 b/man/hookc.1 deleted file mode 100644 index c46c882..0000000 --- a/man/hookc.1 +++ /dev/null @@ -1,74 +0,0 @@ -.\" SPDX-License-Identifier: AGPL-3.0-only -.\" SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu -.Dd March 30, 2025 -.Dt HOOKC 1 -.Os Lindenii Forge -.Sh NAME -.Nm hookc -.Nd helper binary to delegate Git hook behavior to the forge daemon -.Sh SYNOPSIS -.Nm -.Op Ar argument ... -.Sh DESCRIPTION -.Nm -is a helper binary for Git server-side hooks that relays the hook's context to -a persistent daemon via a UNIX domain socket and communicates back any relevant -responses. -.Pp -It is intended to be invoked by -.Xr git-receive-pack 1 -for hooks such as -.Pa pre-receive , -.Pa update , -and -.Pa post-receive . -.Sh ENVIRONMENT -.Bl -tag -width Ds -.It Ev LINDENII_FORGE_HOOKS_SOCKET_PATH -Absolute path to the UNIX domain socket on which the daemon is listening. -.It Ev LINDENII_FORGE_HOOKS_COOKIE -64-character authentication cookie used to validate the hook client to the daemon. -.El -.Sh OPERATION -.Nm -collects the following information and sends it to the daemon: -.Bl -bullet -.It -All command-line arguments -.It -All -.Ev GIT_* -environment variables -.It -The raw hook -.Pa stdin -(e.g., old/new ref triplets for -.Pa pre-receive ) -.El -.Pp -After sending this data, it waits for a one-byte status code from the daemon, -which becomes -.Nm Ns 's -own exit status. -.Pp -If the daemon sends any output afterward, it is forwarded to standard error -and will appear as -.Dq remote: -output to the user. -.Sh BUGS -.Bl -bullet -.It -The status byte from the daemon currently must be sent before any stderr output. -.It -Currently assumes -.Pa stdin -and -.Pa stderr -are pipes, which is not guaranteed in future versions of Git. -.El -.Sh AUTHORS -.An Runxi Yu Aq Mt https://runxiyu.org -.An Test_User Aq Mt hax@runxiyu.org -.Sh SEE ALSO -.Xr git-receive-pack 1 , -.Xr forge 1 diff --git a/man/lindenii-forge-hookc.1 b/man/lindenii-forge-hookc.1 new file mode 100644 index 0000000..d999761 --- /dev/null +++ b/man/lindenii-forge-hookc.1 @@ -0,0 +1,74 @@ +.\" SPDX-License-Identifier: AGPL-3.0-only +.\" SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu +.Dd March 30, 2025 +.Dt LINDENII-FORGE-HOOKC 1 +.Os Lindenii Forge +.Sh NAME +.Nm lindenii-forge-hookc +.Nd helper binary to delegate Git hook behavior to the forge daemon +.Sh SYNOPSIS +.Nm +.Op Ar argument ... +.Sh DESCRIPTION +.Nm +is a helper binary for Git server-side hooks that relays the hook's context to +a persistent daemon via a UNIX domain socket and communicates back any relevant +responses. +.Pp +It is intended to be invoked by +.Xr git-receive-pack 1 +for hooks such as +.Pa pre-receive , +.Pa update , +and +.Pa post-receive . +.Sh ENVIRONMENT +.Bl -tag -width Ds +.It Ev LINDENII_FORGE_HOOKS_SOCKET_PATH +Absolute path to the UNIX domain socket on which the daemon is listening. +.It Ev LINDENII_FORGE_HOOKS_COOKIE +64-character authentication cookie used to validate the hook client to the daemon. +.El +.Sh OPERATION +.Nm +collects the following information and sends it to the daemon: +.Bl -bullet +.It +All command-line arguments +.It +All +.Ev GIT_* +environment variables +.It +The raw hook +.Pa stdin +(e.g., old/new ref triplets for +.Pa pre-receive ) +.El +.Pp +After sending this data, it waits for a one-byte status code from the daemon, +which becomes +.Nm Ns 's +own exit status. +.Pp +If the daemon sends any output afterward, it is forwarded to standard error +and will appear as +.Dq remote: +output to the user. +.Sh BUGS +.Bl -bullet +.It +The status byte from the daemon currently must be sent before any stderr output. +.It +Currently assumes +.Pa stdin +and +.Pa stderr +are pipes, which is not guaranteed in future versions of Git. +.El +.Sh AUTHORS +.An Runxi Yu Aq Mt https://runxiyu.org +.An Test_User Aq Mt hax@runxiyu.org +.Sh SEE ALSO +.Xr git-receive-pack 1 , +.Xr lindenii-forge 1 diff --git a/man/lindenii-forge-mail.5 b/man/lindenii-forge-mail.5 new file mode 100644 index 0000000..a7134a7 --- /dev/null +++ b/man/lindenii-forge-mail.5 @@ -0,0 +1,31 @@ +.\" SPDX-License-Identifier: AGPL-3.0-only +.\" SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu +.Dd March 30, 2025 +.Dt LINDENII-FORGE-MAIL 5 +.Os Lindenii Forge +.Sh NAME +.Nm lindenii-forge-mail +.Nd configuring Lindenii Forge email integration +.Sh DESCRIPTION +.Nm +is a guide to configuring Lindenii Forge for email integration. +.Pp +This is currently a stub. Here is a working configuration that works +for the Lindenii Project itself, though. +.Sh /etc/smtpd/smtpd.conf +.Bd -literal +table forge file:/etc/smtpd/forge +action "FORGE" lmtp "/srv/forge/lmtp.sock" rcpt-to virtual +match from any for domain "forge.lindenii.runxiyu.org" action "FORGE" +.Ed +.Sh /etc/smtpd/forge +.Bd -literal +@ forge +.Ed +.Sh SEE ALSO +.Xr lindenii-forge 1 , +.Xr lindenii-forge 5 , +.Xr smtpd.conf 5 +.Sh AUTHORS +.An Runxi Yu Aq Mt https://runxiyu.org +.An Test_User Aq Mt hax@runxiyu.org diff --git a/man/lindenii-forge.1 b/man/lindenii-forge.1 new file mode 100644 index 0000000..9b234ef --- /dev/null +++ b/man/lindenii-forge.1 @@ -0,0 +1,35 @@ +.\" SPDX-License-Identifier: AGPL-3.0-only +.\" SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu +.Dd March 30, 2025 +.Dt LINDENII-FORGE 1 +.Os Lindenii Forge +.Sh NAME +.Nm lindenii-forge +.Nd Lindenii Forge server daemon +.Sh SYNOPSIS +.Nm +.Op Fl config Ar path +.Sh DESCRIPTION +.Nm +is the main server daemon for Lindenii Forge. +.Pp +All configuration is loaded from a configuration file; see +.Xr lindenii-forge 5 . +.Pp +All listeners are long-lived; the process runs until interrupted. +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl config Ar path +The path to the configuration file. Defaults to +.Pa /etc/lindenii/forge.scfg . +.El +.Sh FILES +.Bl -tag -width Ds +.It Pa /etc/lindenii/forge.scfg +Default configuration file. +.El +.Sh SEE ALSO +.Xr lindenii-forge 5 +.Sh AUTHORS +.An Runxi Yu Aq Mt https://runxiyu.org +.An Test_User Aq Mt hax@runxiyu.org diff --git a/man/lindenii-forge.5 b/man/lindenii-forge.5 new file mode 100644 index 0000000..18c61df --- /dev/null +++ b/man/lindenii-forge.5 @@ -0,0 +1,133 @@ +.\" SPDX-License-Identifier: AGPL-3.0-only +.\" SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu +.Dd March 30, 2025 +.Dt LINDENII-FORGE 5 +.Os Lindenii Forge +.Sh NAME +.Nm lindenii-forge.scfg +.Nd configuration file for Lindenii Forge +.Sh DESCRIPTION +.Nm +describes the configuration for +.Xr lindenii-forge 1 +instance using the +scfg +format. +.Pp +Each directive consists of a name followed by zero or more parameters. Directives may also introduce blocks of subdirectives using braces. +.Pp +Comments begin with +.Sq # +and extend to the end of the line. +.Sh DIRECTIVES +.Bl -tag -width Ds +.It Ic http +Configures the ingress HTTP server. +.Bl -tag -width Ds +.It Ic net +Network type to listen on (e.g., +.Dq tcp , +.Dq tcp4 , +.Dq unix ) . +.It Ic addr +Address to listen on (e.g., +.Dq :8080 +or +.Dq /var/run/lindenii/forge/http.sock ) . +.It Ic cookie_expiry +How long (in seconds) to keep session cookies. +.It Ic root +Canonical root URL of the web interface (e.g., +.Dq https://forge.example.org ) . +.It Ic read_timeout , write_timeout , idle_timeout +Timeouts, in seconds, for the general HTTP server context. +.It Ic reverse_proxy +Boolean indicating whether to trust X-Forwarded-For headers. +.El +.It Ic ssh +Configures the SSH server. +.Bl -tag -width Ds +.It Ic net +Network type to listen on +.Dq ( tcp +is recommended). +.It Ic addr +Address to listen on (e.g., +.Dq :22 ) . +.It Ic key +Path to the SSH host key (must be passwordless). +.It Ic root +Canonical SSH URL prefix (e.g., +.Dq ssh://forge.example.org ) . +.El +.It Ic git +Configures Git repository storage. +.Bl -tag -width Ds +.It Ic repo_dir +Filesystem path under which new repositories are stored. +.El +.It Ic db +Configures database connection. +.Bl -tag -width Ds +.It Ic type +Database type (currently must be +.Dq postgres ) . +.It Ic conn +Connection string, e.g., +.Dq postgresql:///lindenii-forge?host=/var/run/postgresql . +.El +.It Ic general +Miscellaneous settings. +.Bl -tag -width Ds +.It Ic title +A user-facing name for the instance. +.El +.It Ic hooks +Configures Git hook communication with the forge daemon. +.Bl -tag -width Ds +.It Ic socket +Path to a UNIX domain socket for receiving hook events. +.It Ic execs +Directory where Git hook executables are stored. +.El +.It Ic irc +Optional configuration for IRC presence. +.Bl -tag -width Ds +.It Ic tls +Boolean indicating whether to use TLS. +.It Ic net , addr +Network type and address (e.g., +.Dq tcp , +.Dq irc.example.org:6697 ) . +.It Ic sendq +Maximum send queue size. +.It Ic nick , user , gecos +Identity fields for the IRC connection. +.El +.It Ic lmtp +Configuration for the LMTP/MX component. You may wish to refer to +.Xr forge-mail 5 +for information on configuring your SMTP server. +.Bl -tag -width Ds +.It Ic socket +The path to the UNIX domain socket to listen on. +.It Ic max_size +The maximum acceptable ingress message size. +.It Ic domain +The domain-part of our LMTP server. +.It Ic read_timeout , write_timeout +General timeouts for LMTP connections. +.El +.El +.Sh FILES +.Bl -tag -width Ds +.It Pa /etc/lindenii/forge.scfg +Default path to the configuration file. +.El +.Sh SEE ALSO +.Xr lindenii-forge 1 , +.Xr lindenii-forge-hookc 1 , +.Lk https://git.sr.ht/~emersion/scfg scfg +.Sh AUTHORS +.An Runxi Yu Aq Mt https://runxiyu.org +.An Test_User Aq Mt hax@runxiyu.org -- cgit v1.2.3