git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/2 resend] help: add "man.viewer" config var to use "woman" or "konqueror"
@ 2008-03-07  7:46 Christian Couder
  2008-03-11  1:00 ` Xavier Maillard
  0 siblings, 1 reply; 4+ messages in thread
From: Christian Couder @ 2008-03-07  7:46 UTC (permalink / raw)
  To: Junio Hamano, Pascal Obry, Xavier Maillard; +Cc: git

This patch makes it possible to view man pages using other tools
than the "man" program. It also implements support for emacs'
"woman" and konqueror with the man KIO slave to view man pages.

Note that "emacsclient" is used with option "-e" to launch "woman"
on emacs and this works only on versions >= 22.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
 help.c |   81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 80 insertions(+), 1 deletions(-)

	Now that the run-command patch has been integrated, this
	seems to work as expected for me with emacsclient 21 and 22.

	Thanks.

diff --git a/help.c b/help.c
index e57a50e..2cb152d 100644
--- a/help.c
+++ b/help.c
@@ -8,6 +8,9 @@
 #include "exec_cmd.h"
 #include "common-cmds.h"
 #include "parse-options.h"
+#include "run-command.h"
+
+static const char *man_viewer;
 
 enum help_format {
 	HELP_FORMAT_MAN,
@@ -50,6 +53,8 @@ static int git_help_config(const char *var, const char *value)
 		help_format = parse_help_format(value);
 		return 0;
 	}
+	if (!strcmp(var, "man.viewer"))
+		return git_config_string(&man_viewer, var, value);
 	return git_default_config(var, value);
 }
 
@@ -345,11 +350,85 @@ static void setup_man_path(void)
 	strbuf_release(&new_path);
 }
 
+static int check_emacsclient_version(void)
+{
+	struct strbuf buffer = STRBUF_INIT;
+	struct child_process ec_process;
+	const char *argv_ec[] = { "emacsclient", "--version", NULL };
+	int version;
+
+	/* emacsclient prints its version number on stderr */
+	memset(&ec_process, 0, sizeof(ec_process));
+	ec_process.argv = argv_ec;
+	ec_process.err = -1;
+	ec_process.stdout_to_stderr = 1;
+	if (start_command(&ec_process)) {
+		fprintf(stderr, "Failed to start emacsclient.\n");
+		return -1;
+	}
+	strbuf_read(&buffer, ec_process.err, 20);
+	close(ec_process.err);
+
+	/*
+	 * Don't bother checking return value, because "emacsclient --version"
+	 * seems to always exits with code 1.
+	 */
+	finish_command(&ec_process);
+
+	if (prefixcmp(buffer.buf, "emacsclient")) {
+		fprintf(stderr, "Failed to parse emacsclient version.\n");
+		strbuf_release(&buffer);
+		return -1;
+	}
+
+	strbuf_remove(&buffer, 0, strlen("emacsclient"));
+	version = atoi(buffer.buf);
+
+	if (version < 22) {
+		fprintf(stderr,
+			"emacsclient version '%d' too old (< 22).\n",
+			version);
+		strbuf_release(&buffer);
+		return -1;
+	}
+
+	strbuf_release(&buffer);
+	return 0;
+}
+
+static void exec_woman_emacs(const char *page)
+{
+	if (!check_emacsclient_version()) {
+		/* This works only with emacsclient version >= 22. */
+		struct strbuf man_page = STRBUF_INIT;
+		strbuf_addf(&man_page, "(woman \"%s\")", page);
+		execlp("emacsclient", "emacsclient", "-e", man_page.buf, NULL);
+	} else
+		execlp("man", "man", page, NULL);
+}
+
+static void exec_man_konqueror(const char *page)
+{
+	const char *display = getenv("DISPLAY");
+	if (display && *display) {
+		struct strbuf man_page = STRBUF_INIT;
+		strbuf_addf(&man_page, "man:%s(1)", page);
+		execlp("kfmclient", "kfmclient", "newTab", man_page.buf, NULL);
+	} else
+		execlp("man", "man", page, NULL);
+}
+
 static void show_man_page(const char *git_cmd)
 {
 	const char *page = cmd_to_page(git_cmd);
 	setup_man_path();
-	execlp("man", "man", page, NULL);
+	if (!man_viewer || !strcmp(man_viewer, "man"))
+		execlp("man", "man", page, NULL);
+	if (!strcmp(man_viewer, "woman"))
+		exec_woman_emacs(page);
+	if (!strcmp(man_viewer, "konqueror"))
+		exec_man_konqueror(page);
+	die("'%s': unsupported man viewer.", man_viewer);
 }
 
 static void show_info_page(const char *git_cmd)
-- 
1.5.4.3.328.gcaed.dirty

^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH 1/2 resend] help: add "man.viewer" config var to use "woman" or "konqueror"
  2008-03-07  7:46 [PATCH 1/2 resend] help: add "man.viewer" config var to use "woman" or "konqueror" Christian Couder
@ 2008-03-11  1:00 ` Xavier Maillard
  2008-03-11  5:48   ` Christian Couder
  0 siblings, 1 reply; 4+ messages in thread
From: Xavier Maillard @ 2008-03-11  1:00 UTC (permalink / raw)
  To: Christian Couder; +Cc: junkio, pascal, nanako3, git

   This patch makes it possible to view man pages using other tools
   than the "man" program. It also implements support for emacs'
   "woman" and konqueror with the man KIO slave to view man pages.

   Note that "emacsclient" is used with option "-e" to launch "woman"
   on emacs and this works only on versions >= 22.

   Signed-off-by: Christian Couder <chriscool@tuxfamily.org>

Acked-off-by: Xavier Maillard <xma@gnu.org>

There is something wrong though. git cmd --help should wait for
the server to return in my opinion.

	Xavier
-- 
http://www.gnu.org
http://www.april.org
http://www.lolica.org

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH 1/2 resend] help: add "man.viewer" config var to use "woman" or "konqueror"
  2008-03-11  1:00 ` Xavier Maillard
@ 2008-03-11  5:48   ` Christian Couder
  2008-03-12  1:00     ` Xavier Maillard
  0 siblings, 1 reply; 4+ messages in thread
From: Christian Couder @ 2008-03-11  5:48 UTC (permalink / raw)
  To: Xavier Maillard; +Cc: junkio, pascal, nanako3, git

Le mardi 11 mars 2008, Xavier Maillard a écrit :
>    This patch makes it possible to view man pages using other tools
>    than the "man" program. It also implements support for emacs'
>    "woman" and konqueror with the man KIO slave to view man pages.
>
>    Note that "emacsclient" is used with option "-e" to launch "woman"
>    on emacs and this works only on versions >= 22.
>
>    Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
>
> Acked-off-by: Xavier Maillard <xma@gnu.org>

Thanks. ("Tested-by:" may be better though.) 

> There is something wrong though. git cmd --help should wait for
> the server to return in my opinion.

When I try something like the following on the command line:

$ emacsclient -e '(woman "fork")'

emacsclient doesn't wait for the server to return.

So I don't see how and why we should wait.

Thanks,
Christian.

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH 1/2 resend] help: add "man.viewer" config var to use "woman" or "konqueror"
  2008-03-11  5:48   ` Christian Couder
@ 2008-03-12  1:00     ` Xavier Maillard
  0 siblings, 0 replies; 4+ messages in thread
From: Xavier Maillard @ 2008-03-12  1:00 UTC (permalink / raw)
  To: Christian Couder; +Cc: junkio, pascal, nanako3, git

   > There is something wrong though. git cmd --help should wait for
   > the server to return in my opinion.

   When I try something like the following on the command line:

   $ emacsclient -e '(woman "fork")'

   emacsclient doesn't wait for the server to return.

   So I don't see how and why we should wait.

You are right. In fact, we can only wait for the server to return
when we edit a file. Sorry for the noise

Tested-by: Xavier Maillard <xma@gnu.org>

	Xavier
-- 
http://www.gnu.org
http://www.april.org
http://www.lolica.org

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2008-03-12  1:36 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2008-03-07  7:46 [PATCH 1/2 resend] help: add "man.viewer" config var to use "woman" or "konqueror" Christian Couder
2008-03-11  1:00 ` Xavier Maillard
2008-03-11  5:48   ` Christian Couder
2008-03-12  1:00     ` Xavier Maillard

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).