~zethra/stargazer

5478c33bd622ba76f599ec5b797cfd232000b93a — Ben Aaron Goldberg 2 months ago 0976fac
docs: say that stargazer doesn't support different content per int/port

Signed-off-by: Ben Aaron Goldberg <ben@benaaron.dev>
3 files changed, 28 insertions(+), 15 deletions(-)

M doc/stargazer-ini.scd
M doc/stargazer.1.txt
M doc/stargazer.ini.5.txt
M doc/stargazer-ini.scd => doc/stargazer-ini.scd +8 -3
@@ 47,7 47,10 @@ that *stargazer* will server requests to. At least one route must be specified.
	1965 (the default Gemini port) is presumed. To specify an IPv6 address,
	enclose it in *[]*, e.g. *[::]*. Note that IPv6 listener always have
	IPV6_V6ONLY set, so they will only listen on the IPv6 interface and not also
	IPv4. If you wish to listen on both, specify both.
	IPv4. If you wish to listen on both, specify both. Stargazer supports
	listening on multiple interfaces/ports but does not support serving
	different content on different interfaces/ports. It does support serving
	different content on different domains and paths.

*connection-logging*
	Whether or not to log connections to stdout. Disabling this may increase


@@ 91,7 94,9 @@ configures.
The format of the section name is the _hostname_ to be serviced, followed by a
token which defines the routing strategy, and a _string_ whose format is
specific to each routing strategy. The token and match string may be omitted
(i.e. [_hostname_] alone), which implies path routing against "/".
(i.e. [_hostname_] alone), which implies path routing against "/". A port may
not be specified along with the hostname. Stargazer does not support serving
different content on different ports.

|] *:*
:< Route by path prefix. The URL path is compared to "_string_/".


@@ 171,7 176,7 @@ Within each routing section, the following keys are used to configure how
*charset*
	Set this value as the *charset* parameter for text files served under this
	route. The lang param will only be set for text/\* responses. If the lang
	paraparameter is also set, then lang will be set instead of charset for
	parameter is also set, then lang will be set instead of charset for
	text/gemini responses. The Gemini Specification says that the charset
	parameter should be a character set specified in RFC 2046. Stargazer will
	use the charset parameter as given in this config. It is up to the user to

M doc/stargazer.1.txt => doc/stargazer.1.txt +1 -1
@@ 34,4 34,4 @@ AUTHORS
       bugs/patches can be submitted by email to
       ~zethra/stargazer@lists.sr.ht.

			      2021-07-06		  stargazer(1)
			      2021-07-13		  stargazer(1)

M doc/stargazer.ini.5.txt => doc/stargazer.ini.5.txt +19 -11
@@ 42,7 42,13 @@ CONFIGURATION KEYS
	   bind to. Each address shall take the format address:port.
	   If :port is omitted, 1965 (the default Gemini port) is pre‐
	   sumed. To specify an IPv6 address, enclose it in [], e.g.
	   [::].
	   [::]. Note that IPv6 listener always have IPV6_V6ONLY set,
	   so they will only listen on the IPv6 interface and not also
	   IPv4. If you wish to listen on both, specify both.
	   Stargazer supports listening on multiple interfaces/ports
	   but does not support serving different content on different
	   interfaces/ports. It does support serving different content
	   on different domains and paths.

       connection-logging
	   Whether or not to log connections to stdout. Disabling this


@@ 88,7 94,9 @@ CONFIGURATION KEYS
       followed by a token which defines the routing strategy, and a
       string whose format is specific to each routing strategy. The
       token and match string may be omitted (i.e. [hostname] alone),
       which implies path routing against "/".
       which implies path routing against "/". A port may not be spec‐
       ified along with the hostname. Stargazer does not support serv‐
       ing different content on different ports.

       :   Route by path prefix. The URL path is compared to
	   "string/".


@@ 169,14 177,14 @@ CONFIGURATION KEYS
       charset
	   Set this value as the charset parameter for text files
	   served under this route. The lang param will only be set
	   for text/* responses. If the lang paraparameter is also
	   set, then lang will be set instead of charset for text/gem‐
	   ini responses. The Gemini Specification says that the
	   charset parameter should be a character set specified in
	   RFC 2046. Stargazer will use the charset parameter as given
	   in this config. It is up to the user to provid a valid
	   charset value. Currently, this parameter is only used when
	   serving static files.
	   for text/* responses. If the lang parameter is also set,
	   then lang will be set instead of charset for text/gemini
	   responses. The Gemini Specification says that the charset
	   parameter should be a character set specified in RFC 2046.
	   Stargazer will use the charset parameter as given in this
	   config. It is up to the user to provid a valid charset
	   value. Currently, this parameter is only used when serving
	   static files.

       redirect
	   Send a redirect to this URI instead of serving other con‐


@@ 350,4 358,4 @@ AUTHORS
       bugs/patches can be submitted by email to
       ~zethra/stargazer@lists.sr.ht.

			      2021-07-06	      stargazer.ini(5)
			      2021-07-13	      stargazer.ini(5)