[kde-doc-english] Review Request 128096: add man page for kaffeine

[Mauro Carvalho Chehab]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/128096/#review96253
-----------------------------------------------------------


Ship it!




Sounds OK. I guess it is ready for addition at Kaffeine.

Answering your questions:

<!--<member>qt5options(1)</member>  only for application with a GUI FIXME use if we have an updated man page qt5options-->

Kaffeine does accept qt5options. It doesn't do anything special to them, just whatever Qt5 implements.

<!--<member>foo(1)</member> FIXME any ref to an other man page here ?  vlc? or an utility to detect a tv card and gives outpout necessary to unse kaffeine?-->

For now, I don't think we need to point to VLC manpage, as there's nothing there that would help the user. Yet, we can mention at the manpage that it uses libVLC as video/audio play backend.

The only thing external that Kaffeine indirectly uses is this tree: https://git.linuxtv.org/dtv-scan-tables.git/

It contains the list of known channels per locality and per Satellite (for DVB-S). There's a developer's utility that generates a Kaffeine-specific file (scanfile.dvb) with uses such information. We run such tool from time to time, and we store the scanfile on a public repository. There's a button at the "Configura Television" screen that says: "Update scan data over Internet". When the user clicks on it, it downloads the latest file stored at: http://kaffeine.kde.org/scanfile.dvb.qz (I'm actually thinking that maybe the best would be to store it at linuxtv.org, and add there some automation to auto-create it when the upstream dtv-scan-tree changes).

Unfortunately, we don't have a manfile for dtv-scan-tables yet - patches are welcome.

Anyway, if the user has the need for a channel that it is not listed on Kaffeine, he needs to either use dvbv5-scan or w_scan to generate a new file (in the latter case, converted to the proper format using dvb-format-convert), and submit it to linux-media at vger.kernel.org, with "[PATCH] dtv-scan-tables: <some description>" at the subject, for us to add it at the tree and create a new scanfile.dvb.qz.

So, I guess we should mention the above procedure and point to the manpages for dvbv5-scan and w_scan.

- Mauro Carvalho Chehab


On June 4, 2016, 11:29 a.m., Burkhard Lück wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/128096/
> -----------------------------------------------------------
> 
> (Updated June 4, 2016, 11:29 a.m.)
> 
> 
> Review request for Documentation and Mauro Carvalho Chehab.
> 
> 
> Repository: kaffeine
> 
> 
> Description
> -------
> 
> add new man page
> debian policy requires it anyway
> this should replace the outdated sect in the handbook
> 
> 
> Diffs
> -----
> 
>   doc/CMakeLists.txt 06f05fb 
>   doc/man-kaffeine.1.docbook PRE-CREATION 
> 
> Diff: https://git.reviewboard.kde.org/r/128096/diff/
> 
> 
> Testing
> -------
> 
> passes checkXML5
> 
> 
> Thanks,
> 
> Burkhard Lück
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-doc-english/attachments/20160607/67aa9a01/attachment.html>