Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 1 | /* |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 2 | * Builtin help command |
| 3 | */ |
| 4 | #include "cache.h" |
Brandon Williams | b2141fc | 2017-06-14 11:07:36 -0700 | [diff] [blame] | 5 | #include "config.h" |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 6 | #include "builtin.h" |
Stefan Beller | d807c4a | 2018-04-10 14:26:18 -0700 | [diff] [blame] | 7 | #include "exec-cmd.h" |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 8 | #include "parse-options.h" |
| 9 | #include "run-command.h" |
Nguyễn Thái Ngọc Duy | dbfae68 | 2012-04-13 17:54:37 +0700 | [diff] [blame] | 10 | #include "column.h" |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 11 | #include "help.h" |
| 12 | |
Vincent van Ravesteijn | 1cc8af0 | 2012-06-06 20:28:16 +0000 | [diff] [blame] | 13 | #ifndef DEFAULT_HELP_FORMAT |
| 14 | #define DEFAULT_HELP_FORMAT "man" |
| 15 | #endif |
| 16 | |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 17 | static struct man_viewer_list { |
| 18 | struct man_viewer_list *next; |
| 19 | char name[FLEX_ARRAY]; |
| 20 | } *man_viewer_list; |
| 21 | |
| 22 | static struct man_viewer_info_list { |
| 23 | struct man_viewer_info_list *next; |
| 24 | const char *info; |
| 25 | char name[FLEX_ARRAY]; |
| 26 | } *man_viewer_info_list; |
| 27 | |
| 28 | enum help_format { |
Christian Couder | 3caa823 | 2010-01-09 06:10:05 +0100 | [diff] [blame] | 29 | HELP_FORMAT_NONE, |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 30 | HELP_FORMAT_MAN, |
| 31 | HELP_FORMAT_INFO, |
Gary V. Vaughan | 4b05548 | 2010-05-14 09:31:35 +0000 | [diff] [blame] | 32 | HELP_FORMAT_WEB |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 33 | }; |
| 34 | |
Chris Webb | 89a852e | 2012-06-28 07:58:02 +0100 | [diff] [blame] | 35 | static const char *html_path; |
| 36 | |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 37 | static int show_all = 0; |
Philip Oakley | 65f9835 | 2013-04-02 23:39:50 +0100 | [diff] [blame] | 38 | static int show_guides = 0; |
Nguyễn Thái Ngọc Duy | dbfae68 | 2012-04-13 17:54:37 +0700 | [diff] [blame] | 39 | static unsigned int colopts; |
Christian Couder | 3caa823 | 2010-01-09 06:10:05 +0100 | [diff] [blame] | 40 | static enum help_format help_format = HELP_FORMAT_NONE; |
Ralf Thielow | af74128 | 2016-08-26 19:58:35 +0200 | [diff] [blame] | 41 | static int exclude_guides; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 42 | static struct option builtin_help_options[] = { |
Philip Oakley | 15f7d49 | 2013-04-02 23:39:49 +0100 | [diff] [blame] | 43 | OPT_BOOL('a', "all", &show_all, N_("print all available commands")), |
Ralf Thielow | af74128 | 2016-08-26 19:58:35 +0200 | [diff] [blame] | 44 | OPT_HIDDEN_BOOL(0, "exclude-guides", &exclude_guides, N_("exclude guides")), |
Philip Oakley | 65f9835 | 2013-04-02 23:39:50 +0100 | [diff] [blame] | 45 | OPT_BOOL('g', "guides", &show_guides, N_("print list of useful guides")), |
Nguyễn Thái Ngọc Duy | 6891869 | 2012-08-20 19:32:17 +0700 | [diff] [blame] | 46 | OPT_SET_INT('m', "man", &help_format, N_("show man page"), HELP_FORMAT_MAN), |
| 47 | OPT_SET_INT('w', "web", &help_format, N_("show manual in web browser"), |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 48 | HELP_FORMAT_WEB), |
Nguyễn Thái Ngọc Duy | 6891869 | 2012-08-20 19:32:17 +0700 | [diff] [blame] | 49 | OPT_SET_INT('i', "info", &help_format, N_("show info page"), |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 50 | HELP_FORMAT_INFO), |
| 51 | OPT_END(), |
| 52 | }; |
| 53 | |
| 54 | static const char * const builtin_help_usage[] = { |
Alex Henrie | 9c9b4f2 | 2015-01-13 00:44:47 -0700 | [diff] [blame] | 55 | N_("git help [--all] [--guides] [--man | --web | --info] [<command>]"), |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 56 | NULL |
| 57 | }; |
| 58 | |
| 59 | static enum help_format parse_help_format(const char *format) |
| 60 | { |
| 61 | if (!strcmp(format, "man")) |
| 62 | return HELP_FORMAT_MAN; |
| 63 | if (!strcmp(format, "info")) |
| 64 | return HELP_FORMAT_INFO; |
| 65 | if (!strcmp(format, "web") || !strcmp(format, "html")) |
| 66 | return HELP_FORMAT_WEB; |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 67 | die(_("unrecognized help format '%s'"), format); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 68 | } |
| 69 | |
| 70 | static const char *get_man_viewer_info(const char *name) |
| 71 | { |
| 72 | struct man_viewer_info_list *viewer; |
| 73 | |
| 74 | for (viewer = man_viewer_info_list; viewer; viewer = viewer->next) |
| 75 | { |
| 76 | if (!strcasecmp(name, viewer->name)) |
| 77 | return viewer->info; |
| 78 | } |
| 79 | return NULL; |
| 80 | } |
| 81 | |
| 82 | static int check_emacsclient_version(void) |
| 83 | { |
| 84 | struct strbuf buffer = STRBUF_INIT; |
René Scharfe | d318027 | 2014-08-19 21:09:35 +0200 | [diff] [blame] | 85 | struct child_process ec_process = CHILD_PROCESS_INIT; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 86 | const char *argv_ec[] = { "emacsclient", "--version", NULL }; |
| 87 | int version; |
| 88 | |
| 89 | /* emacsclient prints its version number on stderr */ |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 90 | ec_process.argv = argv_ec; |
| 91 | ec_process.err = -1; |
| 92 | ec_process.stdout_to_stderr = 1; |
Johannes Sixt | 4e2715f | 2009-06-08 22:34:31 +0200 | [diff] [blame] | 93 | if (start_command(&ec_process)) |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 94 | return error(_("Failed to start emacsclient.")); |
Johannes Sixt | 4e2715f | 2009-06-08 22:34:31 +0200 | [diff] [blame] | 95 | |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 96 | strbuf_read(&buffer, ec_process.err, 20); |
| 97 | close(ec_process.err); |
| 98 | |
| 99 | /* |
| 100 | * Don't bother checking return value, because "emacsclient --version" |
| 101 | * seems to always exits with code 1. |
| 102 | */ |
| 103 | finish_command(&ec_process); |
| 104 | |
Christian Couder | 5955654 | 2013-11-30 21:55:40 +0100 | [diff] [blame] | 105 | if (!starts_with(buffer.buf, "emacsclient")) { |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 106 | strbuf_release(&buffer); |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 107 | return error(_("Failed to parse emacsclient version.")); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 108 | } |
| 109 | |
| 110 | strbuf_remove(&buffer, 0, strlen("emacsclient")); |
| 111 | version = atoi(buffer.buf); |
| 112 | |
| 113 | if (version < 22) { |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 114 | strbuf_release(&buffer); |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 115 | return error(_("emacsclient version '%d' too old (< 22)."), |
Johannes Sixt | 4e2715f | 2009-06-08 22:34:31 +0200 | [diff] [blame] | 116 | version); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 117 | } |
| 118 | |
| 119 | strbuf_release(&buffer); |
| 120 | return 0; |
| 121 | } |
| 122 | |
Felipe Contreras | 4b25d09 | 2009-05-01 12:06:36 +0300 | [diff] [blame] | 123 | static void exec_woman_emacs(const char *path, const char *page) |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 124 | { |
| 125 | if (!check_emacsclient_version()) { |
| 126 | /* This works only with emacsclient version >= 22. */ |
| 127 | struct strbuf man_page = STRBUF_INIT; |
| 128 | |
| 129 | if (!path) |
| 130 | path = "emacsclient"; |
| 131 | strbuf_addf(&man_page, "(woman \"%s\")", page); |
Thomas Rast | 5d31475 | 2010-07-24 17:20:23 +0200 | [diff] [blame] | 132 | execlp(path, "emacsclient", "-e", man_page.buf, (char *)NULL); |
Nguyễn Thái Ngọc Duy | 5747749 | 2016-05-08 16:47:27 +0700 | [diff] [blame] | 133 | warning_errno(_("failed to exec '%s'"), path); |
Rene Scharfe | bad0e2c | 2017-08-30 19:49:46 +0200 | [diff] [blame] | 134 | strbuf_release(&man_page); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 135 | } |
| 136 | } |
| 137 | |
Felipe Contreras | 4b25d09 | 2009-05-01 12:06:36 +0300 | [diff] [blame] | 138 | static void exec_man_konqueror(const char *path, const char *page) |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 139 | { |
| 140 | const char *display = getenv("DISPLAY"); |
| 141 | if (display && *display) { |
| 142 | struct strbuf man_page = STRBUF_INIT; |
| 143 | const char *filename = "kfmclient"; |
| 144 | |
| 145 | /* It's simpler to launch konqueror using kfmclient. */ |
| 146 | if (path) { |
Jeff King | 4c9ac3b | 2015-09-24 17:08:16 -0400 | [diff] [blame] | 147 | size_t len; |
| 148 | if (strip_suffix(path, "/konqueror", &len)) |
| 149 | path = xstrfmt("%.*s/kfmclient", (int)len, path); |
| 150 | filename = basename((char *)path); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 151 | } else |
| 152 | path = "kfmclient"; |
| 153 | strbuf_addf(&man_page, "man:%s(1)", page); |
Thomas Rast | 5d31475 | 2010-07-24 17:20:23 +0200 | [diff] [blame] | 154 | execlp(path, filename, "newTab", man_page.buf, (char *)NULL); |
Nguyễn Thái Ngọc Duy | 5747749 | 2016-05-08 16:47:27 +0700 | [diff] [blame] | 155 | warning_errno(_("failed to exec '%s'"), path); |
Rene Scharfe | a981a9f | 2017-08-30 19:49:44 +0200 | [diff] [blame] | 156 | strbuf_release(&man_page); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 157 | } |
| 158 | } |
| 159 | |
Felipe Contreras | 4b25d09 | 2009-05-01 12:06:36 +0300 | [diff] [blame] | 160 | static void exec_man_man(const char *path, const char *page) |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 161 | { |
| 162 | if (!path) |
| 163 | path = "man"; |
Thomas Rast | 5d31475 | 2010-07-24 17:20:23 +0200 | [diff] [blame] | 164 | execlp(path, "man", page, (char *)NULL); |
Nguyễn Thái Ngọc Duy | 5747749 | 2016-05-08 16:47:27 +0700 | [diff] [blame] | 165 | warning_errno(_("failed to exec '%s'"), path); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | static void exec_man_cmd(const char *cmd, const char *page) |
| 169 | { |
| 170 | struct strbuf shell_cmd = STRBUF_INIT; |
| 171 | strbuf_addf(&shell_cmd, "%s %s", cmd, page); |
Kyle J. McKay | b680a86 | 2015-03-07 21:08:00 -0800 | [diff] [blame] | 172 | execl(SHELL_PATH, SHELL_PATH, "-c", shell_cmd.buf, (char *)NULL); |
Nguyễn Thái Ngọc Duy | 5747749 | 2016-05-08 16:47:27 +0700 | [diff] [blame] | 173 | warning(_("failed to exec '%s'"), cmd); |
Rene Scharfe | 7246218 | 2017-08-30 19:49:45 +0200 | [diff] [blame] | 174 | strbuf_release(&shell_cmd); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | static void add_man_viewer(const char *name) |
| 178 | { |
| 179 | struct man_viewer_list **p = &man_viewer_list; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 180 | |
| 181 | while (*p) |
| 182 | p = &((*p)->next); |
Jeff King | 96ffc06 | 2016-02-22 17:44:32 -0500 | [diff] [blame] | 183 | FLEX_ALLOC_STR(*p, name, name); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 184 | } |
| 185 | |
| 186 | static int supported_man_viewer(const char *name, size_t len) |
| 187 | { |
| 188 | return (!strncasecmp("man", name, len) || |
| 189 | !strncasecmp("woman", name, len) || |
| 190 | !strncasecmp("konqueror", name, len)); |
| 191 | } |
| 192 | |
| 193 | static void do_add_man_viewer_info(const char *name, |
| 194 | size_t len, |
| 195 | const char *value) |
| 196 | { |
Brandon Williams | 8adda46 | 2018-02-14 10:59:32 -0800 | [diff] [blame] | 197 | struct man_viewer_info_list *new_man_viewer; |
| 198 | FLEX_ALLOC_MEM(new_man_viewer, name, name, len); |
| 199 | new_man_viewer->info = xstrdup(value); |
| 200 | new_man_viewer->next = man_viewer_info_list; |
| 201 | man_viewer_info_list = new_man_viewer; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 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 |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 211 | warning(_("'%s': path for unsupported man viewer.\n" |
| 212 | "Please consider using 'man.<tool>.cmd' instead."), |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 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)) |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 223 | warning(_("'%s': cmd for supported man viewer.\n" |
| 224 | "Please consider using 'man.<tool>.path' instead."), |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 225 | name); |
| 226 | else |
| 227 | do_add_man_viewer_info(name, len, value); |
| 228 | |
| 229 | return 0; |
| 230 | } |
| 231 | |
| 232 | static int add_man_viewer_info(const char *var, const char *value) |
| 233 | { |
Jeff King | 4d5c6ce | 2013-01-23 01:27:09 -0500 | [diff] [blame] | 234 | const char *name, *subkey; |
| 235 | int namelen; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 236 | |
Jeff King | 4d5c6ce | 2013-01-23 01:27:09 -0500 | [diff] [blame] | 237 | if (parse_config_key(var, "man", &name, &namelen, &subkey) < 0 || !name) |
Johannes Sixt | 178b513 | 2009-04-23 15:49:06 +0200 | [diff] [blame] | 238 | return 0; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 239 | |
Jeff King | 4d5c6ce | 2013-01-23 01:27:09 -0500 | [diff] [blame] | 240 | if (!strcmp(subkey, "path")) { |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 241 | if (!value) |
| 242 | return config_error_nonbool(var); |
Jeff King | 4d5c6ce | 2013-01-23 01:27:09 -0500 | [diff] [blame] | 243 | return add_man_viewer_path(name, namelen, value); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 244 | } |
Jeff King | 4d5c6ce | 2013-01-23 01:27:09 -0500 | [diff] [blame] | 245 | if (!strcmp(subkey, "cmd")) { |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 246 | if (!value) |
| 247 | return config_error_nonbool(var); |
Jeff King | 4d5c6ce | 2013-01-23 01:27:09 -0500 | [diff] [blame] | 248 | return add_man_viewer_cmd(name, namelen, value); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 249 | } |
| 250 | |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 251 | return 0; |
| 252 | } |
| 253 | |
| 254 | static int git_help_config(const char *var, const char *value, void *cb) |
| 255 | { |
Christian Couder | 5955654 | 2013-11-30 21:55:40 +0100 | [diff] [blame] | 256 | if (starts_with(var, "column.")) |
Nguyễn Thái Ngọc Duy | dbfae68 | 2012-04-13 17:54:37 +0700 | [diff] [blame] | 257 | return git_column_config(var, value, "help", &colopts); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 258 | if (!strcmp(var, "help.format")) { |
| 259 | if (!value) |
| 260 | return config_error_nonbool(var); |
| 261 | help_format = parse_help_format(value); |
| 262 | return 0; |
| 263 | } |
Chris Webb | 89a852e | 2012-06-28 07:58:02 +0100 | [diff] [blame] | 264 | if (!strcmp(var, "help.htmlpath")) { |
| 265 | if (!value) |
| 266 | return config_error_nonbool(var); |
| 267 | html_path = xstrdup(value); |
| 268 | return 0; |
| 269 | } |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 270 | if (!strcmp(var, "man.viewer")) { |
| 271 | if (!value) |
| 272 | return config_error_nonbool(var); |
| 273 | add_man_viewer(value); |
| 274 | return 0; |
| 275 | } |
Christian Couder | 5955654 | 2013-11-30 21:55:40 +0100 | [diff] [blame] | 276 | if (starts_with(var, "man.")) |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 277 | return add_man_viewer_info(var, value); |
| 278 | |
| 279 | return git_default_config(var, value, cb); |
| 280 | } |
| 281 | |
Alex Riesen | c7371e9 | 2008-08-28 19:17:46 +0200 | [diff] [blame] | 282 | static struct cmdnames main_cmds, other_cmds; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 283 | |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 284 | static int is_git_command(const char *s) |
| 285 | { |
Sebastian Schuberth | c6127fa | 2014-01-02 17:17:11 +0100 | [diff] [blame] | 286 | if (is_builtin(s)) |
| 287 | return 1; |
| 288 | |
Sebastian Schuberth | a3c5263 | 2014-01-02 17:16:30 +0100 | [diff] [blame] | 289 | load_command_list("git-", &main_cmds, &other_cmds); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 290 | return is_in_cmdlist(&main_cmds, s) || |
| 291 | is_in_cmdlist(&other_cmds, s); |
| 292 | } |
| 293 | |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 294 | static const char *cmd_to_page(const char *git_cmd) |
| 295 | { |
| 296 | if (!git_cmd) |
| 297 | return "git"; |
Christian Couder | 5955654 | 2013-11-30 21:55:40 +0100 | [diff] [blame] | 298 | else if (starts_with(git_cmd, "git")) |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 299 | return git_cmd; |
| 300 | else if (is_git_command(git_cmd)) |
Jeff King | acd47ee | 2015-09-24 17:07:14 -0400 | [diff] [blame] | 301 | return xstrfmt("git-%s", git_cmd); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 302 | else |
Jeff King | acd47ee | 2015-09-24 17:07:14 -0400 | [diff] [blame] | 303 | return xstrfmt("git%s", git_cmd); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 304 | } |
| 305 | |
| 306 | static void setup_man_path(void) |
| 307 | { |
Brandon Casey | f285a2d | 2008-10-09 14:12:12 -0500 | [diff] [blame] | 308 | struct strbuf new_path = STRBUF_INIT; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 309 | const char *old_path = getenv("MANPATH"); |
Junio C Hamano | 59362e5 | 2014-11-24 11:33:54 -0800 | [diff] [blame] | 310 | char *git_man_path = system_path(GIT_MAN_PATH); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 311 | |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 312 | /* We should always put ':' after our path. If there is no |
| 313 | * old_path, the ':' at the end will let 'man' to try |
| 314 | * system-wide paths after ours to find the manual page. If |
| 315 | * there is old_path, we need ':' as delimiter. */ |
Junio C Hamano | 59362e5 | 2014-11-24 11:33:54 -0800 | [diff] [blame] | 316 | strbuf_addstr(&new_path, git_man_path); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 317 | strbuf_addch(&new_path, ':'); |
| 318 | if (old_path) |
| 319 | strbuf_addstr(&new_path, old_path); |
| 320 | |
Junio C Hamano | 59362e5 | 2014-11-24 11:33:54 -0800 | [diff] [blame] | 321 | free(git_man_path); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 322 | setenv("MANPATH", new_path.buf, 1); |
| 323 | |
| 324 | strbuf_release(&new_path); |
| 325 | } |
| 326 | |
| 327 | static void exec_viewer(const char *name, const char *page) |
| 328 | { |
| 329 | const char *info = get_man_viewer_info(name); |
| 330 | |
| 331 | if (!strcasecmp(name, "man")) |
| 332 | exec_man_man(info, page); |
| 333 | else if (!strcasecmp(name, "woman")) |
| 334 | exec_woman_emacs(info, page); |
| 335 | else if (!strcasecmp(name, "konqueror")) |
| 336 | exec_man_konqueror(info, page); |
| 337 | else if (info) |
| 338 | exec_man_cmd(info, page); |
| 339 | else |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 340 | warning(_("'%s': unknown man viewer."), name); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 341 | } |
| 342 | |
| 343 | static void show_man_page(const char *git_cmd) |
| 344 | { |
| 345 | struct man_viewer_list *viewer; |
| 346 | const char *page = cmd_to_page(git_cmd); |
Romain Francoise | 5059a42 | 2008-08-29 17:00:43 +0200 | [diff] [blame] | 347 | const char *fallback = getenv("GIT_MAN_VIEWER"); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 348 | |
| 349 | setup_man_path(); |
| 350 | for (viewer = man_viewer_list; viewer; viewer = viewer->next) |
| 351 | { |
| 352 | exec_viewer(viewer->name, page); /* will return when unable */ |
| 353 | } |
Romain Francoise | 5059a42 | 2008-08-29 17:00:43 +0200 | [diff] [blame] | 354 | if (fallback) |
| 355 | exec_viewer(fallback, page); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 356 | exec_viewer("man", page); |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 357 | die(_("no man viewer handled the request")); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 358 | } |
| 359 | |
| 360 | static void show_info_page(const char *git_cmd) |
| 361 | { |
| 362 | const char *page = cmd_to_page(git_cmd); |
Steffen Prohaska | 026fa0d | 2009-01-18 13:00:09 +0100 | [diff] [blame] | 363 | setenv("INFOPATH", system_path(GIT_INFO_PATH), 1); |
Thomas Rast | 5d31475 | 2010-07-24 17:20:23 +0200 | [diff] [blame] | 364 | execlp("info", "info", "gitman", page, (char *)NULL); |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 365 | die(_("no info viewer handled the request")); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 366 | } |
| 367 | |
| 368 | static void get_html_page_path(struct strbuf *page_path, const char *page) |
| 369 | { |
| 370 | struct stat st; |
Junio C Hamano | 59362e5 | 2014-11-24 11:33:54 -0800 | [diff] [blame] | 371 | char *to_free = NULL; |
| 372 | |
Chris Webb | 89a852e | 2012-06-28 07:58:02 +0100 | [diff] [blame] | 373 | if (!html_path) |
Junio C Hamano | 59362e5 | 2014-11-24 11:33:54 -0800 | [diff] [blame] | 374 | html_path = to_free = system_path(GIT_HTML_PATH); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 375 | |
| 376 | /* Check that we have a git documentation directory. */ |
Chris Webb | 86272b4 | 2012-06-28 07:58:03 +0100 | [diff] [blame] | 377 | if (!strstr(html_path, "://")) { |
| 378 | if (stat(mkpath("%s/git.html", html_path), &st) |
| 379 | || !S_ISREG(st.st_mode)) |
| 380 | die("'%s': not a documentation directory.", html_path); |
| 381 | } |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 382 | |
| 383 | strbuf_init(page_path, 0); |
| 384 | strbuf_addf(page_path, "%s/%s.html", html_path, page); |
Junio C Hamano | 59362e5 | 2014-11-24 11:33:54 -0800 | [diff] [blame] | 385 | free(to_free); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 386 | } |
| 387 | |
Linus Torvalds | 2af202b | 2009-06-18 10:28:43 -0700 | [diff] [blame] | 388 | static void open_html(const char *path) |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 389 | { |
Thomas Rast | 5d31475 | 2010-07-24 17:20:23 +0200 | [diff] [blame] | 390 | execl_git_cmd("web--browse", "-c", "help.browser", path, (char *)NULL); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 391 | } |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 392 | |
| 393 | static void show_html_page(const char *git_cmd) |
| 394 | { |
| 395 | const char *page = cmd_to_page(git_cmd); |
| 396 | struct strbuf page_path; /* it leaks but we exec bellow */ |
| 397 | |
| 398 | get_html_page_path(&page_path, page); |
| 399 | |
| 400 | open_html(page_path.buf); |
| 401 | } |
| 402 | |
Philip Oakley | 002b726 | 2013-04-02 23:39:51 +0100 | [diff] [blame] | 403 | static struct { |
| 404 | const char *name; |
| 405 | const char *help; |
| 406 | } common_guides[] = { |
Simon Ruderich | 3561e60 | 2013-04-12 15:51:42 +0200 | [diff] [blame] | 407 | { "attributes", N_("Defining attributes per path") }, |
Philip Oakley | 673151a | 2014-10-10 22:25:37 +0100 | [diff] [blame] | 408 | { "everyday", N_("Everyday Git With 20 Commands Or So") }, |
Simon Ruderich | 3561e60 | 2013-04-12 15:51:42 +0200 | [diff] [blame] | 409 | { "glossary", N_("A Git glossary") }, |
| 410 | { "ignore", N_("Specifies intentionally untracked files to ignore") }, |
| 411 | { "modules", N_("Defining submodule properties") }, |
| 412 | { "revisions", N_("Specifying revisions and ranges for Git") }, |
| 413 | { "tutorial", N_("A tutorial introduction to Git (for version 1.5.1 or newer)") }, |
| 414 | { "workflows", N_("An overview of recommended workflows with Git") }, |
Philip Oakley | 002b726 | 2013-04-02 23:39:51 +0100 | [diff] [blame] | 415 | }; |
| 416 | |
| 417 | static void list_common_guides_help(void) |
| 418 | { |
| 419 | int i, longest = 0; |
| 420 | |
| 421 | for (i = 0; i < ARRAY_SIZE(common_guides); i++) { |
| 422 | if (longest < strlen(common_guides[i].name)) |
| 423 | longest = strlen(common_guides[i].name); |
| 424 | } |
| 425 | |
| 426 | puts(_("The common Git guides are:\n")); |
| 427 | for (i = 0; i < ARRAY_SIZE(common_guides); i++) { |
| 428 | printf(" %s ", common_guides[i].name); |
| 429 | mput_char(' ', longest - strlen(common_guides[i].name)); |
| 430 | puts(_(common_guides[i].help)); |
| 431 | } |
| 432 | putchar('\n'); |
| 433 | } |
| 434 | |
Ralf Thielow | af74128 | 2016-08-26 19:58:35 +0200 | [diff] [blame] | 435 | static const char *check_git_cmd(const char* cmd) |
| 436 | { |
| 437 | char *alias; |
| 438 | |
| 439 | if (is_git_command(cmd)) |
| 440 | return cmd; |
| 441 | |
| 442 | alias = alias_lookup(cmd); |
| 443 | if (alias) { |
Kaartic Sivaraam | b3a8076 | 2017-09-12 16:44:06 +0530 | [diff] [blame] | 444 | printf_ln(_("'%s' is aliased to '%s'"), cmd, alias); |
Ralf Thielow | af74128 | 2016-08-26 19:58:35 +0200 | [diff] [blame] | 445 | free(alias); |
| 446 | exit(0); |
| 447 | } |
| 448 | |
| 449 | if (exclude_guides) |
| 450 | return help_unknown_cmd(cmd); |
| 451 | |
| 452 | return cmd; |
| 453 | } |
| 454 | |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 455 | int cmd_help(int argc, const char **argv, const char *prefix) |
| 456 | { |
| 457 | int nongit; |
Christian Couder | 3caa823 | 2010-01-09 06:10:05 +0100 | [diff] [blame] | 458 | enum help_format parsed_help_format; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 459 | |
Stephen Boyd | 3778292 | 2009-05-23 11:53:12 -0700 | [diff] [blame] | 460 | argc = parse_options(argc, argv, prefix, builtin_help_options, |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 461 | builtin_help_usage, 0); |
Christian Couder | 3caa823 | 2010-01-09 06:10:05 +0100 | [diff] [blame] | 462 | parsed_help_format = help_format; |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 463 | |
| 464 | if (show_all) { |
Nguyễn Thái Ngọc Duy | dbfae68 | 2012-04-13 17:54:37 +0700 | [diff] [blame] | 465 | git_config(git_help_config, NULL); |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 466 | printf(_("usage: %s%s"), _(git_usage_string), "\n\n"); |
Sebastian Schuberth | a3c5263 | 2014-01-02 17:16:30 +0100 | [diff] [blame] | 467 | load_command_list("git-", &main_cmds, &other_cmds); |
Junio C Hamano | f4ed0af | 2012-05-03 15:13:31 -0700 | [diff] [blame] | 468 | list_commands(colopts, &main_cmds, &other_cmds); |
Philip Oakley | 15f7d49 | 2013-04-02 23:39:49 +0100 | [diff] [blame] | 469 | } |
| 470 | |
Philip Oakley | 002b726 | 2013-04-02 23:39:51 +0100 | [diff] [blame] | 471 | if (show_guides) |
| 472 | list_common_guides_help(); |
Philip Oakley | 65f9835 | 2013-04-02 23:39:50 +0100 | [diff] [blame] | 473 | |
| 474 | if (show_all || show_guides) { |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 475 | printf("%s\n", _(git_more_info_string)); |
Philip Oakley | 15f7d49 | 2013-04-02 23:39:49 +0100 | [diff] [blame] | 476 | /* |
| 477 | * We're done. Ignore any remaining args |
| 478 | */ |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 479 | return 0; |
| 480 | } |
| 481 | |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 482 | if (!argv[0]) { |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 483 | printf(_("usage: %s%s"), _(git_usage_string), "\n\n"); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 484 | list_common_cmds_help(); |
Nguyễn Thái Ngọc Duy | 9665627 | 2012-04-23 19:30:24 +0700 | [diff] [blame] | 485 | printf("\n%s\n", _(git_more_info_string)); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 486 | return 0; |
| 487 | } |
| 488 | |
David Aguilar | af6fbf9 | 2009-12-01 11:27:34 -0800 | [diff] [blame] | 489 | setup_git_directory_gently(&nongit); |
| 490 | git_config(git_help_config, NULL); |
| 491 | |
Pat Thoyts | d0408c0 | 2012-06-22 13:48:46 +0100 | [diff] [blame] | 492 | if (parsed_help_format != HELP_FORMAT_NONE) |
Christian Couder | 3caa823 | 2010-01-09 06:10:05 +0100 | [diff] [blame] | 493 | help_format = parsed_help_format; |
Pat Thoyts | d0408c0 | 2012-06-22 13:48:46 +0100 | [diff] [blame] | 494 | if (help_format == HELP_FORMAT_NONE) |
| 495 | help_format = parse_help_format(DEFAULT_HELP_FORMAT); |
Christian Couder | 3caa823 | 2010-01-09 06:10:05 +0100 | [diff] [blame] | 496 | |
Ralf Thielow | af74128 | 2016-08-26 19:58:35 +0200 | [diff] [blame] | 497 | argv[0] = check_git_cmd(argv[0]); |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 498 | |
| 499 | switch (help_format) { |
Christian Couder | 3caa823 | 2010-01-09 06:10:05 +0100 | [diff] [blame] | 500 | case HELP_FORMAT_NONE: |
Miklos Vajna | 3d78d1f | 2008-08-02 10:08:38 +0200 | [diff] [blame] | 501 | case HELP_FORMAT_MAN: |
| 502 | show_man_page(argv[0]); |
| 503 | break; |
| 504 | case HELP_FORMAT_INFO: |
| 505 | show_info_page(argv[0]); |
| 506 | break; |
| 507 | case HELP_FORMAT_WEB: |
| 508 | show_html_page(argv[0]); |
| 509 | break; |
| 510 | } |
| 511 | |
| 512 | return 0; |
| 513 | } |