diff --git a/docs/begin.1 b/docs/begin.1 new file mode 100644 index 0000000..e4e406a --- /dev/null +++ b/docs/begin.1 @@ -0,0 +1,21 @@ +.\" Manpage begin. +.\" Contact mik@elnord.in to correct errors or typos. +.TH man 1 "27 January 2013" "1.0" "begin man page" +.SH NAME +begin \- an output modifier +.SH SYNOPSIS +begin PATTERN [FILE] +.SH DESCRIPTION +begin is an outputmodifer. It works by searching a file (or std out) for a user supplied pattern and then outputs all lines starting from the first line that matches the pattern. A pattern is a simple textstring or a regular expression as defined by Boost xpressive header only library. Check out http://www.boost.org/doc/libs/1_41_0/doc/html/xpressive/user_s_guide.html for more information on how to build ypur regular expression. +.SH OPTIONS +begin does not take any options. +.SH EXAMPLE USAGE +begin "Jan 2[6-7]" /var/log/daemon.log + +cat /var/log/daemon.log | begin "Jan 2[6-7]" +.SH SEE ALSO +grep(1) +.SH BUGS +No known bugs. +.SH AUTHOR +Mikael Nordin (mik@elnord.in)