Add cjdnslog man page.
This commit is contained in:
parent
8431b66717
commit
660fe4a4cb
@ -1,3 +1,50 @@
|
||||
diff -up ./contrib/doc/cjdnslog.md.man ./contrib/doc/cjdnslog.md
|
||||
--- ./contrib/doc/cjdnslog.md.man 2016-05-03 22:57:12.839792004 -0400
|
||||
+++ ./contrib/doc/cjdnslog.md 2016-05-03 23:32:31.331738554 -0400
|
||||
@@ -0,0 +1,43 @@
|
||||
+cjdnslog(1) -- display cjdroute log messages
|
||||
+=============================================
|
||||
+
|
||||
+## SYNOPSIS
|
||||
+
|
||||
+`/usr/bin/cjdnslog` [<options>...]
|
||||
+
|
||||
+## DESCRIPTION
|
||||
+
|
||||
+Cjdroute sends continuous log messages to the bit bucket. Cjdnslog
|
||||
+captures that information in real time and sends it to stdout.
|
||||
+
|
||||
+##OPTIONS
|
||||
+
|
||||
+With no options, cjdnslog logs everything.
|
||||
+
|
||||
+ * `--help`:
|
||||
+ Print usage summary.
|
||||
+
|
||||
+ * `-f` source_file.c
|
||||
+ Restrict output to log messages generated in source_file.c.
|
||||
+
|
||||
+ * `-v` log_level:
|
||||
+ Restrict output to messages at log_level or higher. Log levels
|
||||
+ include DEBUG, INFO, WARN, ERROR.
|
||||
+
|
||||
+ * `-l` lineno:
|
||||
+ Restrict output to message generated on source line lineno. Normally
|
||||
+ used in conjunction with `-f`.
|
||||
+
|
||||
+##USAGE
|
||||
+
|
||||
+Running cjdnslog requires admin privilege. The cjdnsadmin lib will
|
||||
+try to read `/etc/cjdroute.conf` for the admin password. This will
|
||||
+normally succeed only for root. Otherwise, it tries `~/.cjdnsadmin`
|
||||
+
|
||||
+##FILES
|
||||
+
|
||||
+`~/.cjdnsadmin`
|
||||
+
|
||||
+## SEE ALSO
|
||||
+
|
||||
+cjdroute(1)
|
||||
diff -up ./contrib/doc/cjdns-online.md.man ./contrib/doc/cjdns-online.md
|
||||
--- ./contrib/doc/cjdns-online.md.man 2016-05-03 22:06:45.843528959 -0400
|
||||
+++ ./contrib/doc/cjdns-online.md 2016-05-03 22:06:45.843528959 -0400
|
||||
|
Loading…
Reference in New Issue
Block a user