1e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng/* 2e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * builtin-help.c 3e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * 4e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * Builtin help command 5e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng */ 6e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "perf.h" 7e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "util/cache.h" 8e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "builtin.h" 9e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "util/exec_cmd.h" 10e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "common-cmds.h" 11e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "util/parse-options.h" 12e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "util/run-command.h" 13e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#include "util/help.h" 14e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 15e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic struct man_viewer_list { 16e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct man_viewer_list *next; 17e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char name[FLEX_ARRAY]; 18e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} *man_viewer_list; 19e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 20e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic struct man_viewer_info_list { 21e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct man_viewer_info_list *next; 22e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *info; 23e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char name[FLEX_ARRAY]; 24e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} *man_viewer_info_list; 25e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 26e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengenum help_format { 27e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng HELP_FORMAT_NONE, 28e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng HELP_FORMAT_MAN, 29e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng HELP_FORMAT_INFO, 30e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng HELP_FORMAT_WEB, 31e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng}; 32e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 33e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic enum help_format parse_help_format(const char *format) 34e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 35e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!strcmp(format, "man")) 36e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return HELP_FORMAT_MAN; 37e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!strcmp(format, "info")) 38e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return HELP_FORMAT_INFO; 39e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!strcmp(format, "web") || !strcmp(format, "html")) 40e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return HELP_FORMAT_WEB; 41e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 42e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng pr_err("unrecognized help format '%s'", format); 43e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return HELP_FORMAT_NONE; 44e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 45e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 46e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic const char *get_man_viewer_info(const char *name) 47e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 48e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct man_viewer_info_list *viewer; 49e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 50e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng for (viewer = man_viewer_info_list; viewer; viewer = viewer->next) { 51e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!strcasecmp(name, viewer->name)) 52e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return viewer->info; 53e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 54e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return NULL; 55e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 56e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 57e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int check_emacsclient_version(void) 58e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 59e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct strbuf buffer = STRBUF_INIT; 60e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct child_process ec_process; 61e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *argv_ec[] = { "emacsclient", "--version", NULL }; 62e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng int version; 63e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 64e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng /* emacsclient prints its version number on stderr */ 65e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng memset(&ec_process, 0, sizeof(ec_process)); 66e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng ec_process.argv = argv_ec; 67e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng ec_process.err = -1; 68e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng ec_process.stdout_to_stderr = 1; 69e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (start_command(&ec_process)) { 70e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng fprintf(stderr, "Failed to start emacsclient.\n"); 71e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return -1; 72e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 73e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_read(&buffer, ec_process.err, 20); 74e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng close(ec_process.err); 75e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 76e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng /* 77e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * Don't bother checking return value, because "emacsclient --version" 78e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * seems to always exits with code 1. 79e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng */ 80e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng finish_command(&ec_process); 81e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 82e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (prefixcmp(buffer.buf, "emacsclient")) { 83e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng fprintf(stderr, "Failed to parse emacsclient version.\n"); 84e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_release(&buffer); 85e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return -1; 86e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 87e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 88e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_remove(&buffer, 0, strlen("emacsclient")); 89e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng version = atoi(buffer.buf); 90e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 91e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (version < 22) { 92e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng fprintf(stderr, 93e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng "emacsclient version '%d' too old (< 22).\n", 94e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng version); 95e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_release(&buffer); 96e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return -1; 97e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 98e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 99e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_release(&buffer); 100e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 101e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 102e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 103e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic void exec_woman_emacs(const char *path, const char *page) 104e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 105e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!check_emacsclient_version()) { 106e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng /* This works only with emacsclient version >= 22. */ 107e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct strbuf man_page = STRBUF_INIT; 108e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 109e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!path) 110e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng path = "emacsclient"; 111e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_addf(&man_page, "(woman \"%s\")", page); 112e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng execlp(path, "emacsclient", "-e", man_page.buf, NULL); 113e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng warning("failed to exec '%s': %s", path, strerror(errno)); 114e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 115e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 116e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 117e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic void exec_man_konqueror(const char *path, const char *page) 118e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 119e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *display = getenv("DISPLAY"); 120e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (display && *display) { 121e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct strbuf man_page = STRBUF_INIT; 122e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *filename = "kfmclient"; 123e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 124e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng /* It's simpler to launch konqueror using kfmclient. */ 125e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (path) { 126e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *file = strrchr(path, '/'); 127e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (file && !strcmp(file + 1, "konqueror")) { 128e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *new = strdup(path); 129e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *dest = strrchr(new, '/'); 130e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 131e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng /* strlen("konqueror") == strlen("kfmclient") */ 132e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strcpy(dest + 1, "kfmclient"); 133e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng path = new; 134e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 135e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (file) 136e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng filename = file; 137e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } else 138e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng path = "kfmclient"; 139e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_addf(&man_page, "man:%s(1)", page); 140e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng execlp(path, filename, "newTab", man_page.buf, NULL); 141e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng warning("failed to exec '%s': %s", path, strerror(errno)); 142e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 143e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 144e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 145e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic void exec_man_man(const char *path, const char *page) 146e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 147e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!path) 148e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng path = "man"; 149e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng execlp(path, "man", page, NULL); 150e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng warning("failed to exec '%s': %s", path, strerror(errno)); 151e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 152e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 153e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic void exec_man_cmd(const char *cmd, const char *page) 154e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 155e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct strbuf shell_cmd = STRBUF_INIT; 156e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_addf(&shell_cmd, "%s %s", cmd, page); 157e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng execl("/bin/sh", "sh", "-c", shell_cmd.buf, NULL); 158e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng warning("failed to exec '%s': %s", cmd, strerror(errno)); 159e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 160e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 161e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic void add_man_viewer(const char *name) 162e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 163e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct man_viewer_list **p = &man_viewer_list; 164e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng size_t len = strlen(name); 165e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 166e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng while (*p) 167e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng p = &((*p)->next); 168e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng *p = zalloc(sizeof(**p) + len + 1); 169e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strncpy((*p)->name, name, len); 170e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 171e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 172e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int supported_man_viewer(const char *name, size_t len) 173e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 174e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return (!strncasecmp("man", name, len) || 175e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng !strncasecmp("woman", name, len) || 176e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng !strncasecmp("konqueror", name, len)); 177e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 178e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 179e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic void do_add_man_viewer_info(const char *name, 180e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng size_t len, 181e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *value) 182e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 183e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct man_viewer_info_list *new = zalloc(sizeof(*new) + len + 1); 184e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 185e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strncpy(new->name, name, len); 186e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng new->info = strdup(value); 187e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng new->next = man_viewer_info_list; 188e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng man_viewer_info_list = new; 189e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 190e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 191e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int add_man_viewer_path(const char *name, 192e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng size_t len, 193e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *value) 194e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 195e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (supported_man_viewer(name, len)) 196e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng do_add_man_viewer_info(name, len, value); 197e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng else 198e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng warning("'%s': path for unsupported man viewer.\n" 199e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng "Please consider using 'man.<tool>.cmd' instead.", 200e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng name); 201e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 202e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 203e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 204e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 205e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int add_man_viewer_cmd(const char *name, 206e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng size_t len, 207e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *value) 208e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 209e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (supported_man_viewer(name, len)) 210e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng warning("'%s': cmd for supported man viewer.\n" 211e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng "Please consider using 'man.<tool>.path' instead.", 212e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng name); 213e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng else 214e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng do_add_man_viewer_info(name, len, value); 215e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 216e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 217e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 218e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 219e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int add_man_viewer_info(const char *var, const char *value) 220e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 221e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *name = var + 4; 222e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *subkey = strrchr(name, '.'); 223e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 224e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!subkey) 225e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return error("Config with no key for man viewer: %s", name); 226e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 227e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!strcmp(subkey, ".path")) { 228e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!value) 229e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return config_error_nonbool(var); 230e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return add_man_viewer_path(name, subkey - name, value); 231e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 232e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!strcmp(subkey, ".cmd")) { 233e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!value) 234e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return config_error_nonbool(var); 235e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return add_man_viewer_cmd(name, subkey - name, value); 236e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 237e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 238e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng warning("'%s': unsupported man viewer sub key.", subkey); 239e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 240e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 241e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 242e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int perf_help_config(const char *var, const char *value, void *cb) 243e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 244e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng enum help_format *help_formatp = cb; 245e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 246e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!strcmp(var, "help.format")) { 247e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!value) 248e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return config_error_nonbool(var); 249e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng *help_formatp = parse_help_format(value); 250e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (*help_formatp == HELP_FORMAT_NONE) 251e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return -1; 252e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 253e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 254e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!strcmp(var, "man.viewer")) { 255e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!value) 256e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return config_error_nonbool(var); 257e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng add_man_viewer(value); 258e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 259e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 260e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!prefixcmp(var, "man.")) 261e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return add_man_viewer_info(var, value); 262e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 263e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return perf_default_config(var, value, cb); 264e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 265e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 266e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic struct cmdnames main_cmds, other_cmds; 267e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 268e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengvoid list_common_cmds_help(void) 269e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 270e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng unsigned int i, longest = 0; 271e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 272e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng for (i = 0; i < ARRAY_SIZE(common_cmds); i++) { 273e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (longest < strlen(common_cmds[i].name)) 274e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng longest = strlen(common_cmds[i].name); 275e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 276e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 277e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng puts(" The most commonly used perf commands are:"); 278e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng for (i = 0; i < ARRAY_SIZE(common_cmds); i++) { 279e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng printf(" %-*s ", longest, common_cmds[i].name); 280e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng puts(common_cmds[i].help); 281e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 282e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 283e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 284e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int is_perf_command(const char *s) 285e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 286e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return is_in_cmdlist(&main_cmds, s) || 287e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng is_in_cmdlist(&other_cmds, s); 288e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 289e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 290e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic const char *prepend(const char *prefix, const char *cmd) 291e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 292e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng size_t pre_len = strlen(prefix); 293e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng size_t cmd_len = strlen(cmd); 294e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng char *p = malloc(pre_len + cmd_len + 1); 295e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng memcpy(p, prefix, pre_len); 296e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strcpy(p + pre_len, cmd); 297e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return p; 298e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 299e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 300e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic const char *cmd_to_page(const char *perf_cmd) 301e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 302e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!perf_cmd) 303e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return "perf"; 304e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng else if (!prefixcmp(perf_cmd, "perf")) 305e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return perf_cmd; 306e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng else 307e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return prepend("perf-", perf_cmd); 308e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 309e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 310e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic void setup_man_path(void) 311e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 312e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct strbuf new_path = STRBUF_INIT; 313e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *old_path = getenv("MANPATH"); 314e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 315e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng /* We should always put ':' after our path. If there is no 316e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * old_path, the ':' at the end will let 'man' to try 317e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * system-wide paths after ours to find the manual page. If 318e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * there is old_path, we need ':' as delimiter. */ 319e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_addstr(&new_path, system_path(PERF_MAN_PATH)); 320e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_addch(&new_path, ':'); 321e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (old_path) 322e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_addstr(&new_path, old_path); 323e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 324e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng setenv("MANPATH", new_path.buf, 1); 325e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 326e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_release(&new_path); 327e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 328e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 329e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic void exec_viewer(const char *name, const char *page) 330e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 331e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *info = get_man_viewer_info(name); 332e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 333e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!strcasecmp(name, "man")) 334e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng exec_man_man(info, page); 335e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng else if (!strcasecmp(name, "woman")) 336e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng exec_woman_emacs(info, page); 337e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng else if (!strcasecmp(name, "konqueror")) 338e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng exec_man_konqueror(info, page); 339e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng else if (info) 340e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng exec_man_cmd(info, page); 341e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng else 342e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng warning("'%s': unknown man viewer.", name); 343e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 344e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 345e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int show_man_page(const char *perf_cmd) 346e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 347e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct man_viewer_list *viewer; 348e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *page = cmd_to_page(perf_cmd); 349e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *fallback = getenv("PERF_MAN_VIEWER"); 350e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 351e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng setup_man_path(); 352e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng for (viewer = man_viewer_list; viewer; viewer = viewer->next) 353e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng exec_viewer(viewer->name, page); /* will return when unable */ 354e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 355e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (fallback) 356e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng exec_viewer(fallback, page); 357e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng exec_viewer("man", page); 358e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 359e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng pr_err("no man viewer handled the request"); 360e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return -1; 361e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 362e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 363e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int show_info_page(const char *perf_cmd) 364e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 365e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *page = cmd_to_page(perf_cmd); 366e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng setenv("INFOPATH", system_path(PERF_INFO_PATH), 1); 367e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng execlp("info", "info", "perfman", page, NULL); 368e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return -1; 369e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 370e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 371e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int get_html_page_path(struct strbuf *page_path, const char *page) 372e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 373e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct stat st; 374e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *html_path = system_path(PERF_HTML_PATH); 375e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 376e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng /* Check that we have a perf documentation directory. */ 377e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (stat(mkpath("%s/perf.html", html_path), &st) 378e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng || !S_ISREG(st.st_mode)) { 379e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng pr_err("'%s': not a documentation directory.", html_path); 380e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return -1; 381e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 382e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 383e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_init(page_path, 0); 384e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng strbuf_addf(page_path, "%s/%s.html", html_path, page); 385e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 386e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 387e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 388e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 389e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng/* 390e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * If open_html is not defined in a platform-specific way (see for 391e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * example compat/mingw.h), we use the script web--browse to display 392e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng * HTML. 393e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng */ 394e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#ifndef open_html 395e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic void open_html(const char *path) 396e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 397e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng execl_perf_cmd("web--browse", "-c", "help.browser", path, NULL); 398e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 399e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng#endif 400e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 401e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengstatic int show_html_page(const char *perf_cmd) 402e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 403e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *page = cmd_to_page(perf_cmd); 404e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct strbuf page_path; /* it leaks but we exec bellow */ 405e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 406e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (get_html_page_path(&page_path, page) != 0) 407e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return -1; 408e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 409e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng open_html(page_path.buf); 410e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 411e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 412e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 413e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 414e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Chengint cmd_help(int argc, const char **argv, const char *prefix __maybe_unused) 415e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng{ 416e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng bool show_all = false; 417e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng enum help_format help_format = HELP_FORMAT_MAN; 418e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng struct option builtin_help_options[] = { 419e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng OPT_BOOLEAN('a', "all", &show_all, "print all available commands"), 420e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng OPT_SET_UINT('m', "man", &help_format, "show man page", HELP_FORMAT_MAN), 421e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng OPT_SET_UINT('w', "web", &help_format, "show manual in web browser", 422e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng HELP_FORMAT_WEB), 423e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng OPT_SET_UINT('i', "info", &help_format, "show info page", 424e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng HELP_FORMAT_INFO), 425e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng OPT_END(), 426e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng }; 427e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char * const builtin_help_usage[] = { 428e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng "perf help [--all] [--man|--web|--info] [command]", 429e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng NULL 430e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng }; 431e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng const char *alias; 432e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng int rc = 0; 433e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 434e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng load_command_list("perf-", &main_cmds, &other_cmds); 435e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 436e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng perf_config(perf_help_config, &help_format); 437e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 438e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng argc = parse_options(argc, argv, builtin_help_options, 439e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng builtin_help_usage, 0); 440e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 441e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (show_all) { 442e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng printf("\n usage: %s\n\n", perf_usage_string); 443e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng list_commands("perf commands", &main_cmds, &other_cmds); 444e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng printf(" %s\n\n", perf_more_info_string); 445e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 446e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 447e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 448e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (!argv[0]) { 449e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng printf("\n usage: %s\n\n", perf_usage_string); 450e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng list_common_cmds_help(); 451e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng printf("\n %s\n\n", perf_more_info_string); 452e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 453e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 454e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 455e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng alias = alias_lookup(argv[0]); 456e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng if (alias && !is_perf_command(argv[0])) { 457e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng printf("`perf %s' is aliased to `%s'\n", argv[0], alias); 458e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return 0; 459e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 460e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 461e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng switch (help_format) { 462e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng case HELP_FORMAT_MAN: 463e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng rc = show_man_page(argv[0]); 464e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng break; 465e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng case HELP_FORMAT_INFO: 466e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng rc = show_info_page(argv[0]); 467e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng break; 468e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng case HELP_FORMAT_WEB: 469e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng rc = show_html_page(argv[0]); 470e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng break; 471e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng case HELP_FORMAT_NONE: 472e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng /* fall-through */ 473e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng default: 474e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng rc = -1; 475e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng break; 476e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng } 477e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng 478e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng return rc; 479e6e8a0bd7cffcc9ae2e0e75546fb12a19213d4aeBen Cheng} 480