[thirdparty/git.git] / help.c

/*
 * builtin-help.c
 *
 * Builtin help-related commands (help, usage, version)
 */
#include "cache.h"
#include "builtin.h"
#include "exec_cmd.h"
#include "common-cmds.h"
#include "parse-options.h"
#include "run-command.h"

static struct man_viewer_list {
	struct man_viewer_list *next;
	char name[FLEX_ARRAY];
} *man_viewer_list;

static struct man_viewer_info_list {
	struct man_viewer_info_list *next;
	const char *info;
	char name[FLEX_ARRAY];
} *man_viewer_info_list;

enum help_format {
	HELP_FORMAT_MAN,
	HELP_FORMAT_INFO,
	HELP_FORMAT_WEB,
};

static int show_all = 0;
static enum help_format help_format = HELP_FORMAT_MAN;
static struct option builtin_help_options[] = {
	OPT_BOOLEAN('a', "all", &show_all, "print all available commands"),
	OPT_SET_INT('m', "man", &help_format, "show man page", HELP_FORMAT_MAN),
	OPT_SET_INT('w', "web", &help_format, "show manual in web browser",
			HELP_FORMAT_WEB),
	OPT_SET_INT('i', "info", &help_format, "show info page",
			HELP_FORMAT_INFO),
	OPT_END(),
};

static const char * const builtin_help_usage[] = {
	"git help [--all] [--man|--web|--info] [command]",
	NULL
};

static enum help_format parse_help_format(const char *format)
{
	if (!strcmp(format, "man"))
		return HELP_FORMAT_MAN;
	if (!strcmp(format, "info"))
		return HELP_FORMAT_INFO;
	if (!strcmp(format, "web") || !strcmp(format, "html"))
		return HELP_FORMAT_WEB;
	die("unrecognized help format '%s'", format);
}

static const char *get_man_viewer_info(const char *name)
{
	struct man_viewer_info_list *viewer;

	for (viewer = man_viewer_info_list; viewer; viewer = viewer->next)
	{
		if (!strcasecmp(name, viewer->name))
			return viewer->info;
	}
	return NULL;
}

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* path, const char *page)
{
	if (!check_emacsclient_version()) {
		/* This works only with emacsclient version >= 22. */
		struct strbuf man_page = STRBUF_INIT;

		if (!path)
			path = "emacsclient";
		strbuf_addf(&man_page, "(woman \"%s\")", page);
		execlp(path, "emacsclient", "-e", man_page.buf, NULL);
		warning("failed to exec '%s': %s", path, strerror(errno));
	}
}

static void exec_man_konqueror(const char* path, const char *page)
{
	const char *display = getenv("DISPLAY");
	if (display && *display) {
		struct strbuf man_page = STRBUF_INIT;
		const char *filename = "kfmclient";

		/* It's simpler to launch konqueror using kfmclient. */
		if (path) {
			const char *file = strrchr(path, '/');
			if (file && !strcmp(file + 1, "konqueror")) {
				char *new = xstrdup(path);
				char *dest = strrchr(new, '/');

				/* strlen("konqueror") == strlen("kfmclient") */
				strcpy(dest + 1, "kfmclient");
				path = new;
			}
			if (file)
				filename = file;
		} else
			path = "kfmclient";
		strbuf_addf(&man_page, "man:%s(1)", page);
		execlp(path, filename, "newTab", man_page.buf, NULL);
		warning("failed to exec '%s': %s", path, strerror(errno));
	}
}

static void exec_man_man(const char* path, const char *page)
{
	if (!path)
		path = "man";
	execlp(path, "man", page, NULL);
	warning("failed to exec '%s': %s", path, strerror(errno));
}

static void exec_man_cmd(const char *cmd, const char *page)
{
	struct strbuf shell_cmd = STRBUF_INIT;
	strbuf_addf(&shell_cmd, "%s %s", cmd, page);
	execl("/bin/sh", "sh", "-c", shell_cmd.buf, NULL);
	warning("failed to exec '%s': %s", cmd, strerror(errno));
}

static void add_man_viewer(const char *name)
{
	struct man_viewer_list **p = &man_viewer_list;
	size_t len = strlen(name);

	while (*p)
		p = &((*p)->next);
	*p = xcalloc(1, (sizeof(**p) + len + 1));
	strncpy((*p)->name, name, len);
}

static int supported_man_viewer(const char *name, size_t len)
{
	return (!strncasecmp("man", name, len) ||
		!strncasecmp("woman", name, len) ||
		!strncasecmp("konqueror", name, len));
}

static void do_add_man_viewer_info(const char *name,
				   size_t len,
				   const char *value)
{
	struct man_viewer_info_list *new = xcalloc(1, sizeof(*new) + len + 1);

	strncpy(new->name, name, len);
	new->info = xstrdup(value);
	new->next = man_viewer_info_list;
	man_viewer_info_list = new;
}

static int add_man_viewer_path(const char *name,
			       size_t len,
			       const char *value)
{
	if (supported_man_viewer(name, len))
		do_add_man_viewer_info(name, len, value);
	else
		warning("'%s': path for unsupported man viewer.\n"
			"Please consider using 'man.<tool>.cmd' instead.",
			name);

	return 0;
}

static int add_man_viewer_cmd(const char *name,
			      size_t len,
			      const char *value)
{
	if (supported_man_viewer(name, len))
		warning("'%s': cmd for supported man viewer.\n"
			"Please consider using 'man.<tool>.path' instead.",
			name);
	else
		do_add_man_viewer_info(name, len, value);

	return 0;
}

static int add_man_viewer_info(const char *var, const char *value)
{
	const char *name = var + 4;
	const char *subkey = strrchr(name, '.');

	if (!subkey)
		return error("Config with no key for man viewer: %s", name);

	if (!strcmp(subkey, ".path")) {
		if (!value)
			return config_error_nonbool(var);
		return add_man_viewer_path(name, subkey - name, value);
	}
	if (!strcmp(subkey, ".cmd")) {
		if (!value)
			return config_error_nonbool(var);
		return add_man_viewer_cmd(name, subkey - name, value);
	}

	warning("'%s': unsupported man viewer sub key.", subkey);
	return 0;
}

static int git_help_config(const char *var, const char *value, void *cb)
{
	if (!strcmp(var, "help.format")) {
		if (!value)
			return config_error_nonbool(var);
		help_format = parse_help_format(value);
		return 0;
	}
	if (!strcmp(var, "man.viewer")) {
		if (!value)
			return config_error_nonbool(var);
		add_man_viewer(value);
		return 0;
	}
	if (!prefixcmp(var, "man."))
		return add_man_viewer_info(var, value);

	return git_default_config(var, value, cb);
}

/* most GUI terminals set COLUMNS (although some don't export it) */
static int term_columns(void)
{
	char *col_string = getenv("COLUMNS");
	int n_cols;

	if (col_string && (n_cols = atoi(col_string)) > 0)
		return n_cols;

#ifdef TIOCGWINSZ
	{
		struct winsize ws;
		if (!ioctl(1, TIOCGWINSZ, &ws)) {
			if (ws.ws_col)
				return ws.ws_col;
		}
	}
#endif

	return 80;
}

static inline void mput_char(char c, unsigned int num)
{
	while(num--)
		putchar(c);
}

static struct cmdnames {
	int alloc;
	int cnt;
	struct cmdname {
		size_t len;
		char name[1];
	} **names;
} main_cmds, other_cmds;

static void add_cmdname(struct cmdnames *cmds, const char *name, int len)
{
	struct cmdname *ent = xmalloc(sizeof(*ent) + len);

	ent->len = len;
	memcpy(ent->name, name, len);
	ent->name[len] = 0;

	ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
	cmds->names[cmds->cnt++] = ent;
}

static int cmdname_compare(const void *a_, const void *b_)
{
	struct cmdname *a = *(struct cmdname **)a_;
	struct cmdname *b = *(struct cmdname **)b_;
	return strcmp(a->name, b->name);
}

static void uniq(struct cmdnames *cmds)
{
	int i, j;

	if (!cmds->cnt)
		return;

	for (i = j = 1; i < cmds->cnt; i++)
		if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
			cmds->names[j++] = cmds->names[i];

	cmds->cnt = j;
}

static void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
{
	int ci, cj, ei;
	int cmp;

	ci = cj = ei = 0;
	while (ci < cmds->cnt && ei < excludes->cnt) {
		cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
		if (cmp < 0)
			cmds->names[cj++] = cmds->names[ci++];
		else if (cmp == 0)
			ci++, ei++;
		else if (cmp > 0)
			ei++;
	}

	while (ci < cmds->cnt)
		cmds->names[cj++] = cmds->names[ci++];

	cmds->cnt = cj;
}

static void pretty_print_string_list(struct cmdnames *cmds, int longest)
{
	int cols = 1, rows;
	int space = longest + 1; /* min 1 SP between words */
	int max_cols = term_columns() - 1; /* don't print *on* the edge */
	int i, j;

	if (space < max_cols)
		cols = max_cols / space;
	rows = (cmds->cnt + cols - 1) / cols;

	for (i = 0; i < rows; i++) {
		printf("  ");

		for (j = 0; j < cols; j++) {
			int n = j * rows + i;
			int size = space;
			if (n >= cmds->cnt)
				break;
			if (j == cols-1 || n + rows >= cmds->cnt)
				size = 1;
			printf("%-*s", size, cmds->names[n]->name);
		}
		putchar('\n');
	}
}

static int is_executable(const char *name)
{
	struct stat st;

	if (stat(name, &st) || /* stat, not lstat */
	    !S_ISREG(st.st_mode))
		return 0;

#ifdef __MINGW32__
	/* cannot trust the executable bit, peek into the file instead */
	char buf[3] = { 0 };
	int n;
	int fd = open(name, O_RDONLY);
	st.st_mode &= ~S_IXUSR;
	if (fd >= 0) {
		n = read(fd, buf, 2);
		if (n == 2)
			/* DOS executables start with "MZ" */
			if (!strcmp(buf, "#!") || !strcmp(buf, "MZ"))
				st.st_mode |= S_IXUSR;
		close(fd);
	}
#endif
	return st.st_mode & S_IXUSR;
}

static unsigned int list_commands_in_dir(struct cmdnames *cmds,
					 const char *path)
{
	unsigned int longest = 0;
	const char *prefix = "git-";
	int prefix_len = strlen(prefix);
	DIR *dir = opendir(path);
	struct dirent *de;

	if (!dir || chdir(path))
		return 0;

	while ((de = readdir(dir)) != NULL) {
		int entlen;

		if (prefixcmp(de->d_name, prefix))
			continue;

		if (!is_executable(de->d_name))
			continue;

		entlen = strlen(de->d_name) - prefix_len;
		if (has_extension(de->d_name, ".exe"))
			entlen -= 4;

		if (longest < entlen)
			longest = entlen;

		add_cmdname(cmds, de->d_name + prefix_len, entlen);
	}
	closedir(dir);

	return longest;
}

static unsigned int load_command_list(void)
{
	unsigned int longest = 0;
	unsigned int len;
	const char *env_path = getenv("PATH");
	char *paths, *path, *colon;
	const char *exec_path = git_exec_path();

	if (exec_path)
		longest = list_commands_in_dir(&main_cmds, exec_path);

	if (!env_path) {
		fprintf(stderr, "PATH not set\n");
		exit(1);
	}

	path = paths = xstrdup(env_path);
	while (1) {
		if ((colon = strchr(path, PATH_SEP)))
			*colon = 0;

		len = list_commands_in_dir(&other_cmds, path);
		if (len > longest)
			longest = len;

		if (!colon)
			break;
		path = colon + 1;
	}
	free(paths);

	qsort(main_cmds.names, main_cmds.cnt,
	      sizeof(*main_cmds.names), cmdname_compare);
	uniq(&main_cmds);

	qsort(other_cmds.names, other_cmds.cnt,
	      sizeof(*other_cmds.names), cmdname_compare);
	uniq(&other_cmds);
	exclude_cmds(&other_cmds, &main_cmds);

	return longest;
}

static void list_commands(void)
{
	unsigned int longest = load_command_list();
	const char *exec_path = git_exec_path();

	if (main_cmds.cnt) {
		printf("available git commands in '%s'\n", exec_path);
		printf("----------------------------");
		mput_char('-', strlen(exec_path));
		putchar('\n');
		pretty_print_string_list(&main_cmds, longest);
		putchar('\n');
	}

	if (other_cmds.cnt) {
		printf("git commands available from elsewhere on your $PATH\n");
		printf("---------------------------------------------------\n");
		pretty_print_string_list(&other_cmds, longest);
		putchar('\n');
	}
}

void list_common_cmds_help(void)
{
	int i, longest = 0;

	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
		if (longest < strlen(common_cmds[i].name))
			longest = strlen(common_cmds[i].name);
	}

	puts("The most commonly used git commands are:");
	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
		printf("   %s   ", common_cmds[i].name);
		mput_char(' ', longest - strlen(common_cmds[i].name));
		puts(common_cmds[i].help);
	}
}

static int is_in_cmdlist(struct cmdnames *c, const char *s)
{
	int i;
	for (i = 0; i < c->cnt; i++)
		if (!strcmp(s, c->names[i]->name))
			return 1;
	return 0;
}

static int is_git_command(const char *s)
{
	load_command_list();
	return is_in_cmdlist(&main_cmds, s) ||
		is_in_cmdlist(&other_cmds, s);
}

static const char *prepend(const char *prefix, const char *cmd)
{
	size_t pre_len = strlen(prefix);
	size_t cmd_len = strlen(cmd);
	char *p = xmalloc(pre_len + cmd_len + 1);
	memcpy(p, prefix, pre_len);
	strcpy(p + pre_len, cmd);
	return p;
}

static const char *cmd_to_page(const char *git_cmd)
{
	if (!git_cmd)
		return "git";
	else if (!prefixcmp(git_cmd, "git"))
		return git_cmd;
	else if (is_git_command(git_cmd))
		return prepend("git-", git_cmd);
	else
		return prepend("git", git_cmd);
}

static void setup_man_path(void)
{
	struct strbuf new_path;
	const char *old_path = getenv("MANPATH");

	strbuf_init(&new_path, 0);

	/* We should always put ':' after our path. If there is no
	 * old_path, the ':' at the end will let 'man' to try
	 * system-wide paths after ours to find the manual page. If
	 * there is old_path, we need ':' as delimiter. */
	strbuf_addstr(&new_path, GIT_MAN_PATH);
	strbuf_addch(&new_path, ':');
	if (old_path)
		strbuf_addstr(&new_path, old_path);

	setenv("MANPATH", new_path.buf, 1);

	strbuf_release(&new_path);
}

static void exec_viewer(const char *name, const char *page)
{
	const char *info = get_man_viewer_info(name);

	if (!strcasecmp(name, "man"))
		exec_man_man(info, page);
	else if (!strcasecmp(name, "woman"))
		exec_woman_emacs(info, page);
	else if (!strcasecmp(name, "konqueror"))
		exec_man_konqueror(info, page);
	else if (info)
		exec_man_cmd(info, page);
	else
		warning("'%s': unknown man viewer.", name);
}

static void show_man_page(const char *git_cmd)
{
	struct man_viewer_list *viewer;
	const char *page = cmd_to_page(git_cmd);

	setup_man_path();
	for (viewer = man_viewer_list; viewer; viewer = viewer->next)
	{
		exec_viewer(viewer->name, page); /* will return when unable */
	}
	exec_viewer("man", page);
	die("no man viewer handled the request");
}

static void show_info_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
	setenv("INFOPATH", GIT_INFO_PATH, 1);
	execlp("info", "info", "gitman", page, NULL);
}

static void get_html_page_path(struct strbuf *page_path, const char *page)
{
	struct stat st;
	const char *html_path = system_path(GIT_HTML_PATH);

	/* Check that we have a git documentation directory. */
	if (stat(mkpath("%s/git.html", html_path), &st)
	    || !S_ISREG(st.st_mode))
		die("'%s': not a documentation directory.", html_path);

	strbuf_init(page_path, 0);
	strbuf_addf(page_path, "%s/%s.html", html_path, page);
}

/*
 * If open_html is not defined in a platform-specific way (see for
 * example compat/mingw.h), we use the script web--browse to display
 * HTML.
 */
#ifndef open_html
void open_html(const char *path)
{
	execl_git_cmd("web--browse", "-c", "help.browser", path, NULL);
}
#endif

static void show_html_page(const char *git_cmd)
{
	const char *page = cmd_to_page(git_cmd);
	struct strbuf page_path; /* it leaks but we exec bellow */

	get_html_page_path(&page_path, page);

	open_html(page_path.buf);
}

void help_unknown_cmd(const char *cmd)
{
	fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
	exit(1);
}

int cmd_version(int argc, const char **argv, const char *prefix)
{
	printf("git version %s\n", git_version_string);
	return 0;
}

int cmd_help(int argc, const char **argv, const char *prefix)
{
	int nongit;
	const char *alias;

	setup_git_directory_gently(&nongit);
	git_config(git_help_config, NULL);

	argc = parse_options(argc, argv, builtin_help_options,
			builtin_help_usage, 0);

	if (show_all) {
		printf("usage: %s\n\n", git_usage_string);
		list_commands();
		printf("%s\n", git_more_info_string);
		return 0;
	}

	if (!argv[0]) {
		printf("usage: %s\n\n", git_usage_string);
		list_common_cmds_help();
		printf("\n%s\n", git_more_info_string);
		return 0;
	}

	alias = alias_lookup(argv[0]);
	if (alias && !is_git_command(argv[0])) {
		printf("`git %s' is aliased to `%s'\n", argv[0], alias);
		return 0;
	}

	switch (help_format) {
	case HELP_FORMAT_MAN:
		show_man_page(argv[0]);
		break;
	case HELP_FORMAT_INFO:
		show_info_page(argv[0]);
		break;
	case HELP_FORMAT_WEB:
		show_html_page(argv[0]);
		break;
	}

	return 0;
}
Commit	Line	Data
70827b15 LT	1	/*
	2	* builtin-help.c
	3	*
	4	* Builtin help-related commands (help, usage, version)
	5	*/
	6	#include "cache.h"
	7	#include "builtin.h"
	8	#include "exec_cmd.h"
	9	#include "common-cmds.h"
41eb33bd	10	#include "parse-options.h"
64949984 CC	11	#include "run-command.h"
64949984 CC	12
69099d6b	13	static struct man_viewer_list {
69099d6b	14	struct man_viewer_list *next;
7b15f872	15	char name[FLEX_ARRAY];
69099d6b	16	} *man_viewer_list;
41eb33bd	17
7b15f872 CC	18	static struct man_viewer_info_list {
	19	struct man_viewer_info_list *next;
	20	const char *info;
	21	char name[FLEX_ARRAY];
	22	} *man_viewer_info_list;
	23
41eb33bd JK	24	enum help_format {
	25	HELP_FORMAT_MAN,
	26	HELP_FORMAT_INFO,
	27	HELP_FORMAT_WEB,
	28	};
	29
	30	static int show_all = 0;
	31	static enum help_format help_format = HELP_FORMAT_MAN;
	32	static struct option builtin_help_options[] = {
	33	OPT_BOOLEAN('a', "all", &show_all, "print all available commands"),
	34	OPT_SET_INT('m', "man", &help_format, "show man page", HELP_FORMAT_MAN),
	35	OPT_SET_INT('w', "web", &help_format, "show manual in web browser",
	36	HELP_FORMAT_WEB),
	37	OPT_SET_INT('i', "info", &help_format, "show info page",
	38	HELP_FORMAT_INFO),
4637e47a	39	OPT_END(),
41eb33bd JK	40	};
	41
	42	static const char * const builtin_help_usage[] = {
1b1dd23f	43	"git help [--all] [--man\|--web\|--info] [command]",
41eb33bd JK	44	NULL
	45	};
	46
	47	static enum help_format parse_help_format(const char *format)
70087cdb	48	{
41eb33bd JK	49	if (!strcmp(format, "man"))
	50	return HELP_FORMAT_MAN;
	51	if (!strcmp(format, "info"))
	52	return HELP_FORMAT_INFO;
	53	if (!strcmp(format, "web") \|\| !strcmp(format, "html"))
	54	return HELP_FORMAT_WEB;
70087cdb CC	55	die("unrecognized help format '%s'", format);
	56	}
	57
7b15f872 CC	58	static const char get_man_viewer_info(const char name)
	59	{
	60	struct man_viewer_info_list *viewer;
	61
	62	for (viewer = man_viewer_info_list; viewer; viewer = viewer->next)
	63	{
	64	if (!strcasecmp(name, viewer->name))
	65	return viewer->info;
	66	}
	67	return NULL;
	68	}
	69
69099d6b CC	70	static int check_emacsclient_version(void)
	71	{
	72	struct strbuf buffer = STRBUF_INIT;
	73	struct child_process ec_process;
	74	const char *argv_ec[] = { "emacsclient", "--version", NULL };
	75	int version;
	76
	77	/* emacsclient prints its version number on stderr */
	78	memset(&ec_process, 0, sizeof(ec_process));
	79	ec_process.argv = argv_ec;
	80	ec_process.err = -1;
	81	ec_process.stdout_to_stderr = 1;
	82	if (start_command(&ec_process)) {
	83	fprintf(stderr, "Failed to start emacsclient.\n");
	84	return -1;
	85	}
	86	strbuf_read(&buffer, ec_process.err, 20);
	87	close(ec_process.err);
	88
	89	/*
	90	* Don't bother checking return value, because "emacsclient --version"
	91	* seems to always exits with code 1.
	92	*/
	93	finish_command(&ec_process);
	94
	95	if (prefixcmp(buffer.buf, "emacsclient")) {
	96	fprintf(stderr, "Failed to parse emacsclient version.\n");
	97	strbuf_release(&buffer);
	98	return -1;
	99	}
	100
	101	strbuf_remove(&buffer, 0, strlen("emacsclient"));
	102	version = atoi(buffer.buf);
	103
	104	if (version < 22) {
	105	fprintf(stderr,
	106	"emacsclient version '%d' too old (< 22).\n",
	107	version);
	108	strbuf_release(&buffer);
	109	return -1;
	110	}
	111
	112	strbuf_release(&buffer);
	113	return 0;
	114	}
	115
7b15f872	116	static void exec_woman_emacs(const char* path, const char *page)
69099d6b CC	117	{
	118	if (!check_emacsclient_version()) {
	119	/* This works only with emacsclient version >= 22. */
	120	struct strbuf man_page = STRBUF_INIT;
7b15f872 CC	121
	122	if (!path)
	123	path = "emacsclient";
69099d6b	124	strbuf_addf(&man_page, "(woman \"%s\")", page);
7b15f872 CC	125	execlp(path, "emacsclient", "-e", man_page.buf, NULL);
7b15f872 CC	126	warning("failed to exec '%s': %s", path, strerror(errno));
69099d6b CC	127	}
	128	}
	129
7b15f872	130	static void exec_man_konqueror(const char* path, const char *page)
69099d6b CC	131	{
	132	const char *display = getenv("DISPLAY");
	133	if (display && *display) {
	134	struct strbuf man_page = STRBUF_INIT;
7b15f872 CC	135	const char *filename = "kfmclient";
	136
	137	/* It's simpler to launch konqueror using kfmclient. */
	138	if (path) {
	139	const char *file = strrchr(path, '/');
	140	if (file && !strcmp(file + 1, "konqueror")) {
	141	char *new = xstrdup(path);
	142	char *dest = strrchr(new, '/');
	143
	144	/* strlen("konqueror") == strlen("kfmclient") */
	145	strcpy(dest + 1, "kfmclient");
	146	path = new;
	147	}
	148	if (file)
	149	filename = file;
	150	} else
	151	path = "kfmclient";
69099d6b	152	strbuf_addf(&man_page, "man:%s(1)", page);
7b15f872 CC	153	execlp(path, filename, "newTab", man_page.buf, NULL);
7b15f872 CC	154	warning("failed to exec '%s': %s", path, strerror(errno));
69099d6b CC	155	}
	156	}
	157
7b15f872	158	static void exec_man_man(const char* path, const char *page)
69099d6b	159	{
7b15f872 CC	160	if (!path)
	161	path = "man";
	162	execlp(path, "man", page, NULL);
	163	warning("failed to exec '%s': %s", path, strerror(errno));
69099d6b CC	164	}
69099d6b CC	165
a26a06af CC	166	static void exec_man_cmd(const char cmd, const char page)
	167	{
	168	struct strbuf shell_cmd = STRBUF_INIT;
	169	strbuf_addf(&shell_cmd, "%s %s", cmd, page);
	170	execl("/bin/sh", "sh", "-c", shell_cmd.buf, NULL);
	171	warning("failed to exec '%s': %s", cmd, strerror(errno));
	172	}
	173
	174	static void add_man_viewer(const char *name)
69099d6b CC	175	{
69099d6b CC	176	struct man_viewer_list **p = &man_viewer_list;
7b15f872	177	size_t len = strlen(name);
69099d6b CC	178
	179	while (*p)
	180	p = &((*p)->next);
7b15f872 CC	181	p = xcalloc(1, (sizeof(*p) + len + 1));
	182	strncpy((*p)->name, name, len);
	183	}
	184
	185	static int supported_man_viewer(const char *name, size_t len)
	186	{
	187	return (!strncasecmp("man", name, len) \|\|
	188	!strncasecmp("woman", name, len) \|\|
	189	!strncasecmp("konqueror", name, len));
69099d6b CC	190	}
69099d6b CC	191
7b15f872 CC	192	static void do_add_man_viewer_info(const char *name,
	193	size_t len,
	194	const char *value)
	195	{
	196	struct man_viewer_info_list new = xcalloc(1, sizeof(new) + len + 1);
	197
	198	strncpy(new->name, name, len);
	199	new->info = xstrdup(value);
	200	new->next = man_viewer_info_list;
	201	man_viewer_info_list = new;
	202	}
	203
	204	static int add_man_viewer_path(const char *name,
	205	size_t len,
	206	const char *value)
	207	{
	208	if (supported_man_viewer(name, len))
	209	do_add_man_viewer_info(name, len, value);
	210	else
a26a06af CC	211	warning("'%s': path for unsupported man viewer.\n"
	212	"Please consider using 'man.<tool>.cmd' instead.",
	213	name);
	214
	215	return 0;
	216	}
	217
	218	static int add_man_viewer_cmd(const char *name,
	219	size_t len,
	220	const char *value)
	221	{
	222	if (supported_man_viewer(name, len))
	223	warning("'%s': cmd for supported man viewer.\n"
	224	"Please consider using 'man.<tool>.path' instead.",
	225	name);
	226	else
	227	do_add_man_viewer_info(name, len, value);
7b15f872 CC	228
	229	return 0;
	230	}
	231
	232	static int add_man_viewer_info(const char var, const char value)
	233	{
	234	const char *name = var + 4;
	235	const char *subkey = strrchr(name, '.');
	236
	237	if (!subkey)
	238	return error("Config with no key for man viewer: %s", name);
	239
	240	if (!strcmp(subkey, ".path")) {
	241	if (!value)
	242	return config_error_nonbool(var);
	243	return add_man_viewer_path(name, subkey - name, value);
	244	}
a26a06af CC	245	if (!strcmp(subkey, ".cmd")) {
	246	if (!value)
	247	return config_error_nonbool(var);
	248	return add_man_viewer_cmd(name, subkey - name, value);
	249	}
7b15f872 CC	250
	251	warning("'%s': unsupported man viewer sub key.", subkey);
	252	return 0;
	253	}
	254
ef90d6d4	255	static int git_help_config(const char var, const char value, void *cb)
70087cdb	256	{
41eb33bd JK	257	if (!strcmp(var, "help.format")) {
	258	if (!value)
	259	return config_error_nonbool(var);
	260	help_format = parse_help_format(value);
	261	return 0;
	262	}
69099d6b CC	263	if (!strcmp(var, "man.viewer")) {
	264	if (!value)
	265	return config_error_nonbool(var);
a26a06af CC	266	add_man_viewer(value);
a26a06af CC	267	return 0;
69099d6b	268	}
7b15f872 CC	269	if (!prefixcmp(var, "man."))
	270	return add_man_viewer_info(var, value);
	271
ef90d6d4	272	return git_default_config(var, value, cb);
70087cdb CC	273	}
70087cdb CC	274
82e5a82f	275	/* most GUI terminals set COLUMNS (although some don't export it) */
70827b15 LT	276	static int term_columns(void)
	277	{
	278	char *col_string = getenv("COLUMNS");
96f1e58f	279	int n_cols;
70827b15 LT	280
	281	if (col_string && (n_cols = atoi(col_string)) > 0)
	282	return n_cols;
	283
	284	#ifdef TIOCGWINSZ
	285	{
	286	struct winsize ws;
	287	if (!ioctl(1, TIOCGWINSZ, &ws)) {
	288	if (ws.ws_col)
	289	return ws.ws_col;
	290	}
	291	}
	292	#endif
	293
	294	return 80;
	295	}
	296
70827b15 LT	297	static inline void mput_char(char c, unsigned int num)
	298	{
	299	while(num--)
	300	putchar(c);
	301	}
	302
1eb05690 SP	303	static struct cmdnames {
	304	int alloc;
	305	int cnt;
	306	struct cmdname {
	307	size_t len;
	308	char name[1];
	309	} **names;
	310	} main_cmds, other_cmds;
	311
	312	static void add_cmdname(struct cmdnames cmds, const char name, int len)
70827b15	313	{
1eb05690 SP	314	struct cmdname ent = xmalloc(sizeof(ent) + len);
1eb05690 SP	315
70827b15 LT	316	ent->len = len;
	317	memcpy(ent->name, name, len);
	318	ent->name[len] = 0;
1eb05690 SP	319
	320	ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
	321	cmds->names[cmds->cnt++] = ent;
70827b15 LT	322	}
	323
	324	static int cmdname_compare(const void a_, const void b_)
	325	{
	326	struct cmdname a = (struct cmdname **)a_;
	327	struct cmdname b = (struct cmdname **)b_;
	328	return strcmp(a->name, b->name);
	329	}
	330
1eb05690 SP	331	static void uniq(struct cmdnames *cmds)
	332	{
	333	int i, j;
	334
	335	if (!cmds->cnt)
	336	return;
	337
	338	for (i = j = 1; i < cmds->cnt; i++)
	339	if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
	340	cmds->names[j++] = cmds->names[i];
	341
	342	cmds->cnt = j;
	343	}
	344
f3fa1838 JH	345	static void exclude_cmds(struct cmdnames cmds, struct cmdnames excludes)
f3fa1838 JH	346	{
1eb05690 SP	347	int ci, cj, ei;
	348	int cmp;
	349
	350	ci = cj = ei = 0;
	351	while (ci < cmds->cnt && ei < excludes->cnt) {
	352	cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
	353	if (cmp < 0)
	354	cmds->names[cj++] = cmds->names[ci++];
	355	else if (cmp == 0)
	356	ci++, ei++;
	357	else if (cmp > 0)
	358	ei++;
	359	}
	360
	361	while (ci < cmds->cnt)
	362	cmds->names[cj++] = cmds->names[ci++];
	363
	364	cmds->cnt = cj;
	365	}
	366
	367	static void pretty_print_string_list(struct cmdnames *cmds, int longest)
70827b15 LT	368	{
	369	int cols = 1, rows;
	370	int space = longest + 1; /* min 1 SP between words */
	371	int max_cols = term_columns() - 1; /* don't print on the edge */
	372	int i, j;
	373
	374	if (space < max_cols)
	375	cols = max_cols / space;
1eb05690	376	rows = (cmds->cnt + cols - 1) / cols;
70827b15 LT	377
	378	for (i = 0; i < rows; i++) {
	379	printf(" ");
	380
	381	for (j = 0; j < cols; j++) {
	382	int n = j * rows + i;
	383	int size = space;
1eb05690	384	if (n >= cmds->cnt)
70827b15	385	break;
1eb05690	386	if (j == cols-1 \|\| n + rows >= cmds->cnt)
70827b15	387	size = 1;
1eb05690	388	printf("%-*s", size, cmds->names[n]->name);
70827b15 LT	389	}
	390	putchar('\n');
	391	}
	392	}
	393
cc3b7a97 JS	394	static int is_executable(const char *name)
	395	{
	396	struct stat st;
	397
	398	if (stat(name, &st) \|\| /* stat, not lstat */
	399	!S_ISREG(st.st_mode))
	400	return 0;
	401
	402	#ifdef __MINGW32__
	403	/* cannot trust the executable bit, peek into the file instead */
	404	char buf[3] = { 0 };
	405	int n;
	406	int fd = open(name, O_RDONLY);
	407	st.st_mode &= ~S_IXUSR;
	408	if (fd >= 0) {
	409	n = read(fd, buf, 2);
	410	if (n == 2)
	411	/* DOS executables start with "MZ" */
	412	if (!strcmp(buf, "#!") \|\| !strcmp(buf, "MZ"))
	413	st.st_mode \|= S_IXUSR;
	414	close(fd);
	415	}
	416	#endif
	417	return st.st_mode & S_IXUSR;
	418	}
	419
1eb05690 SP	420	static unsigned int list_commands_in_dir(struct cmdnames *cmds,
1eb05690 SP	421	const char *path)
70827b15 LT	422	{
70827b15 LT	423	unsigned int longest = 0;
edb6ddc5 SP	424	const char *prefix = "git-";
edb6ddc5 SP	425	int prefix_len = strlen(prefix);
1eb05690	426	DIR *dir = opendir(path);
70827b15 LT	427	struct dirent *de;
70827b15 LT	428
1eb05690 SP	429	if (!dir \|\| chdir(path))
1eb05690 SP	430	return 0;
70827b15	431
70827b15	432	while ((de = readdir(dir)) != NULL) {
70827b15 LT	433	int entlen;
70827b15 LT	434
edb6ddc5	435	if (prefixcmp(de->d_name, prefix))
70827b15	436	continue;
0966003c	437
cc3b7a97	438	if (!is_executable(de->d_name))
70827b15 LT	439	continue;
70827b15 LT	440
edb6ddc5	441	entlen = strlen(de->d_name) - prefix_len;
5bb1cda5	442	if (has_extension(de->d_name, ".exe"))
70827b15 LT	443	entlen -= 4;
	444
	445	if (longest < entlen)
	446	longest = entlen;
	447
1eb05690	448	add_cmdname(cmds, de->d_name + prefix_len, entlen);
70827b15 LT	449	}
	450	closedir(dir);
	451
1eb05690 SP	452	return longest;
	453	}
	454
2156435f	455	static unsigned int load_command_list(void)
1eb05690 SP	456	{
	457	unsigned int longest = 0;
	458	unsigned int len;
	459	const char *env_path = getenv("PATH");
	460	char paths, path, *colon;
	461	const char *exec_path = git_exec_path();
	462
	463	if (exec_path)
	464	longest = list_commands_in_dir(&main_cmds, exec_path);
	465
	466	if (!env_path) {
	467	fprintf(stderr, "PATH not set\n");
	468	exit(1);
	469	}
	470
	471	path = paths = xstrdup(env_path);
	472	while (1) {
cc3b7a97	473	if ((colon = strchr(path, PATH_SEP)))
1eb05690 SP	474	*colon = 0;
	475
	476	len = list_commands_in_dir(&other_cmds, path);
	477	if (len > longest)
	478	longest = len;
	479
	480	if (!colon)
	481	break;
	482	path = colon + 1;
	483	}
	484	free(paths);
	485
	486	qsort(main_cmds.names, main_cmds.cnt,
	487	sizeof(*main_cmds.names), cmdname_compare);
	488	uniq(&main_cmds);
	489
	490	qsort(other_cmds.names, other_cmds.cnt,
	491	sizeof(*other_cmds.names), cmdname_compare);
	492	uniq(&other_cmds);
	493	exclude_cmds(&other_cmds, &main_cmds);
	494
2156435f JK	495	return longest;
	496	}
	497
	498	static void list_commands(void)
	499	{
	500	unsigned int longest = load_command_list();
	501	const char *exec_path = git_exec_path();
	502
1eb05690 SP	503	if (main_cmds.cnt) {
	504	printf("available git commands in '%s'\n", exec_path);
	505	printf("----------------------------");
	506	mput_char('-', strlen(exec_path));
	507	putchar('\n');
	508	pretty_print_string_list(&main_cmds, longest);
	509	putchar('\n');
	510	}
	511
	512	if (other_cmds.cnt) {
	513	printf("git commands available from elsewhere on your $PATH\n");
	514	printf("---------------------------------------------------\n");
	515	pretty_print_string_list(&other_cmds, longest);
	516	putchar('\n');
	517	}
70827b15 LT	518	}
70827b15 LT	519
3d7e2d85	520	void list_common_cmds_help(void)
70827b15 LT	521	{
	522	int i, longest = 0;
	523
	524	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
	525	if (longest < strlen(common_cmds[i].name))
	526	longest = strlen(common_cmds[i].name);
	527	}
	528
	529	puts("The most commonly used git commands are:");
	530	for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
4f75b115 RS	531	printf(" %s ", common_cmds[i].name);
4f75b115 RS	532	mput_char(' ', longest - strlen(common_cmds[i].name));
70827b15 LT	533	puts(common_cmds[i].help);
70827b15 LT	534	}
70827b15 LT	535	}
70827b15 LT	536
2156435f JK	537	static int is_in_cmdlist(struct cmdnames c, const char s)
	538	{
	539	int i;
	540	for (i = 0; i < c->cnt; i++)
	541	if (!strcmp(s, c->names[i]->name))
	542	return 1;
	543	return 0;
	544	}
	545
	546	static int is_git_command(const char *s)
	547	{
	548	load_command_list();
	549	return is_in_cmdlist(&main_cmds, s) \|\|
	550	is_in_cmdlist(&other_cmds, s);
	551	}
	552
2dce956e CC	553	static const char prepend(const char prefix, const char *cmd)
	554	{
	555	size_t pre_len = strlen(prefix);
	556	size_t cmd_len = strlen(cmd);
	557	char *p = xmalloc(pre_len + cmd_len + 1);
	558	memcpy(p, prefix, pre_len);
	559	strcpy(p + pre_len, cmd);
	560	return p;
	561	}
	562
df55c9cb	563	static const char cmd_to_page(const char git_cmd)
70827b15	564	{
5d6491c7 CC	565	if (!git_cmd)
	566	return "git";
	567	else if (!prefixcmp(git_cmd, "git"))
df55c9cb	568	return git_cmd;
2dce956e CC	569	else if (is_git_command(git_cmd))
	570	return prepend("git-", git_cmd);
	571	else
	572	return prepend("git", git_cmd);
df55c9cb	573	}
70827b15	574
8e566f24 SO	575	static void setup_man_path(void)
	576	{
	577	struct strbuf new_path;
	578	const char *old_path = getenv("MANPATH");
	579
	580	strbuf_init(&new_path, 0);
	581
	582	/* We should always put ':' after our path. If there is no
	583	* old_path, the ':' at the end will let 'man' to try
	584	* system-wide paths after ours to find the manual page. If
	585	* there is old_path, we need ':' as delimiter. */
	586	strbuf_addstr(&new_path, GIT_MAN_PATH);
	587	strbuf_addch(&new_path, ':');
	588	if (old_path)
	589	strbuf_addstr(&new_path, old_path);
	590
	591	setenv("MANPATH", new_path.buf, 1);
	592
	593	strbuf_release(&new_path);
	594	}
	595
7b15f872 CC	596	static void exec_viewer(const char name, const char page)
7b15f872 CC	597	{
a26a06af	598	const char *info = get_man_viewer_info(name);
7b15f872 CC	599
7b15f872 CC	600	if (!strcasecmp(name, "man"))
a26a06af	601	exec_man_man(info, page);
7b15f872	602	else if (!strcasecmp(name, "woman"))
a26a06af	603	exec_woman_emacs(info, page);
7b15f872	604	else if (!strcasecmp(name, "konqueror"))
a26a06af CC	605	exec_man_konqueror(info, page);
	606	else if (info)
	607	exec_man_cmd(info, page);
7b15f872	608	else
a26a06af	609	warning("'%s': unknown man viewer.", name);
7b15f872 CC	610	}
7b15f872 CC	611
df55c9cb CC	612	static void show_man_page(const char *git_cmd)
df55c9cb CC	613	{
69099d6b	614	struct man_viewer_list *viewer;
df55c9cb	615	const char *page = cmd_to_page(git_cmd);
69099d6b	616
8e566f24	617	setup_man_path();
69099d6b CC	618	for (viewer = man_viewer_list; viewer; viewer = viewer->next)
69099d6b CC	619	{
7b15f872	620	exec_viewer(viewer->name, page); /* will return when unable */
69099d6b	621	}
7b15f872	622	exec_viewer("man", page);
69099d6b	623	die("no man viewer handled the request");
70827b15 LT	624	}
70827b15 LT	625
df55c9cb CC	626	static void show_info_page(const char *git_cmd)
	627	{
	628	const char *page = cmd_to_page(git_cmd);
a149a1a4	629	setenv("INFOPATH", GIT_INFO_PATH, 1);
78d39f98	630	execlp("info", "info", "gitman", page, NULL);
df55c9cb CC	631	}
df55c9cb CC	632
482cce82 CC	633	static void get_html_page_path(struct strbuf page_path, const char page)
	634	{
	635	struct stat st;
868da8d5	636	const char *html_path = system_path(GIT_HTML_PATH);
482cce82 CC	637
482cce82 CC	638	/* Check that we have a git documentation directory. */
868da8d5 SP	639	if (stat(mkpath("%s/git.html", html_path), &st)
	640	\|\| !S_ISREG(st.st_mode))
	641	die("'%s': not a documentation directory.", html_path);
482cce82 CC	642
482cce82 CC	643	strbuf_init(page_path, 0);
868da8d5	644	strbuf_addf(page_path, "%s/%s.html", html_path, page);
482cce82 CC	645	}
482cce82 CC	646
4804aabc SP	647	/*
	648	* If open_html is not defined in a platform-specific way (see for
	649	* example compat/mingw.h), we use the script web--browse to display
	650	* HTML.
	651	*/
	652	#ifndef open_html
	653	void open_html(const char *path)
	654	{
	655	execl_git_cmd("web--browse", "-c", "help.browser", path, NULL);
	656	}
	657	#endif
	658
5d6491c7 CC	659	static void show_html_page(const char *git_cmd)
	660	{
	661	const char *page = cmd_to_page(git_cmd);
482cce82 CC	662	struct strbuf page_path; /* it leaks but we exec bellow */
	663
	664	get_html_page_path(&page_path, page);
	665
4804aabc	666	open_html(page_path.buf);
5d6491c7 CC	667	}
5d6491c7 CC	668
822a7d50 RJ	669	void help_unknown_cmd(const char *cmd)
822a7d50 RJ	670	{
a238917b	671	fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
822a7d50 RJ	672	exit(1);
	673	}
	674
a633fca0	675	int cmd_version(int argc, const char *argv, const char prefix)
70827b15 LT	676	{
	677	printf("git version %s\n", git_version_string);
	678	return 0;
	679	}
	680
5d6491c7	681	int cmd_help(int argc, const char *argv, const char prefix)
70827b15	682	{
41eb33bd	683	int nongit;
2156435f	684	const char *alias;
5d6491c7	685
41eb33bd	686	setup_git_directory_gently(&nongit);
ef90d6d4	687	git_config(git_help_config, NULL);
822a7d50	688
41eb33bd JK	689	argc = parse_options(argc, argv, builtin_help_options,
	690	builtin_help_usage, 0);
	691
	692	if (show_all) {
822a7d50	693	printf("usage: %s\n\n", git_usage_string);
1eb05690	694	list_commands();
b7d96819	695	printf("%s\n", git_more_info_string);
41eb33bd	696	return 0;
822a7d50	697	}
df55c9cb	698
41eb33bd JK	699	if (!argv[0]) {
	700	printf("usage: %s\n\n", git_usage_string);
	701	list_common_cmds_help();
b7d96819	702	printf("\n%s\n", git_more_info_string);
41eb33bd	703	return 0;
70087cdb CC	704	}
70087cdb CC	705
2156435f JK	706	alias = alias_lookup(argv[0]);
	707	if (alias && !is_git_command(argv[0])) {
	708	printf("`git %s' is aliased to `%s'\n", argv[0], alias);
	709	return 0;
	710	}
	711
41eb33bd JK	712	switch (help_format) {
	713	case HELP_FORMAT_MAN:
	714	show_man_page(argv[0]);
	715	break;
	716	case HELP_FORMAT_INFO:
	717	show_info_page(argv[0]);
	718	break;
	719	case HELP_FORMAT_WEB:
	720	show_html_page(argv[0]);
	721	break;
70087cdb	722	}
822a7d50	723
70827b15 LT	724	return 0;
70827b15 LT	725	}