[hamradio-commits] [dump1090-mutability] 144/172: Add manpages for dump1090 and view1090
Matteo F. Vescovi
mfv at moszumanska.debian.org
Sun Jan 28 13:45:54 UTC 2018
This is an automated email from the git hooks/post-receive script.
mfv pushed a commit to branch master
in repository dump1090-mutability.
commit 4768988707226edc4f23e04b84c741aa065bb5c2
Author: Matthew Ernisse <mernisse at ub3rgeek.net>
Date: Fri Oct 24 10:28:15 2014 -0400
Add manpages for dump1090 and view1090
---
debian/dump1090-mutability.manpages | 1 +
debian/dump1090.1 | 288 ++++++++++++++++++++++++++++++++++++
debian/view1090.1 | 139 +++++++++++++++++
3 files changed, 428 insertions(+)
diff --git a/debian/dump1090-mutability.manpages b/debian/dump1090-mutability.manpages
new file mode 100644
index 0000000..0f65186
--- /dev/null
+++ b/debian/dump1090-mutability.manpages
@@ -0,0 +1 @@
+debian/*.1
diff --git a/debian/dump1090.1 b/debian/dump1090.1
new file mode 100644
index 0000000..ef55512
--- /dev/null
+++ b/debian/dump1090.1
@@ -0,0 +1,288 @@
+.\"Text automatically generated by txt2man
+.\" Copyright (c) 2014 Matthew John Ernisse <mernisse at ub3rgeek.net>
+.\" 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.
+.\"
+.\"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
+.\"COPYRIGHT OWNER 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.
+.\"
+.TH "DUMP1090" "1" "17 August 2014" "" "User Commands"
+.SH NAME dump1090 \- Mode-S decoder
+.SH SYNOPSIS
+.nf
+.fam C
+\fBdump1090\fP
+\fBdump1090\fP \fB--interactive\fP
+\fBdump1090\fP \fB--ifile\fP \fIfile\fP
+
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+\fBdump1090\fP receives and decodes Mode S packets using the Realtek RTL2832
+software defined radio interface. It provides the ability to decode
+multiple frame types as well as correct bit errors using the embedded
+24-bit CRC. Results can be viewed using a text client, via the built-
+in HTTP server or forwarded off to other locations for collection.
+.PP
+
+.SH OPTIONS
+The supported options are as follows:
+.TP
+.B
+\fB--device-index\fP \fIindex\fP
+Select RTL device (default: 0)
+.TP
+.B
+\fB--gain\fP \fIdb\fP
+Set gain (default: max gain. Use \fB-10\fP for auto-gain)
+.TP
+.B
+\fB--enable-agc\fP
+Enable the Automatic Gain Control (default: off)
+.TP
+.B
+\fB--freq\fP \fIhz\fP
+Set frequency (default: 1090 Mhz)
+.TP
+.B
+\fB--ifile\fP \fIfilename\fP
+Read data from \fIfile\fP (use '-' for stdin)
+.TP
+.B
+\fB--interactive\fP
+Display received in a textual table, in real-time.
+.TP
+.B
+\fB--interactive-rows\fP \fInum\fP
+Max number of rows in interactive mode (default: 15)
+.TP
+.B
+\fB--interactive-ttl\fP \fIsec\fP
+Remove from list if idle for \fIsec\fP (default: 60)
+.TP
+.B
+\fB--interactive-rtl1090\fP
+Display flight table in RTL1090 format
+.TP
+.B
+\fB--raw\fP
+Show only messages hex values
+.PP
+\fB--net\fP Enable networking
+.TP
+.B
+\fB--modeac\fP
+Enable decoding of SSR Modes 3/A & 3/C
+.TP
+.B
+\fB--net-beast\fP
+TCP raw output in Beast binary format
+.TP
+.B
+\fB--net-only\fP
+Enable just networking, no RTL device or \fIfile\fP used
+.TP
+.B
+\fB--net-http-port\fP \fIport\fP
+HTTP server port (default: 8080)
+.TP
+.B
+\fB--net-ri-port\fP \fIport\fP
+TCP raw input listen port (default: 30001)
+.TP
+.B
+\fB--net-ro-port\fP \fIport\fP
+TCP raw output listen port (default: 30002)
+.PP
+\fB--net-sbs-port\fP \fIport\fP TCP BaseStation output listen port (default: 30003)
+.TP
+.B
+\fB--net-bi-port\fP \fIport\fP
+TCP Beast input listen port (default: 30004)
+.TP
+.B
+\fB--net-bo-port\fP \fIport\fP
+TCP Beast output listen port (default: 30005)
+.TP
+.B
+\fB--net-ro-size\fP \fIsize\fP
+TCP raw output minimum size (default: 0)
+.TP
+.B
+\fB--net-ro-rate\fP \fIrate\fP
+TCP raw output memory flush rate (default: 0)
+.TP
+.B
+\fB--net-heartbeat\fP \fIrate\fP
+TCP heartbeat rate in seconds (default: 60; 0 to disable)
+.TP
+.B
+\fB--net-buffer\fP \fIn\fP
+TCP buffer size 64Kb * (2^n) (default: n=0, 64Kb)
+.TP
+.B
+\fB--lat\fP \fIlatitude\fP
+Reference/receiver latitude for surface posn (opt)
+.TP
+.B
+\fB--lon\fP \fIlongitude\fP
+Reference/receiver longitude for surface posn (opt)
+.TP
+.B
+\fB--fix\fP
+Enable single-bits error correction using CRC
+.TP
+.B
+\fB--no-fix\fP
+Disable single-bits error correction using CRC
+.TP
+.B
+\fB--no-crc-check\fP
+Disable messages with broken CRC (discouraged)
+.TP
+.B
+\fB--phase-enhance\fP
+Enable phase enhancement
+.TP
+.B
+\fB--aggressive\fP
+More CPU for more messages (two bits fixes, \.\.\.)
+.TP
+.B
+\fB--mlat\fP
+display raw messages in Beast ascii mode
+.TP
+.B
+\fB--stats\fP
+With \fB--ifile\fP print stats at exit. No other output
+.TP
+.B
+\fB--onlyaddr\fP
+Show only ICAO addresses (testing purposes)
+.TP
+.B
+\fB--metric\fP
+Use metric units (meters, km/h, \.\.\.)
+.TP
+.B
+\fB--snip\fP \fIlevel\fP
+Strip IQ \fIfile\fP removing samples \fI level
+.TP
+.B
+\fB--debug\fP \fIflags\fP
+Debug mode (verbose)
+.TP
+.B
+\fB--quiet\fP
+Disable output to stdout.
+.TP
+.B
+\fB--ppm\fP \fIerror\fP
+Set receiver error in parts per million (default 0)
+.TP
+.B
+\fB--help\fP
+Show help
+.SH DIAGNOSTICS
+The Debug mode is a visual help to improve the detection algorithm or to
+understand why the program is not working for a given input.
+.PP
+In this mode messages are displayed in an ASCII-art style graphical
+representation, where the individual magnitude bars sampled at 2MHz are
+displayed.
+.PP
+An index shows the sample number, where 0 is the sample where the first Mode S
+peak was found. Some additional background noise is also added before the
+first peak to provide some context.
+.PP
+Select frames to log using the following flags:
+.TP
+.B
+d
+Log frames decoded with errors
+.TP
+.B
+D
+Log frames decoded with zero errors
+.TP
+.B
+c
+Log frames with bad CRC
+.TP
+.B
+C
+Log frames with good CRC
+.TP
+.B
+p
+Log frames with bad preamble
+.TP
+.B
+n
+Log network debugging info
+.TP
+.B
+j
+Log frames to frames.js, loadable by debug.html
+.SH EXAMPLES
+.TP
+The most basic usage is with no flags, which will open the first found rtl-sdr device and begin printing out hex dumps of the received packets.
+Most people will either run this in interactive mode or as a daemon.
+.PP
+Interactive mode
+.PP
+.nf
+.fam C
+ dump1090 \-\-interactive
+
+.fam T
+.fi
+Daemon mode
+.PP
+.nf
+.fam C
+ dump1090 \-\-net \-\-quiet &
+
+.fam T
+.fi
+You can also use \fBdump1090\fP as a network hub for multiple receivers by using
+.PP
+.nf
+.fam C
+ dump1090 \-\-net\-only
+
+.fam T
+.fi
+.SH BUGS
+Report bugs with the program to the project's github page
+<https://github.com/MalcolmRobb/dump1090/>
+
+.SH AUTHORS
+Dump1090 was originally written by Salvatore Sanfilippo <antirez at gmail.com>.
+This version is now maintained by Malcolm Robb <support at attavionics.com>.
+This was packaged for Debian by Matthew Ernisse <mernisse at ub3rgeek.net>.
+.RE
+.PP
+
diff --git a/debian/view1090.1 b/debian/view1090.1
new file mode 100644
index 0000000..c945122
--- /dev/null
+++ b/debian/view1090.1
@@ -0,0 +1,139 @@
+.\"Text automatically generated by txt2man
+.\" Copyright (c) 2014 Matthew John Ernisse <mernisse at ub3rgeek.net>
+.\" 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.
+.\"
+.\"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
+.\"COPYRIGHT OWNER 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.
+.\"
+.TH "VIEW1090" "1" "17 August 2014" "" "User Commands"
+.SH NAME view1090 \- Text client for dump1090
+.SH SYNOPSIS
+.nf
+.fam C
+\fBview1090\fP
+\fBview1090\fP \fB--net-bo-ipaddr\fP \fIipaddr\fP \fB--net-bo-port\fP \fIport\fP
+
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+\fBview1090\fP allows you to connect to a TCP Beast compliant stream and view
+the decoded messages in an ASCII-text table.
+.RE
+.PP
+
+.SH OPTIONS
+The supported options are as follows:
+.TP
+.B
+\fB--interactive\fP
+Display received in a textual table, in real-time.
+.TP
+.B
+\fB--interactive-rows\fP \fInum\fP
+Max number of rows in interactive mode (default: 15)
+.TP
+.B
+\fB--interactive-ttl\fP \fIsec\fP
+Remove from list if idle for \fIsec\fP (default: 60)
+.TP
+.B
+\fB--interactive-rtl1090\fP
+Display flight table in RTL1090 format
+.TP
+.B
+\fB--modeac\fP
+Enable decoding of SSR Modes 3/A & 3/C
+.TP
+.B
+\fB--net-bo-ipaddr\fP \fIIPv4\fP
+TCP Beast server address (default: 127.0.0.1)
+.TP
+.B
+\fB--net-bo-port\fP \fIport\fP
+TCP Beast server port (default: 30005)
+.TP
+.B
+\fB--lat\fP \fIlatitude\fP
+Reference/receiver latitude for surface posn (opt)
+.TP
+.B
+\fB--lon\fP \fIlongitude\fP
+Reference/receiver longitude for surface posn (opt)
+.TP
+.B
+\fB--fix\fP
+Enable single-bits error correction using CRC
+.TP
+.B
+\fB--no-fix\fP
+Disable single-bits error correction using CRC
+.TP
+.B
+\fB--no-crc-check\fP
+Disable messages with broken CRC (discouraged)
+.TP
+.B
+\fB--aggressive\fP
+More CPU for more messages (two bits fixes, \.\.\.)
+.TP
+.B
+\fB--metric\fP
+Use metric units (meters, km/h, \.\.\.)
+.TP
+.B
+\fB--help\fP
+Show help
+.SH EXAMPLES
+The most basic usage is with no flags, which will connect to the dump1090
+instance running on the local host.
+.PP
+.nf
+.fam C
+ view1090
+
+.fam T
+.fi
+To connect to a remote instance you can specify the IPv4 address of that
+host.
+.PP
+.nf
+.fam C
+ view1090 \-\-net\-bo\-ipaddr \fIipaddr\fP
+
+
+.fam T
+.fi
+.SH BUGS
+Report bugs with the program to the project's github page
+<https://github.com/MalcolmRobb/dump1090/>
+
+.SH AUTHORS
+Dump1090 was originally written by Salvatore Sanfilippo <antirez at gmail.com>.
+This version is now maintained by Malcolm Robb <support at attavionics.com>.
+This was packaged for Debian by Matthew Ernisse <mernisse at ub3rgeek.net>.
+.RE
+.PP
+
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-hamradio/dump1090-mutability.git
More information about the pkg-hamradio-commits
mailing list