{"thread":{"id":"12097","subject":"[PATCH] Documentation: add 'git-web--browse.txt' and simplify other docs.","startedAt":"2008-02-14T07:01:23Z","lastAt":"2008-02-14T07:01:23Z","messageCount":1,"participants":["Christian Couder"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"68719","messageId":"20080214080123.5ffb1f19.chriscool@tuxfamily.org","threadId":"12097","inReplyTo":null,"subject":"[PATCH] Documentation: add 'git-web--browse.txt' and simplify other docs.","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2008-02-14T07:01:23Z","receivedAt":"2008-02-14T07:01:23Z","isPatch":true,"sender":{"key":"christian.couder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/208954?v=4"},"body":"'git-help.txt' and 'git-instaweb.txt' contained duplicated\ninformation about 'git-web--browse'.\n\nThis patch puts this information where it belongs.\n\nSigned-off-by: Christian Couder <chriscool@tuxfamily.org>\n---\n Documentation/git-help.txt        |   24 +----------\n Documentation/git-instaweb.txt    |   27 ++----------\n Documentation/git-web--browse.txt |   78 +++++++++++++++++++++++++++++++++++++\n 3 files changed, 86 insertions(+), 43 deletions(-)\n create mode 100644 Documentation/git-web--browse.txt\n\ndiff --git a/Documentation/git-help.txt b/Documentation/git-help.txt\nindex ad41aab..0926dc1 100644\n--- a/Documentation/git-help.txt\n+++ b/Documentation/git-help.txt\n@@ -48,26 +48,8 @@ OPTIONS\n The web browser can be specified using the configuration variable\n 'help.browser', or 'web.browser' if the former is not set. If none of\n these config variables is set, the 'git-web--browse' helper script\n-(called by 'git-help') will pick a suitable default.\n-+\n-You can explicitly provide a full path to your preferred browser by\n-setting the configuration variable 'browser.<tool>.path'. For example,\n-you can configure the absolute path to firefox by setting\n-'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool\n-is available in PATH.\n-+\n-Note that the script tries, as much as possible, to display the HTML\n-page in a new tab on an already opened browser.\n-+\n-The following browsers are currently supported by 'git-web--browse':\n-+\n-* firefox (this is the default under X Window when not using KDE)\n-* iceweasel\n-* konqueror (this is the default under KDE)\n-* w3m (this is the default outside X Window)\n-* links\n-* lynx\n-* dillo\n+(called by 'git-help') will pick a suitable default. See\n+linkgit:git-web--browse[1] for more information about this.\n \n CONFIGURATION VARIABLES\n -----------------------\n@@ -84,7 +66,7 @@ line option:\n The 'help.browser', 'web.browser' and 'browser.<tool>.path' will also\n be checked if the 'web' format is chosen (either by command line\n option or configuration variable). See '-w|--web' in the OPTIONS\n-section above.\n+section above and linkgit:git-web--browse[1].\n \n Note that these configuration variables should probably be set using\n the '--global' flag, for example like this:\ndiff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt\nindex a1456ab..51f1532 100644\n--- a/Documentation/git-instaweb.txt\n+++ b/Documentation/git-instaweb.txt\n@@ -40,21 +40,9 @@ OPTIONS\n -b|--browser::\n \tThe web browser that should be used to view the gitweb\n \tpage. This will be passed to the 'git-web--browse' helper\n-\tscript along with the URL of the gitweb instance. If the\n-\tscript fails, the URL will be printed to stdout.\n-+\n-Note that the 'git-web--browse' script tries, as much as possible, to\n-display the HTML page in a new tab on an already opened browser.\n-+\n-The following browsers are currently supported by 'git-web--browse':\n-+\n-* firefox (this is the default under X Window when not using KDE)\n-* iceweasel\n-* konqueror (this is the default under KDE)\n-* w3m (this is the default outside X Window)\n-* links\n-* lynx\n-* dillo\n+\tscript along with the URL of the gitweb instance. See\n+\tlinkgit:git-web--browse[1] for more information about this. If\n+\tthe script fails, the URL will be printed to stdout.\n \n --start::\n \tStart the httpd instance and exit.  This does not generate\n@@ -85,13 +73,8 @@ You may specify configuration in your .git/config\n -----------------------------------------------------------------------\n \n If the configuration variable 'instaweb.browser' is not set,\n-'web.browser' will be used instead if it is defined.\n-\n-You can explicitly provide a full path to your preferred browser by\n-setting the configuration variable 'browser.<tool>.path'. For example,\n-you can configure the absolute path to firefox by setting\n-'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool\n-is available in PATH.\n+'web.browser' will be used instead if it is defined. See\n+linkgit:git-web--browse[1] for more information about this.\n \n Author\n ------\ndiff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt\nnew file mode 100644\nindex 0000000..df57d01\n--- /dev/null\n+++ b/Documentation/git-web--browse.txt\n@@ -0,0 +1,78 @@\n+git-web--browse(1)\n+==================\n+\n+NAME\n+----\n+git-web--browse - git helper script to launch a web browser\n+\n+SYNOPSIS\n+--------\n+'git-web--browse' [OPTIONS] URL/FILE ...\n+\n+DESCRIPTION\n+-----------\n+\n+This script tries, as much as possible, to display the URLs and FILEs\n+that are passed as arguments, as HTML pages in new tabs on an already\n+opened web browser.\n+\n+The following browsers (or commands) are currently supported:\n+\n+* firefox (this is the default under X Window when not using KDE)\n+* iceweasel\n+* konqueror (this is the default under KDE)\n+* w3m (this is the default outside graphical environments)\n+* links\n+* lynx\n+* dillo\n+* open (this is the default under Mac OS X GUI)\n+\n+OPTIONS\n+-------\n+-b BROWSER|--browser=BROWSER::\n+\tUse the specified BROWSER. It must be in the list of supported\n+\tbrowsers.\n+\n+-t BROWSER|--tool=BROWSER::\n+\tSame as above.\n+\n+-c CONF.VAR|--config=CONF.VAR::\n+\tCONF.VAR is looked up in the git config files. If it's set,\n+\tthen its value specify the browser that should be used.\n+\n+CONFIGURATION VARIABLES\n+-----------------------\n+\n+The web browser can be specified using a configuration variable passed\n+with the -c (or --config) command line option, or the 'web.browser'\n+configuration variable if the former is not used.\n+\n+You can explicitly provide a full path to your preferred browser by\n+setting the configuration variable 'browser.<tool>.path'. For example,\n+you can configure the absolute path to firefox by setting\n+'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool\n+is available in PATH.\n+\n+Note that these configuration variables should probably be set using\n+the '--global' flag, for example like this:\n+\n+------------------------------------------------\n+$ git config --global web.browser firefox\n+------------------------------------------------\n+\n+as they are probably more user specific than repository specific.\n+See linkgit:git-config[1] for more information about this.\n+\n+Author\n+------\n+Written by Christian Couder <chriscool@tuxfamily.org> and the git-list\n+<git@vger.kernel.org>, based on git-mergetool by Theodore Y. Ts'o.\n+\n+Documentation\n+-------------\n+Documentation by Christian Couder <chriscool@tuxfamily.org> and the\n+git-list <git@vger.kernel.org>.\n+\n+GIT\n+---\n+Part of the linkgit:git[7] suite\n-- \n1.5.4.20.gc135a-dirty\n"}]}