commit c77dd72d6baf21f4d264a17f5aa52d3f4a070cc3
parent 09e6dc9e68628bfefb8253199a2013d0247542e4
Author: Frederic Cambus <fcambus@users.sourceforge.net>
Date: Thu, 31 Dec 2015 00:13:16 +0100
Adding initial manual page in mdoc format
Diffstat:
| A | logswan.1 | | | 61 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 61 insertions(+), 0 deletions(-)
diff --git a/logswan.1 b/logswan.1
@@ -0,0 +1,61 @@
+.\"
+.\" Copyright (c) 2015, Frederic Cambus
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are met:
+.\"
+.\" * Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\"
+.\" * Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" * Neither the name of Logswan nor the names of its contributors may be
+.\" used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
+.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: December 30 2015 $
+.Dt LOGSWAN 1
+.Os Empty
+.Sh NAME
+.Nm logswan
+.Nd fast Web log analyzer using probabilistic data structures
+.Sh SYNOPSIS
+.Nm
+.Op Fl hv
+.Ar file
+.Sh DESCRIPTION
+.Nm
+is a fast Web log analyzer using probabilistic data structures. It is targeted at very large log files, typically APIs logs. It has constant memory usage regardless of the log file size, and takes approximatively 4MB of RAM.
+.Pp
+If
+.Ar file
+is a single dash (`-'),
+.Nm
+reads from the standard input.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl h
+Display usage
+.It Fl v
+Display version
+.El
+.Sh AUTHORS
+.An
+.Nm
+is developed by Frederic Cambus
