document that --listen specifies an IP address
authorJoey Hess <joeyh@joeyh.name>
Thu, 18 Jan 2024 16:58:00 +0000 (12:58 -0400)
committerJoey Hess <joeyh@joeyh.name>
Thu, 18 Jan 2024 16:58:00 +0000 (12:58 -0400)
Avoid users getting confused and thinking this allows specifying the
port.

Sponsored-by: the NIH-funded NICEMAN (ReproNim TR&D3) project
doc/git-annex-webapp.mdwn
doc/git-annex.mdwn

index 064996ea1647fadb76b69ee4a52e68afd825b511..21ae9fff54b53aeed4e9815adb97ee948439cb14 100644 (file)
@@ -21,13 +21,13 @@ it opens a browser window.
 * `--listen=address`
 
   Useful for using the webapp on a remote computer. This makes the webapp
-  listen on the specified address.
+  listen on the specified IP address.
 
   This disables running a local web browser, and outputs the url you
   can use to open the webapp.
 
   Set annex.listen in the git config to make the webapp always
-  listen on an address.
+  listen on an IP address.
 
 * Also the [[git-annex-common-options]](1) can be used.
 
index deeb4703eaf7b28515ed8006bd0008f59fccd0bb..0150643ed9c971159cd68bba7a44a12c9247fab3 100644 (file)
@@ -1995,9 +1995,9 @@ Remotes are configured using these settings in `.git/config`.
 
 * `annex.listen`
 
-  Configures which address the webapp listens on. The default is localhost.
-  Can be either an IP address, or a hostname that resolves to the desired
-  address.
+  Configures which IP address the webapp listens on. 
+  The default is localhost. Can be either an IP address, 
+  or a hostname that resolves to the desired address.
 
 # CONFIGURATION VIA .gitattributes