Skip to content

Add --help option with usage information #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rgcr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add --help option with usage information #394

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions src/skhd.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ extern CGError CGSRegisterNotifyProc(void *handler, uint32_t type, void *context
#define SKHD_CONFIG_FILE ".skhdrc"
#define SKHD_PIDFILE_FMT "/tmp/skhd_%s.pid"

#define SKHD_HELP_OPT_LONG "--help"
#define VERSION_OPT_LONG "--version"
#define VERSION_OPT_SHRT "-v"

Expand Down Expand Up @@ -267,6 +268,40 @@ static void create_pid_file(void)
debug("skhd: successfully created pid-file..\n");
}

static void show_help(void)
{
printf("skhd-v%d.%d.%d\n\n", MAJOR, MINOR, PATCH);
printf("Usage: skhd [options]\n\n");
printf("Options:\n");
printf(" -V, --verbose Output debug information\n");
printf(" -P, --profile Output profiling information\n");
printf(" -v, --version Print version number to stdout\n");
printf(" --help Show this help message\n");
printf(" -c, --config <file> Specify location of config file\n");
printf(" -o, --observe Output keycode and modifiers of event. Ctrl+C to quit\n");
printf(" -r, --reload Signal a running instance to reload its config file\n");
printf(" -h, --no-hotload Disable system for hotloading config file\n");
printf(" -k, --key <hotkey> Synthesize a keypress (same syntax as when defining a hotkey)\n");
printf(" -t, --text <text> Synthesize a line of text\n\n");
printf("Service management:\n");
printf(" --install-service Install launchd service file\n");
printf(" --uninstall-service Remove launchd service file\n");
printf(" --start-service Run skhd as a service through launchd\n");
printf(" --restart-service Restart skhd service\n");
printf(" --stop-service Stop skhd service from running\n\n");
printf("Configuration file locations (in order):\n");
printf(" $XDG_CONFIG_HOME/skhd/skhdrc\n");
printf(" $HOME/.config/skhd/skhdrc\n");
printf(" $HOME/.skhdrc\n\n");
printf("Examples:\n");
printf(" skhd Run with default config file\n");
printf(" skhd -c ~/.myskhdrc Run with custom config file\n");
printf(" skhd -o Observe key events\n");
printf(" skhd -k \"cmd - t\" Synthesize Cmd+T keypress\n");
printf(" skhd -t \"hello world\" Type text\n");
printf(" skhd --start-service Start as launchd service\n");
}

static inline bool string_equals(const char *a, const char *b)
{
return a && b && strcmp(a, b) == 0;
Expand Down Expand Up @@ -300,6 +335,11 @@ static bool parse_arguments(int argc, char **argv)
exit(service_stop());
}

if (string_equals(argv[1], SKHD_HELP_OPT_LONG)) {
show_help();
exit(EXIT_SUCCESS);
}

int option;
const char *short_option = "VPvc:k:t:rho";
struct option long_option[] = {
Expand All @@ -311,6 +351,7 @@ static bool parse_arguments(int argc, char **argv)
{ "text", required_argument, NULL, 't' },
{ "reload", no_argument, NULL, 'r' },
{ "observe", no_argument, NULL, 'o' },
{ "help", no_argument, NULL, 0 },
{ NULL, 0, NULL, 0 }
};

Expand Down