From mboxrd@z Thu Jan 1 00:00:00 1970 From: Christian Couder Subject: help: add "man.viewer" config var to use "woman" or "konqueror" Date: Tue, 26 Feb 2008 07:06:48 +0100 Message-ID: <20080226070648.5d799056.chriscool@tuxfamily.org> Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Cc: Junio Hamano , Pascal Obry To: git@vger.kernel.org X-From: git-owner@vger.kernel.org Tue Feb 26 07:01:48 2008 Return-path: Envelope-to: gcvg-git-2@gmane.org Received: from vger.kernel.org ([209.132.176.167]) by lo.gmane.org with esmtp (Exim 4.50) id 1JTssu-0007I7-7p for gcvg-git-2@gmane.org; Tue, 26 Feb 2008 07:01:48 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752068AbYBZGBK (ORCPT ); Tue, 26 Feb 2008 01:01:10 -0500 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1751806AbYBZGBJ (ORCPT ); Tue, 26 Feb 2008 01:01:09 -0500 Received: from smtp1-g19.free.fr ([212.27.42.27]:46855 "EHLO smtp1-g19.free.fr" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751705AbYBZGBH (ORCPT ); Tue, 26 Feb 2008 01:01:07 -0500 Received: from smtp1-g19.free.fr (localhost.localdomain [127.0.0.1]) by smtp1-g19.free.fr (Postfix) with ESMTP id 41E361AB2B4; Tue, 26 Feb 2008 07:01:06 +0100 (CET) Received: from localhost.boubyland (gre92-7-82-243-130-161.fbx.proxad.net [82.243.130.161]) by smtp1-g19.free.fr (Postfix) with SMTP id A68C31AB2BD; Tue, 26 Feb 2008 07:01:03 +0100 (CET) X-Mailer: Sylpheed 2.4.8 (GTK+ 2.12.5; i486-pc-linux-gnu) Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: 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 --- help.c | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 files changed, 79 insertions(+), 1 deletions(-) Junio wrote: > I have to wonder if it makes sense to just define the interface > to launch an external user-supplied command, and have that > command line determine what actually should happen, e.g. inspect > DISPLAY and check emacs version etc. There is some work on git-mergetool to do this. When it's integrated I will see if I can do something like that for git-help too. diff --git a/help.c b/help.c index e57a50e..d700681 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,84 @@ static void setup_man_path(void) strbuf_release(&new_path); } +static int check_emacsclient_version() +{ + struct strbuf buffer = STRBUF_INIT; + ssize_t size; + 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; + } + size = 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