git-p4: chdir now properly sets PWD environment variable in msysGit
[git/git-p4.git] / help.c
blob3cb19628965685ce59a5377b81bef975851996e8
1 /*
2 * builtin-help.c
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"
10 #include "parse-options.h"
11 #include "run-command.h"
13 static struct man_viewer_list {
14 struct man_viewer_list *next;
15 char name[FLEX_ARRAY];
16 } *man_viewer_list;
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;
24 enum help_format {
25 HELP_FORMAT_MAN,
26 HELP_FORMAT_INFO,
27 HELP_FORMAT_WEB,
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),
39 OPT_END(),
42 static const char * const builtin_help_usage[] = {
43 "git help [--all] [--man|--web|--info] [command]",
44 NULL
47 static enum help_format parse_help_format(const char *format)
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;
55 die("unrecognized help format '%s'", format);
58 static const char *get_man_viewer_info(const char *name)
60 struct man_viewer_info_list *viewer;
62 for (viewer = man_viewer_info_list; viewer; viewer = viewer->next)
64 if (!strcasecmp(name, viewer->name))
65 return viewer->info;
67 return NULL;
70 static int check_emacsclient_version(void)
72 struct strbuf buffer = STRBUF_INIT;
73 struct child_process ec_process;
74 const char *argv_ec[] = { "emacsclient", "--version", NULL };
75 int version;
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;
86 strbuf_read(&buffer, ec_process.err, 20);
87 close(ec_process.err);
90 * Don't bother checking return value, because "emacsclient --version"
91 * seems to always exits with code 1.
93 finish_command(&ec_process);
95 if (prefixcmp(buffer.buf, "emacsclient")) {
96 fprintf(stderr, "Failed to parse emacsclient version.\n");
97 strbuf_release(&buffer);
98 return -1;
101 strbuf_remove(&buffer, 0, strlen("emacsclient"));
102 version = atoi(buffer.buf);
104 if (version < 22) {
105 fprintf(stderr,
106 "emacsclient version '%d' too old (< 22).\n",
107 version);
108 strbuf_release(&buffer);
109 return -1;
112 strbuf_release(&buffer);
113 return 0;
116 static void exec_woman_emacs(const char* path, const char *page)
118 if (!check_emacsclient_version()) {
119 /* This works only with emacsclient version >= 22. */
120 struct strbuf man_page = STRBUF_INIT;
122 if (!path)
123 path = "emacsclient";
124 strbuf_addf(&man_page, "(woman \"%s\")", page);
125 execlp(path, "emacsclient", "-e", man_page.buf, NULL);
126 warning("failed to exec '%s': %s", path, strerror(errno));
130 static void exec_man_konqueror(const char* path, const char *page)
132 const char *display = getenv("DISPLAY");
133 if (display && *display) {
134 struct strbuf man_page = STRBUF_INIT;
135 const char *filename = "kfmclient";
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, '/');
144 /* strlen("konqueror") == strlen("kfmclient") */
145 strcpy(dest + 1, "kfmclient");
146 path = new;
148 if (file)
149 filename = file;
150 } else
151 path = "kfmclient";
152 strbuf_addf(&man_page, "man:%s(1)", page);
153 execlp(path, filename, "newTab", man_page.buf, NULL);
154 warning("failed to exec '%s': %s", path, strerror(errno));
158 static void exec_man_man(const char* path, const char *page)
160 if (!path)
161 path = "man";
162 execlp(path, "man", page, NULL);
163 warning("failed to exec '%s': %s", path, strerror(errno));
166 static void exec_man_cmd(const char *cmd, const char *page)
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));
174 static void add_man_viewer(const char *name)
176 struct man_viewer_list **p = &man_viewer_list;
177 size_t len = strlen(name);
179 while (*p)
180 p = &((*p)->next);
181 *p = xcalloc(1, (sizeof(**p) + len + 1));
182 strncpy((*p)->name, name, len);
185 static int supported_man_viewer(const char *name, size_t len)
187 return (!strncasecmp("man", name, len) ||
188 !strncasecmp("woman", name, len) ||
189 !strncasecmp("konqueror", name, len));
192 static void do_add_man_viewer_info(const char *name,
193 size_t len,
194 const char *value)
196 struct man_viewer_info_list *new = xcalloc(1, sizeof(*new) + len + 1);
198 strncpy(new->name, name, len);
199 new->info = xstrdup(value);
200 new->next = man_viewer_info_list;
201 man_viewer_info_list = new;
204 static int add_man_viewer_path(const char *name,
205 size_t len,
206 const char *value)
208 if (supported_man_viewer(name, len))
209 do_add_man_viewer_info(name, len, value);
210 else
211 warning("'%s': path for unsupported man viewer.\n"
212 "Please consider using 'man.<tool>.cmd' instead.",
213 name);
215 return 0;
218 static int add_man_viewer_cmd(const char *name,
219 size_t len,
220 const char *value)
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);
229 return 0;
232 static int add_man_viewer_info(const char *var, const char *value)
234 const char *name = var + 4;
235 const char *subkey = strrchr(name, '.');
237 if (!subkey)
238 return error("Config with no key for man viewer: %s", name);
240 if (!strcmp(subkey, ".path")) {
241 if (!value)
242 return config_error_nonbool(var);
243 return add_man_viewer_path(name, subkey - name, value);
245 if (!strcmp(subkey, ".cmd")) {
246 if (!value)
247 return config_error_nonbool(var);
248 return add_man_viewer_cmd(name, subkey - name, value);
251 warning("'%s': unsupported man viewer sub key.", subkey);
252 return 0;
255 static int git_help_config(const char *var, const char *value, void *cb)
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;
263 if (!strcmp(var, "man.viewer")) {
264 if (!value)
265 return config_error_nonbool(var);
266 add_man_viewer(value);
267 return 0;
269 if (!prefixcmp(var, "man."))
270 return add_man_viewer_info(var, value);
272 return git_default_config(var, value, cb);
275 /* most GUI terminals set COLUMNS (although some don't export it) */
276 static int term_columns(void)
278 char *col_string = getenv("COLUMNS");
279 int n_cols;
281 if (col_string && (n_cols = atoi(col_string)) > 0)
282 return n_cols;
284 #ifdef TIOCGWINSZ
286 struct winsize ws;
287 if (!ioctl(1, TIOCGWINSZ, &ws)) {
288 if (ws.ws_col)
289 return ws.ws_col;
292 #endif
294 return 80;
297 static inline void mput_char(char c, unsigned int num)
299 while(num--)
300 putchar(c);
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;
312 static void add_cmdname(struct cmdnames *cmds, const char *name, int len)
314 struct cmdname *ent = xmalloc(sizeof(*ent) + len);
316 ent->len = len;
317 memcpy(ent->name, name, len);
318 ent->name[len] = 0;
320 ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
321 cmds->names[cmds->cnt++] = ent;
324 static int cmdname_compare(const void *a_, const void *b_)
326 struct cmdname *a = *(struct cmdname **)a_;
327 struct cmdname *b = *(struct cmdname **)b_;
328 return strcmp(a->name, b->name);
331 static void uniq(struct cmdnames *cmds)
333 int i, j;
335 if (!cmds->cnt)
336 return;
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];
342 cmds->cnt = j;
345 static void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
347 int ci, cj, ei;
348 int cmp;
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++;
361 while (ci < cmds->cnt)
362 cmds->names[cj++] = cmds->names[ci++];
364 cmds->cnt = cj;
367 static void pretty_print_string_list(struct cmdnames *cmds, int longest)
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;
374 if (space < max_cols)
375 cols = max_cols / space;
376 rows = (cmds->cnt + cols - 1) / cols;
378 for (i = 0; i < rows; i++) {
379 printf(" ");
381 for (j = 0; j < cols; j++) {
382 int n = j * rows + i;
383 int size = space;
384 if (n >= cmds->cnt)
385 break;
386 if (j == cols-1 || n + rows >= cmds->cnt)
387 size = 1;
388 printf("%-*s", size, cmds->names[n]->name);
390 putchar('\n');
394 static int is_executable(const char *name)
396 struct stat st;
398 if (stat(name, &st) || /* stat, not lstat */
399 !S_ISREG(st.st_mode))
400 return 0;
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);
416 #endif
417 return st.st_mode & S_IXUSR;
420 static unsigned int list_commands_in_dir(struct cmdnames *cmds,
421 const char *path)
423 unsigned int longest = 0;
424 const char *prefix = "git-";
425 int prefix_len = strlen(prefix);
426 DIR *dir = opendir(path);
427 struct dirent *de;
428 struct strbuf buf = STRBUF_INIT;
429 int len;
431 if (!dir)
432 return 0;
434 strbuf_addf(&buf, "%s/", path);
435 len = buf.len;
437 while ((de = readdir(dir)) != NULL) {
438 int entlen;
440 if (prefixcmp(de->d_name, prefix))
441 continue;
443 strbuf_setlen(&buf, len);
444 strbuf_addstr(&buf, de->d_name);
445 if (!is_executable(buf.buf))
446 continue;
448 entlen = strlen(de->d_name) - prefix_len;
449 if (has_extension(de->d_name, ".exe"))
450 entlen -= 4;
452 if (longest < entlen)
453 longest = entlen;
455 add_cmdname(cmds, de->d_name + prefix_len, entlen);
457 closedir(dir);
458 strbuf_release(&buf);
460 return longest;
463 static unsigned int load_command_list(void)
465 unsigned int longest = 0;
466 unsigned int len;
467 const char *env_path = getenv("PATH");
468 char *paths, *path, *colon;
469 const char *exec_path = git_exec_path();
471 if (exec_path)
472 longest = list_commands_in_dir(&main_cmds, exec_path);
474 if (!env_path) {
475 fprintf(stderr, "PATH not set\n");
476 exit(1);
479 path = paths = xstrdup(env_path);
480 while (1) {
481 if ((colon = strchr(path, PATH_SEP)))
482 *colon = 0;
484 len = list_commands_in_dir(&other_cmds, path);
485 if (len > longest)
486 longest = len;
488 if (!colon)
489 break;
490 path = colon + 1;
492 free(paths);
494 qsort(main_cmds.names, main_cmds.cnt,
495 sizeof(*main_cmds.names), cmdname_compare);
496 uniq(&main_cmds);
498 qsort(other_cmds.names, other_cmds.cnt,
499 sizeof(*other_cmds.names), cmdname_compare);
500 uniq(&other_cmds);
501 exclude_cmds(&other_cmds, &main_cmds);
503 return longest;
506 static void list_commands(void)
508 unsigned int longest = load_command_list();
509 const char *exec_path = git_exec_path();
511 if (main_cmds.cnt) {
512 printf("available git commands in '%s'\n", exec_path);
513 printf("----------------------------");
514 mput_char('-', strlen(exec_path));
515 putchar('\n');
516 pretty_print_string_list(&main_cmds, longest);
517 putchar('\n');
520 if (other_cmds.cnt) {
521 printf("git commands available from elsewhere on your $PATH\n");
522 printf("---------------------------------------------------\n");
523 pretty_print_string_list(&other_cmds, longest);
524 putchar('\n');
528 void list_common_cmds_help(void)
530 int i, longest = 0;
532 for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
533 if (longest < strlen(common_cmds[i].name))
534 longest = strlen(common_cmds[i].name);
537 puts("The most commonly used git commands are:");
538 for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
539 printf(" %s ", common_cmds[i].name);
540 mput_char(' ', longest - strlen(common_cmds[i].name));
541 puts(common_cmds[i].help);
545 static int is_in_cmdlist(struct cmdnames *c, const char *s)
547 int i;
548 for (i = 0; i < c->cnt; i++)
549 if (!strcmp(s, c->names[i]->name))
550 return 1;
551 return 0;
554 static int is_git_command(const char *s)
556 load_command_list();
557 return is_in_cmdlist(&main_cmds, s) ||
558 is_in_cmdlist(&other_cmds, s);
561 static const char *prepend(const char *prefix, const char *cmd)
563 size_t pre_len = strlen(prefix);
564 size_t cmd_len = strlen(cmd);
565 char *p = xmalloc(pre_len + cmd_len + 1);
566 memcpy(p, prefix, pre_len);
567 strcpy(p + pre_len, cmd);
568 return p;
571 static const char *cmd_to_page(const char *git_cmd)
573 if (!git_cmd)
574 return "git";
575 else if (!prefixcmp(git_cmd, "git"))
576 return git_cmd;
577 else if (is_git_command(git_cmd))
578 return prepend("git-", git_cmd);
579 else
580 return prepend("git", git_cmd);
583 static void setup_man_path(void)
585 struct strbuf new_path;
586 const char *old_path = getenv("MANPATH");
588 strbuf_init(&new_path, 0);
590 /* We should always put ':' after our path. If there is no
591 * old_path, the ':' at the end will let 'man' to try
592 * system-wide paths after ours to find the manual page. If
593 * there is old_path, we need ':' as delimiter. */
594 strbuf_addstr(&new_path, GIT_MAN_PATH);
595 strbuf_addch(&new_path, ':');
596 if (old_path)
597 strbuf_addstr(&new_path, old_path);
599 setenv("MANPATH", new_path.buf, 1);
601 strbuf_release(&new_path);
604 static void exec_viewer(const char *name, const char *page)
606 const char *info = get_man_viewer_info(name);
608 if (!strcasecmp(name, "man"))
609 exec_man_man(info, page);
610 else if (!strcasecmp(name, "woman"))
611 exec_woman_emacs(info, page);
612 else if (!strcasecmp(name, "konqueror"))
613 exec_man_konqueror(info, page);
614 else if (info)
615 exec_man_cmd(info, page);
616 else
617 warning("'%s': unknown man viewer.", name);
620 static void show_man_page(const char *git_cmd)
622 struct man_viewer_list *viewer;
623 const char *page = cmd_to_page(git_cmd);
625 setup_man_path();
626 for (viewer = man_viewer_list; viewer; viewer = viewer->next)
628 exec_viewer(viewer->name, page); /* will return when unable */
630 exec_viewer("man", page);
631 die("no man viewer handled the request");
634 static void show_info_page(const char *git_cmd)
636 const char *page = cmd_to_page(git_cmd);
637 setenv("INFOPATH", GIT_INFO_PATH, 1);
638 execlp("info", "info", "gitman", page, NULL);
641 static void get_html_page_path(struct strbuf *page_path, const char *page)
643 struct stat st;
644 const char *html_path = system_path(GIT_HTML_PATH);
646 /* Check that we have a git documentation directory. */
647 if (stat(mkpath("%s/git.html", html_path), &st)
648 || !S_ISREG(st.st_mode))
649 die("'%s': not a documentation directory.", html_path);
651 strbuf_init(page_path, 0);
652 strbuf_addf(page_path, "%s/%s.html", html_path, page);
656 * If open_html is not defined in a platform-specific way (see for
657 * example compat/mingw.h), we use the script web--browse to display
658 * HTML.
660 #ifndef open_html
661 void open_html(const char *path)
663 execl_git_cmd("web--browse", "-c", "help.browser", path, NULL);
665 #endif
667 static void show_html_page(const char *git_cmd)
669 const char *page = cmd_to_page(git_cmd);
670 struct strbuf page_path; /* it leaks but we exec bellow */
672 get_html_page_path(&page_path, page);
674 open_html(page_path.buf);
677 void help_unknown_cmd(const char *cmd)
679 fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
680 exit(1);
683 int cmd_version(int argc, const char **argv, const char *prefix)
685 printf("git version %s\n", git_version_string);
686 return 0;
689 int cmd_help(int argc, const char **argv, const char *prefix)
691 int nongit;
692 const char *alias;
694 setup_git_directory_gently(&nongit);
695 git_config(git_help_config, NULL);
697 argc = parse_options(argc, argv, builtin_help_options,
698 builtin_help_usage, 0);
700 if (show_all) {
701 printf("usage: %s\n\n", git_usage_string);
702 list_commands();
703 printf("%s\n", git_more_info_string);
704 return 0;
707 if (!argv[0]) {
708 printf("usage: %s\n\n", git_usage_string);
709 list_common_cmds_help();
710 printf("\n%s\n", git_more_info_string);
711 return 0;
714 alias = alias_lookup(argv[0]);
715 if (alias && !is_git_command(argv[0])) {
716 printf("`git %s' is aliased to `%s'\n", argv[0], alias);
717 return 0;
720 switch (help_format) {
721 case HELP_FORMAT_MAN:
722 show_man_page(argv[0]);
723 break;
724 case HELP_FORMAT_INFO:
725 show_info_page(argv[0]);
726 break;
727 case HELP_FORMAT_WEB:
728 show_html_page(argv[0]);
729 break;
732 return 0;