aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-12-09 18:20:51 +0100
committerMattias Andrée <maandree@kth.se>2017-12-09 18:20:51 +0100
commit8d423d0f75bd2453e31c7945c4c97610362848b6 (patch)
treed180112db59e74a6e27867e32cdce94a6b7ad35b /README
parentRemove dist (diff)
downloadtimeprefix-8d423d0f75bd2453e31c7945c4c97610362848b6.tar.gz
timeprefix-8d423d0f75bd2453e31c7945c4c97610362848b6.tar.bz2
timeprefix-8d423d0f75bd2453e31c7945c4c97610362848b6.tar.xz
Add man page
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 14 insertions, 5 deletions
diff --git a/README b/README
index c168cdc..71a77bb 100644
--- a/README
+++ b/README
@@ -1,6 +1,15 @@
-A small program to prefixes the current time a line
-is written to its stdin.
+NAME
+ timeprefix - Prefix the current time to each line
-If you use this to generate log files, you can use
-`sort --merge` to create on log file from multiple
-log files.
+SYNOPSIS
+ timeprefix
+
+DESCRIPTION
+ timeprefix ignores all arguments. It reads stdin line by line
+ and prefix the current time (at the point the line has been
+ fully read) to each line and prints the prefixed line to stdout.
+
+ The timestamp is written in both decimal boot time and
+ human-readable real time (in UTC), with with boot time first so
+ that muliple generated log files can merged into one with
+ sort --merge.