Bug 957320

Summary: [RFE] Generate manpage for rtorrent
Product: [Fedora] Fedora Reporter: Ben Boeckel <fedora>
Component: rtorrentAssignee: Conrad Meyer <cse.cem+redhatbugz>
Status: CLOSED INSUFFICIENT_DATA QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: rawhideCC: cse.cem+redhatbugz, sanjay.ankur
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-07-13 17:45:25 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Ben Boeckel 2013-04-27 06:35:22 UTC
Description of problem:
No manpage for rtorrent is generated. It can be generated according to the README as follows:

 Run "./autogen.sh" to generate the configure scripts if
nessesary. The man page "doc/rtorrent.1" must be generated with
"docbook2man rtorrent.1.xml" if it is missing.

Version-Release number of selected component (if applicable):
rtorrent-0.9.3-5.fc20.x86_64

Comment 1 Conrad Meyer 2013-04-27 18:52:28 UTC
Has the status of the rtorrent man page changed since bug 921745? If not, this can be closed as a DUPE. If it hasn't changed, tl;dr: the man page is so out of date, upstream doesn't ship it in tarballs anymore. Bundling an out of date man page is unhelpful. We're happy to take patches to update it, especially if you also send those upstream. But until that happens, no point bundling a stale man page.

Comment 2 Ben Boeckel 2013-04-27 22:03:21 UTC
Unlikely; the RPM release is all that's changed since then. Maybe removing the reference to the manpage from README would help avoid confusion? I doubt the fact that searching for a manpage on the web gives results helps, but there's not much to be done about that.

Really, what I'd like is local documentation on what all of the keybindings do. Without the network, I'm left hitting random keys hoping they do what I want (beyond the simple ones I've already memorized (^D, ^S, ^Q, arrows)).

Comment 3 Conrad Meyer 2013-04-27 22:11:53 UTC
Off the top of my head, ^X is "enter configuration and/or command", enter/return adds torrents manually, ^R or ^H is recheck hash. t or T forces re-announce to tracker in a given torrent's info page. Not particularly helpful, I know. Sorry ;-).

Writing up the key bindings and updating the man-page probably isn't too hard if you want it done bad enough to do it yourself. I'm happy to take patches that haven't made it to upstream yet. It might be acceptable to just patch the man page with a bold "THIS MAN PAGE IS STALE, INFORMATION MAY BE INACCURATE" at the top, if you want it included more or less "as is."

What do you think?

Comment 4 Conrad Meyer 2013-07-13 17:45:25 UTC
Please re-open if you have a patch you're happy with. :-)