From 5ffdd519e947b5bf87d8f3ae808188c4b6480d08 Mon Sep 17 00:00:00 2001 From: Dimitri Sokolyuk Date: Tue, 9 Jul 2019 23:56:24 +0200 Subject: add readme --- Makefile | 3 +++ README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 README.md 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 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** *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 <rembo@unisoft.com> in 1991, +with mods and corrections by Francois Pinard. +It was rewritten completly from scratch by Dimitri Sokolyuk +<demon@dim13.org> in 2003. + +OpenBSD 6.5 - December 25, 2004 -- cgit v1.2.3