diff share/man/man1/roundup-demo.1 @ 7926:05f36a527a45

feat: allow setting URL hostname with -H option to roundup-demo The underlying demo.py code already supported this. Also update man page ading -H and fixing formatting for a number of entries. Clarify that hostname can be used with -B to listen on the ip address for that host. Refactor port handling to reduce line length.
author John Rouillard <rouilj@ieee.org>
date Thu, 02 May 2024 21:49:17 -0400
parents d5dfc152cd9d
children d614d8e1c09d
line wrap: on
line diff
--- a/share/man/man1/roundup-demo.1	Thu May 02 21:21:40 2024 -0400
+++ b/share/man/man1/roundup-demo.1	Thu May 02 21:49:17 2024 -0400
@@ -33,7 +33,7 @@
 
 Show the help message and exit
 .TP
-\fB-b\fp \fIBIND_ADDRESS\fI, \fB--bind_address\fP \fIBIND_ADDRESS\fP
+\fB-B\fp \fIBIND_ADDRESS\fI, \fB--bind_address\fP \fIBIND_ADDRESS\fP
 
 Choose address for server to listen at. Use 0.0.0.0 to bind to all addreses.
 Default: 127.0.0.1.
@@ -51,15 +51,21 @@
 
 Use specified template when building tracker. (*)
 .TP
+\fB-h\fP \fIHOSTNAME\fP, \fB--hostname\fP \fIHOSTNAME\fP
+
+Set the hostname used in the URL. This does not make the server listen
+at the hostname. Use the hostname with \fB-B\fP to listen on that IP
+address.
+.TP
 \fB-p\fP \fIPORT\fP, \fB--port\fP \fIPORT\fP
 
 Listen at this port. Default: search for open port starting at 8917.
 .TP
-\fB-P\fP \fIURLPORT\fP, \fB--urlport\fP \fIURLPORT\fP When using
+\fB-P\fP \fIURLPORT\fP, \fB--urlport\fP \fIURLPORT\fP
 
-docker this option passes the docker external port to the demo
-instance. If using \fBdocker ... -p 9090:8917 ...\fP this should be
-set to \fB-P 9090\fP. Default: as selected by \fB--port\fP.
+When using docker this option passes the docker external port to the
+demo instance. If using \fBdocker ... -p 9090:8917 ...\fP this should
+be set to \fB-P 9090\fP. Default: as selected by \fB--port\fP.
 .TP
 \fB-V\fP, \fB--version\fP
 

Roundup Issue Tracker: http://roundup-tracker.org/