From 37ec0fdd3443a77a5120cf55002fedcb5b1dd069 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 9 Aug 2018 10:32:31 +0200 Subject: tree-wide: add clickable man page link to all --help texts This is a bit like the info link in most of GNU's --help texts, but we don't do info but man pages, and we make them properly clickable on terminal supporting that, because awesome. I think it's generally advisable to link up our (brief) --help texts and our (more comprehensive) man pages a bit, so this should be an easy and straight-forward way to do it. --- src/escape/escape.c | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) (limited to 'src/escape') diff --git a/src/escape/escape.c b/src/escape/escape.c index cd99ca62f4..c5cb7897a9 100644 --- a/src/escape/escape.c +++ b/src/escape/escape.c @@ -8,6 +8,7 @@ #include "log.h" #include "string-util.h" #include "strv.h" +#include "terminal-util.h" #include "unit-name.h" static enum { @@ -20,7 +21,14 @@ static const char *arg_template = NULL; static bool arg_path = false; static bool arg_instance = false; -static void help(void) { +static int help(void) { + _cleanup_free_ char *link = NULL; + int r; + + r = terminal_urlify_man("systemd-escape", "1", &link); + if (r < 0) + return log_oom(); + printf("%s [OPTIONS...] [NAME...]\n\n" "Escape strings for usage in systemd unit names.\n\n" " -h --help Show this help\n" @@ -31,7 +39,12 @@ static void help(void) { " -u --unescape Unescape strings\n" " -m --mangle Mangle strings\n" " -p --path When escaping/unescaping assume the string is a path\n" - , program_invocation_short_name); + "\nSee the %s for details.\n" + , program_invocation_short_name + , link + ); + + return 0; } static int parse_argv(int argc, char *argv[]) { @@ -64,8 +77,7 @@ static int parse_argv(int argc, char *argv[]) { switch (c) { case 'h': - help(); - return 0; + return help(); case ARG_VERSION: return version(); -- cgit v1.2.1