aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>2014-10-03 21:25:51 -0300
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>2014-10-03 21:25:51 -0300
commit8f65c73849e3fc9b6672348e74d07fbb613daf6a (patch)
tree58e33ea294690268c7ec1c97977412fbd1021142 /doc
parenteb7701279cf8cab0705dfb6b49b0064a144b7d16 (diff)
man: move dvb-fe-tool.1 out of Doxygen
Using doxygen to document an userspace man page doesn't make it easier. Instead, it brings extra troubles, as it would create all man pages under the very same section. So, move the dvb-fe-tool man page out of doxygen, adding it as q separate file. Hopefully, that will make it easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/libdvbv5-index.doc103
1 files changed, 1 insertions, 102 deletions
diff --git a/doc/libdvbv5-index.doc b/doc/libdvbv5-index.doc
index 7e6ab45c..be7ef194 100644
--- a/doc/libdvbv5-index.doc
+++ b/doc/libdvbv5-index.doc
@@ -230,13 +230,9 @@ definition using dvbv5-scan:
INNER_FEC = NONE
DELIVERY_SYSTEM = DVBC/ANNEX_A
@endcode
-*/
-
-/**
-@page dvbv5-scan-example dvbv5-scan
--@brief The dvbv5-scan - DVBv5 tool for frequency scanning
@example dvbv5-scan.c
+@example dvb-fe-tool.c
*/
/**
@@ -313,103 +309,6 @@ Lock (0x1f) Quality= Good Signal= 100.00% C/N= -13.90dB UCB= 384 postBER= 96.8
*/
/**
-@page dvb-fe-tool dvb-fe-tool
-@brief The dvbv5-fe-tool - DVBv5 tool for frontend settings inspect/change
-
-dvbv5-fe-tool is a command line tool for digital TV services that is compliant
-with version 5 of the DVB API, and backward compatible with the older v3
-DVB API.
-
-dvb-fe-tool is a tool to inspect and change the tuning parameters directly
-at the Digital TV frontend. If called without any parameter, it will show
-the device capabilities:
-
-@code{.unparsed}
-$ dvb-fe-tool
-Device DRXK DVB-C DVB-T (/dev/dvb/adapter0/frontend0) capabilities:
- CAN_FEC_1_2
- CAN_FEC_2_3
- CAN_FEC_3_4
- CAN_FEC_5_6
- CAN_FEC_7_8
- CAN_FEC_AUTO
- CAN_GUARD_INTERVAL_AUTO
- CAN_HIERARCHY_AUTO
- CAN_INVERSION_AUTO
- CAN_MUTE_TS
- CAN_QAM_16
- CAN_QAM_32
- CAN_QAM_64
- CAN_QAM_128
- CAN_QAM_256
- CAN_RECOVER
- CAN_TRANSMISSION_MODE_AUTO
-DVB API Version 5.10, Current v5 delivery system: DVBC/ANNEX_A
-Supported delivery systems:
- [DVBC/ANNEX_A]
- DVBC/ANNEX_C
- DVBT
-@endcode
-
-It can also be used to change some parameters. For example, if one wants to
-run a legacy DVBv3 application to work with DVB-C in Japan, it could do:
-
-@code{.unparsed}
-$ dvb-fe-tool -d dvbc/annex_c
-Changing delivery system to: DVBC/ANNEX_C
-@endcode
-
-It can also be used to get the current settings:
-
-@code{.unparsed}
-$ dvb-fe-tool -g
-FREQUENCY = 573000000
-MODULATION = QAM/256
-INVERSION = AUTO
-SYMBOL_RATE = 5217000
-INNER_FEC = NONE
-DELIVERY_SYSTEM = DVBC/ANNEX_A
-@endcode
-
-The dvb-fe-tool can also be used to monitor a DVB frontend statistics without
-touching on the device, using the --femon (or -m) parameter. The typical usage
-is to be able to read the statistics while some other DVB program or
-application is in use.
-
-
-On this mode, it will keep printing the frontend statistics on every second,
-until the program is aborted with CTRL-C:
-
-For example, while dvbv5-zap is tuning some channel, it will produce:
-
-@code{.unparsed}
-$ dvb-fe-tool --femon
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.40dB UCB= 370 postBER= 28.0x10^-6 PER= 0
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.80dB UCB= 370 postBER= 25.3x10^-6 PER= 0
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.30dB UCB= 370 postBER= 25.7x10^-6 PER= 0
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.30dB UCB= 370 postBER= 28.4x10^-6 PER= 0
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.50dB UCB= 370 postBER= 26.5x10^-6 PER= 0
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.50dB UCB= 370 postBER= 26.9x10^-6 PER= 0
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.20dB UCB= 370 postBER= 28.6x10^-6 PER= 0
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.70dB UCB= 370 postBER= 26.7x10^-6 PER= 0
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.80dB UCB= 370 postBER= 23.3x10^-6 PER= 0
-Lock (0x1f) Quality= Good Signal= 100.00% C/N= 36.50dB UCB= 370 postBER= 26.7x10^-6 PER= 0
-@endcode
-
-If the standard error device is the console, the messages will be colored
-according with the signal quality.
-
-On this mode, it also supports to output an audible signal if the quality is
-good, using the "-A" parameter.
-
-Please notice that, on modern Linux systems, the system audio should be
-enabled at your window manager and the audio theme should be set to produce
-an audio when BELL (\a character) is sent to the terminal.
-
-@example dvb-fe-tool.c
-*/
-
-/**
@page dvb-format-convert dvb-format-convert
@brief The dvb-format-convert - DVBv5 tool for file format conversions

Privacy Policy