4 * Builtin help-related commands (help, usage, version)
9 #include "common-cmds.h"
10 #include <sys/ioctl.h>
12 /* most GUI terminals set COLUMNS (although some don't export it) */
13 static int term_columns(void)
15 char *col_string = getenv("COLUMNS");
18 if (col_string && (n_cols = atoi(col_string)) > 0)
24 if (!ioctl(1, TIOCGWINSZ, &ws)) {
34 static inline void mput_char(char c, unsigned int num)
40 static struct cmdname {
44 static int cmdname_alloc, cmdname_cnt;
46 static void add_cmdname(const char *name, int len)
49 if (cmdname_alloc <= cmdname_cnt) {
50 cmdname_alloc = cmdname_alloc + 200;
51 cmdname = xrealloc(cmdname, cmdname_alloc * sizeof(*cmdname));
53 ent = xmalloc(sizeof(*ent) + len);
55 memcpy(ent->name, name, len);
57 cmdname[cmdname_cnt++] = ent;
60 static int cmdname_compare(const void *a_, const void *b_)
62 struct cmdname *a = *(struct cmdname **)a_;
63 struct cmdname *b = *(struct cmdname **)b_;
64 return strcmp(a->name, b->name);
67 static void pretty_print_string_list(struct cmdname **cmdname, int longest)
70 int space = longest + 1; /* min 1 SP between words */
71 int max_cols = term_columns() - 1; /* don't print *on* the edge */
75 cols = max_cols / space;
76 rows = (cmdname_cnt + cols - 1) / cols;
78 qsort(cmdname, cmdname_cnt, sizeof(*cmdname), cmdname_compare);
80 for (i = 0; i < rows; i++) {
83 for (j = 0; j < cols; j++) {
88 if (j == cols-1 || n + rows >= cmdname_cnt)
90 printf("%-*s", size, cmdname[n]->name);
96 static void list_commands(const char *exec_path, const char *pattern)
98 unsigned int longest = 0;
101 DIR *dir = opendir(exec_path);
105 fprintf(stderr, "git: '%s': %s\n", exec_path, strerror(errno));
109 dirlen = strlen(exec_path);
110 if (PATH_MAX - 20 < dirlen) {
111 fprintf(stderr, "git: insanely long exec-path '%s'\n",
116 memcpy(path, exec_path, dirlen);
117 path[dirlen++] = '/';
119 while ((de = readdir(dir)) != NULL) {
123 if (prefixcmp(de->d_name, "git-"))
125 strcpy(path+dirlen, de->d_name);
126 if (stat(path, &st) || /* stat, not lstat */
127 !S_ISREG(st.st_mode) ||
128 !(st.st_mode & S_IXUSR))
131 entlen = strlen(de->d_name);
132 if (has_extension(de->d_name, ".exe"))
135 if (longest < entlen)
138 add_cmdname(de->d_name + 4, entlen-4);
142 printf("git commands available in '%s'\n", exec_path);
143 printf("----------------------------");
144 mput_char('-', strlen(exec_path));
146 pretty_print_string_list(cmdname, longest - 4);
150 static void list_common_cmds_help(void)
154 for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
155 if (longest < strlen(common_cmds[i].name))
156 longest = strlen(common_cmds[i].name);
159 puts("The most commonly used git commands are:");
160 for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
161 printf(" %s ", common_cmds[i].name);
162 mput_char(' ', longest - strlen(common_cmds[i].name));
163 puts(common_cmds[i].help);
165 puts("(use 'git help -a' to get a list of all installed git commands)");
168 static void show_man_page(const char *git_cmd)
172 if (!prefixcmp(git_cmd, "git"))
175 int page_len = strlen(git_cmd) + 4;
176 char *p = xmalloc(page_len + 1);
178 strcpy(p + 4, git_cmd);
183 execlp("man", "man", page, NULL);
186 void help_unknown_cmd(const char *cmd)
188 printf("git: '%s' is not a git-command\n\n", cmd);
189 list_common_cmds_help();
193 int cmd_version(int argc, const char **argv, const char *prefix)
195 printf("git version %s\n", git_version_string);
199 int cmd_help(int argc, const char **argv, const char *prefix)
201 const char *help_cmd = argc > 1 ? argv[1] : NULL;
202 const char *exec_path = git_exec_path();
205 printf("usage: %s\n\n", git_usage_string);
206 list_common_cmds_help();
210 else if (!strcmp(help_cmd, "--all") || !strcmp(help_cmd, "-a")) {
211 printf("usage: %s\n\n", git_usage_string);
213 list_commands(exec_path, "git-*");
218 show_man_page(help_cmd);