]> gitweb.michael.orlitzky.com - list-remote-forwards.git/commitdiff
doc/man1/list-remote-forwards.1: mention the configuration file
authorMichael Orlitzky <michael@orlitzky.com>
Wed, 24 Apr 2024 10:54:56 +0000 (06:54 -0400)
committerMichael Orlitzky <michael@orlitzky.com>
Wed, 24 Apr 2024 10:54:56 +0000 (06:54 -0400)
doc/man1/list-remote-forwards.1

index 77eec6e43bbd469b7536fc908ad2153094e69590..39042e3f0baf019198683171101bbc485615207d 100644 (file)
@@ -93,6 +93,16 @@ Username used to connect to the database (Postgres-only).
 
 Default: The current user
 
+.SH CONFIGURATION FILE
+
+Any of the options above can be placed in a configuration file rather
+than passed on the command line. An example config file
+\fIdoc/list-remote-forwardsrc.example\fR is included with the
+source. You can edit it and rename it to either
+\fI$sysconfdir/list-remote-forwardsrc\fR or
+\fI~/.list-remote-forwardsrc\fR. The variable \fI$sysconfdir\fR is
+determined at build time and is typically \fI/etc\fR on UNIX systems.
+
 .SH EXAMPLES
 
 .nf