Generate a manpage

help2man should be enough so far.
This commit is contained in:
Přemysl Eric Janouch 2014-09-20 18:09:44 +02:00
parent 01c2bfa5a4
commit 38a0077033
5 changed files with 11 additions and 7 deletions

1
.gitignore vendored
View File

@ -1,5 +1,6 @@
# Build files # Build files
/ponymap /ponymap
/ponymap.1
/plugins/*.so /plugins/*.so
# Qt Creator files # Qt Creator files

View File

@ -9,7 +9,7 @@ LDFLAGS = `pkg-config --libs libssl jansson` -lpthread -lrt -ldl -lcurses
.PHONY: all clean .PHONY: all clean
.SUFFIXES: .SUFFIXES:
targets = ponymap plugins/http.so plugins/irc.so plugins/ssh.so targets = ponymap ponymap.1 plugins/http.so plugins/irc.so plugins/ssh.so
all: $(targets) all: $(targets)
@ -19,5 +19,8 @@ clean:
ponymap: ponymap.c utils.c plugin-api.h siphash.c ponymap: ponymap.c utils.c plugin-api.h siphash.c
$(CC) ponymap.c siphash.c -o $@ $(CFLAGS) $(LDFLAGS) $(CC) ponymap.c siphash.c -o $@ $(CFLAGS) $(LDFLAGS)
ponymap.1: ponymap
help2man -No $@ ./$<
plugins/%.so: plugins/%.c utils.c plugin-api.h plugins/%.so: plugins/%.c utils.c plugin-api.h
$(CC) $< -o $@ $(CFLAGS) $(LDFLAGS) -shared -fPIC $(CC) $< -o $@ $(CFLAGS) $(LDFLAGS) -shared -fPIC

2
README
View File

@ -12,7 +12,7 @@ to write your own service detection plugins.
Building and Running Building and Running
-------------------- --------------------
Build dependencies: openssl, clang, pkg-config, GNU make, Jansson Build dependencies: openssl, clang, pkg-config, GNU make, help2man, Jansson
If you don't have Clang, you can edit the Makefile to use GCC or TCC, they work If you don't have Clang, you can edit the Makefile to use GCC or TCC, they work
just as good. But there's no CMake support yet, so I force it in the Makefile. just as good. But there's no CMake support yet, so I force it in the Makefile.

View File

@ -1826,7 +1826,7 @@ parse_program_arguments (struct app_context *ctx, int argc, char **argv)
g_debug_mode = true; g_debug_mode = true;
break; break;
case 'h': case 'h':
opt_handler_usage (&oh); opt_handler_usage (&oh, stdout);
exit (EXIT_SUCCESS); exit (EXIT_SUCCESS);
case 'V': case 'V':
printf (PROGRAM_NAME " " PROGRAM_VERSION "\n"); printf (PROGRAM_NAME " " PROGRAM_VERSION "\n");
@ -1864,7 +1864,7 @@ parse_program_arguments (struct app_context *ctx, int argc, char **argv)
exit (EXIT_SUCCESS); exit (EXIT_SUCCESS);
default: default:
print_error ("wrong options"); print_error ("wrong options");
opt_handler_usage (&oh); opt_handler_usage (&oh, stderr);
exit (EXIT_FAILURE); exit (EXIT_FAILURE);
} }
@ -1873,7 +1873,7 @@ parse_program_arguments (struct app_context *ctx, int argc, char **argv)
if (!argc) if (!argc)
{ {
opt_handler_usage (&oh); opt_handler_usage (&oh, stderr);
exit (EXIT_FAILURE); exit (EXIT_FAILURE);
} }

View File

@ -1962,7 +1962,7 @@ opt_handler_init (struct opt_handler *self, int argc, char **argv,
} }
static void static void
opt_handler_usage (struct opt_handler *self) opt_handler_usage (struct opt_handler *self, FILE *stream)
{ {
struct str usage; struct str usage;
str_init (&usage); str_init (&usage);
@ -2000,7 +2000,7 @@ opt_handler_usage (struct opt_handler *self)
str_free (&row); str_free (&row);
} }
fputs (usage.str, stderr); fputs (usage.str, stream);
str_free (&usage); str_free (&usage);
} }