diff --git a/README.md b/README.md index c68df04..d83da49 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Usage ----- ``` -kitsune [--match-filename pattern] [paths] +kitsune [--match-filename pattern] [--start] [paths] ``` There are zero or more paths. If 0 paths are provided, "." (the current @@ -26,10 +26,13 @@ any new file matching pattern will also added. pattern is a standard shell glob pattern (as implemented by Pythons fnmatch module). -The output contains of the file name, a timestamp and the contents of -each line for each line in the watched files. It pads the file names to -the length of the longest file name seen so far, so the three columns -should line up nicely. +By default, kitsune will print only content added after program start. +The `--start` option will dump each file from the beginning. + +The output contains of the file name, a timestamp, a deletion indicator +and the contents of each line for each line in the watched files. It +pads the file names to the length of the longest file name seen so far, +so the three columns should line up nicely. Name ---- diff --git a/kitsune b/kitsune index a383a64..231e2d4 100755 --- a/kitsune +++ b/kitsune @@ -88,9 +88,13 @@ def watch(args): if __name__ == "__main__": ap = argparse.ArgumentParser() - ap.add_argument("--start", action='store_true') - ap.add_argument("--match-filename") - ap.add_argument("files", nargs="*", default=["."]) + ap.add_argument("--start", action='store_true', + help="dump existing files from the start") + ap.add_argument("--match-filename", + help="follow only matching files in directories", + metavar="GLOB-PATTERN") + ap.add_argument("files", nargs="*", default=["."], + metavar="file") args = ap.parse_args() watch(args)