Skip to content

Commit

Permalink
system: add a tiny manual page for opnsense-log
Browse files Browse the repository at this point in the history
  • Loading branch information
fichtner committed Nov 23, 2021
1 parent 0b75c0c commit 19d89e0
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
1 change: 1 addition & 0 deletions plist
Expand Up @@ -1718,6 +1718,7 @@
/usr/local/share/man/man8/opnsense-beep.8.gz
/usr/local/share/man/man8/opnsense-importer.8.gz
/usr/local/share/man/man8/opnsense-installer.8.gz
/usr/local/share/man/man8/opnsense-log.8.gz
/usr/local/share/man/man8/opnsense-shell.8.gz
/usr/local/share/man/man8/opnsense-version.8.gz
/usr/local/wizard/openvpn.xml
Expand Down
59 changes: 59 additions & 0 deletions src/man/man8/opnsense-log.8
@@ -0,0 +1,59 @@
.\"
.\" Copyright (c) 2021 Franco Fichtner <franco@opnsense.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 November 23, 2021
.Dt OPNSENSE-LOG 8
.Os
.Sh NAME
.Nm opnsense-log
.Nd OPNsense log utility
.Sh SYNOPSIS
.Nm
.Op Fl fl
.Op Ar type
.Sh DESCRIPTION
The
.Nm
utility will display the current selected log file type content.
.Pp
The options are as follows:
.Bl -tag -width ".Fl f" -offset indent
.It Fl f
Use
.Xr tail 1
instead of
.Xr cat 1
to display the log content.
.It Fl l
List all available log types.
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr cat 1 ,
.Xr tail 1
.Sh AUTHORS
.An Scott Ullrich Aq Mt sullrich@gmail.com

0 comments on commit 19d89e0

Please sign in to comment.