From: Christian Couder <chriscool@tuxfamily.org>
To: Junio Hamano <junkio@cox.net>, Eric Wong <normalperson@yhbt.net>
Cc: git@vger.kernel.org
Subject: [PATCH 1/2] Documentation: instaweb: add 'git-web--browse' information.
Date: Sat, 9 Feb 2008 07:10:57 +0100 [thread overview]
Message-ID: <20080209071058.6b64fb32.chriscool@tuxfamily.org> (raw)
Now that 'git-instaweb' uses 'git-web--browse', update the
documentation accordingly.
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
Documentation/git-instaweb.txt | 27 +++++++++++++++++++++++----
1 files changed, 23 insertions(+), 4 deletions(-)
The added documentation is copied from 'Documentation/git-help.txt',
so maybe it would be better for 'git-web--browse' to have its own
documentation and to refer to it in both 'git-help.txt' and
'git-instaweb.txt'.
diff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt
index 841e8fa..a1456ab 100644
--- a/Documentation/git-instaweb.txt
+++ b/Documentation/git-instaweb.txt
@@ -38,10 +38,23 @@ OPTIONS
The port number to bind the httpd to. (Default: 1234)
-b|--browser::
-
- The web browser command-line to execute to view the gitweb page.
- If blank, the URL of the gitweb instance will be printed to
- stdout. (Default: 'firefox')
+ The web browser that should be used to view the gitweb
+ page. This will be passed to the 'git-web--browse' helper
+ script along with the URL of the gitweb instance. If the
+ script fails, the URL will be printed to stdout.
++
+Note that the 'git-web--browse' script tries, as much as possible, to
+display the HTML page in a new tab on an already opened browser.
++
+The following browsers are currently supported by 'git-web--browse':
++
+* firefox (this is the default under X Window when not using KDE)
+* iceweasel
+* konqueror (this is the default under KDE)
+* w3m (this is the default outside X Window)
+* links
+* lynx
+* dillo
--start::
Start the httpd instance and exit. This does not generate
@@ -74,6 +87,12 @@ You may specify configuration in your .git/config
If the configuration variable 'instaweb.browser' is not set,
'web.browser' will be used instead if it is defined.
+You can explicitly provide a full path to your preferred browser by
+setting the configuration variable 'browser.<tool>.path'. For example,
+you can configure the absolute path to firefox by setting
+'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
+is available in PATH.
+
Author
------
Written by Eric Wong <normalperson@yhbt.net>
--
1.5.4.16.g9f0c3
reply other threads:[~2008-02-09 6:06 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20080209071058.6b64fb32.chriscool@tuxfamily.org \
--to=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--cc=junkio@cox.net \
--cc=normalperson@yhbt.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).