From 52d4f36b2b793e15c214d0bc9dcfb817a4061631 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 18 Jan 2024 12:58:00 -0400 Subject: [PATCH] document that --listen specifies an IP address 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 | 4 ++-- doc/git-annex.mdwn | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/git-annex-webapp.mdwn b/doc/git-annex-webapp.mdwn index 064996ea16..21ae9fff54 100644 --- a/doc/git-annex-webapp.mdwn +++ b/doc/git-annex-webapp.mdwn @@ -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. diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index deeb4703ea..0150643ed9 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -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