aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDimitri Sokolyuk <demon@dim13.org>2019-07-09 23:56:24 +0200
committerDimitri Sokolyuk <demon@dim13.org>2019-07-09 23:56:24 +0200
commit5ffdd519e947b5bf87d8f3ae808188c4b6480d08 (patch)
treebaa1c2490f952b7a0b17aeffdbb19e36b808290d
parent94a719dbc471c4fcdde02c69042a2235dff95039 (diff)
add readmeHEADmaster
-rw-r--r--Makefile3
-rw-r--r--README.md63
2 files changed, 66 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 1979014..40cefe9 100644
--- a/Makefile
+++ b/Makefile
@@ -5,4 +5,7 @@ DPADD= ${LIBCURSES}
CFLAGS+= -W -Wall
LDADD= -lcurses
+README.md: watch.1
+ mandoc -Tmarkdown ${.ALLSRC} > ${.TARGET}
+
. include <bsd.prog.mk>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..74888fc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+WATCH(1) - General Commands Manual
+
+# NAME
+
+**watch** - execute program periodically, showing output fullscreen
+
+# SYNOPSIS
+
+**watch**
+\[**-tv**]
+\[**-n**&nbsp;*time*]
+\[*command*]
+
+# DESCRIPTION
+
+The
+**watch**
+utility runs a
+*command*
+repeatedly and displays its output fullscreen.
+This allow you to watch an output of the
+*command*
+as it changes.
+If the
+*command*
+is absent,
+**watch**
+will prompt for it.
+
+The options are as follows:
+
+**-n** *time*
+
+> Set delay between screen updates in seconds.
+> The default value is 2 seconds.
+
+**-t**
+
+> Disable output of the title bar.
+
+**-h**
+
+> Display usage and terminate.
+
+**Watch**
+will terminate with the keyboard interrupt
+('^C')
+
+# EXAMPLE
+
+**watch**
+\-n 1 ps
+
+# HISTORY
+
+The original
+**watch**
+was written by Tony Rems &lt;rembo@unisoft.com&gt; in 1991,
+with mods and corrections by Francois Pinard.
+It was rewritten completly from scratch by Dimitri Sokolyuk
+&lt;demon@dim13.org&gt; in 2003.
+
+OpenBSD 6.5 - December 25, 2004