{"thread":{"id":"12339","subject":"[PATCH] Documentation: help: describe 'man.viewer' config variable.","startedAt":"2008-02-27T05:55:35Z","lastAt":"2008-02-27T13:22:43Z","messageCount":2,"participants":["Christian Couder","しらいしななこ"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"70058","messageId":"20080227065535.8ac7883a.chriscool@tuxfamily.org","threadId":"12339","inReplyTo":null,"subject":"[PATCH] Documentation: help: describe 'man.viewer' config variable.","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2008-02-27T05:55:35Z","receivedAt":"2008-02-27T05:55:35Z","isPatch":true,"sender":{"key":"christian.couder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/208954?v=4"},"body":"Signed-off-by: Christian Couder <chriscool@tuxfamily.org>\n---\n Documentation/config.txt   |    4 ++++\n Documentation/git-help.txt |   32 ++++++++++++++++++++++----------\n 2 files changed, 26 insertions(+), 10 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 45bf8cd..3920285 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -743,6 +743,10 @@ log.showroot::\n \tTools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which\n \tnormally hide the root commit will now show it. True by default.\n \n+man.viewer::\n+\tSpecify the program that will be used to display help in the\n+\t'man' format. See linkgit:git-help[1].\n+\n merge.summary::\n \tWhether to include summaries of merged commits in newly created\n \tmerge commit messages. False by default.\ndiff --git a/Documentation/git-help.txt b/Documentation/git-help.txt\nindex 0926dc1..09227b3 100644\n--- a/Documentation/git-help.txt\n+++ b/Documentation/git-help.txt\n@@ -33,17 +33,21 @@ OPTIONS\n \toption supersedes any other option.\n \n -i|--info::\n-\tUse the 'info' program to display the manual page, instead of\n-\tthe 'man' program that is used by default.\n+\tDisplay manual documentation about the command in Info\n+\tformat. The 'info' program will be used for that purpose.\n \n -m|--man::\n-\tUse the 'man' program to display the manual page. This may be\n-\tused to override a value set in the 'help.format'\n-\tconfiguration variable.\n+\tDisplay manual documentation about the command in Man format.\n+\tThis option may be used to override a value set in the\n+\t'help.format' configuration variable.\n++\n+By default the 'man' program will be used to display the man pages,\n+but the 'man.viewer' configuration variable may be used to choose\n+another display program (see below).\n \n -w|--web::\n-\tUse a web browser to display the HTML manual page, instead of\n-\tthe 'man' program that is used by default.\n+\tDisplay manual documentation about the command in HTLM format.\n+\tA web browser will be used for that purpose.\n +\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@@ -61,15 +65,23 @@ line option:\n \n * \"man\" corresponds to '-m|--man',\n * \"info\" corresponds to '-i|--info',\n-* \"web\" or \"html\" correspond to '-w|--web',\n+* \"web\" or \"html\" correspond to '-w|--web'.\n \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 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:\n+The 'man.viewer' config variable will be checked if the 'man' format\n+is chosen. Only the following values are currently supported:\n+\n+* \"man\": use the 'man' program as usual,\n+* \"woman\": use 'emacsclient' to launch the \"woman\" mode in emacs\n+(this only works starting with emacsclient versions 22),\n+* \"konqueror\": use a man KIO slave in konqueror.\n+\n+Note that all these configuration variables should probably be set\n+using the '--global' flag, for example like this:\n \n ------------------------------------------------\n $ git config --global help.format web\n-- \n1.5.4.2.233.gf355.dirty\n"},{"id":"70086","messageId":"200802271323.m1RDNGTQ025557@mi1.bluebottle.com","threadId":"12339","inReplyTo":"20080227065535.8ac7883a.chriscool@tuxfamily.org","subject":"Re: [PATCH] Documentation: help: describe 'man.viewer' config variable.","fromName":"しらいしななこ","fromEmail":"nanako3@bluebottle.com","sentAt":"2008-02-27T13:22:43Z","receivedAt":"2008-02-27T13:22:43Z","isPatch":true,"sender":{"key":"nanako3@lavabit.com","avatar":"https://gravatar.com/avatar/3777b9e201c5883a62b1a6fdf7c53f2d712d1d80989146063ea861e33aad72a8?d=mp&s=160"},"body":"Quoting Christian Couder <chriscool@tuxfamily.org>:\n\n> +man.viewer::\n> +\tSpecify the program that will be used to display help in the\n> +\t'man' format. See linkgit:git-help[1].\n> +\n>  -i|--info::\n> -\tUse the 'info' program to display the manual page, instead of\n> -\tthe 'man' program that is used by default.\n> +\tDisplay manual documentation about the command in Info\n> +\tformat. The 'info' program will be used for that purpose.\n\nI am not a native speaker of the English language, but \"manual documentation about\" feels duplicatedly redundant, at least to me.  I think it is more common to say \"the manual page for\", or \"the man page for\".\n\n>  -m|--man::\n> -\tUse the 'man' program to display the manual page. This may be\n> -\tused to override a value set in the 'help.format'\n> -\tconfiguration variable.\n> +\tDisplay manual documentation about the command in Man format.\n\nAn earlier description for man.viewer says \"in the 'man' format\".\n\n> +\tThis option may be used to override a value set in the\n> +\t'help.format' configuration variable.\n> ++\n> +By default the 'man' program will be used to display the man pages,\n\nAnd this part says \"the man pages\".\n\n>  -w|--web::\n> -\tUse a web browser to display the HTML manual page, instead of\n> -\tthe 'man' program that is used by default.\n> +\tDisplay manual documentation about the command in HTLM format.\n> +\tA web browser will be used for that purpose.\n\nIs this a mistyped \"HTML format\"?\n\n-- \nNanako Shiraishi\nhttp://ivory.ap.teacup.com/nanako3/\n\n----------------------------------------------------------------------\nGet a free email address with REAL anti-spam protection.\nhttp://www.bluebottle.com/tag/1\n"}]}