Bug 8339 - Manpages (old issue #56)
Summary: Manpages (old issue #56)
Status: RESOLVED FIXED
Alias: None
Product: opkg
Classification: Yocto Project Subprojects
Component: opkg (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Undecided enhancement
Target Milestone: 1.0
Assignee: Alejandro del Castillo
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2015-09-20 22:19 UTC by Alejandro del Castillo
Modified: 2018-12-26 17:26 UTC (History)
0 users

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)


Attachments
add_manpages (6.73 KB, patch)
2015-09-20 22:20 UTC, Alejandro del Castillo
no flags Details | Diff
add_manpages2 (23.22 KB, patch)
2015-09-20 22:21 UTC, Alejandro del Castillo
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Alejandro del Castillo 2015-09-20 22:19:28 UTC
Hi,

I enclosed a patch which provides manpages for binaries. I think it is easier to read than invoking a binary using the '--help' option.

David

Originally filed on Aug 5, 2010
-----------------------------------------------------------------------------
 #1 graham.gower
Ok, thanks.

There is also some man page stuff on the list here:
http://groups.google.com/group/opkg-devel/browse_thread/thread/10ff67aa0f55973c/88bd02302e806567?lnk=gst&q=opkg+help+and+documentation#88bd02302e806567
Its not particularly polished, nor is it all relevant to opkg.

#2 graham.gower (Aug 9, 2010)
I've committed your man pages. Thanks David.
Status: Fixed 

#4 david.bachelart@grassvalley.com (Aug 10, 2010)
Wow !

Nice catch. I searched the development mailing-list, but I did not found any work regarding this purpose. I've just merged proposed manpages and my former work. Patch enclosed.

I fixed suggested manpages in order to provide a coherent documentation. I also added symbolic links at install step (ipk -> opk format file, opkg -> opkg-cl), I think it'll be easier to call the relevant man page. 

Thanks.
	
#5 graham.gower (Aug 11, 2010)
The opk.5 and opk-control.5 pages are not accurate nor complete and the copyright is dubious (looks like the file is pulled from Debian). If corrected, it would be better off going into a wiki than manual pages. This would make it more accessible, considering most opkg installations are on embedded systems which quite likely won't install the man program.

An opkg.conf man page would be relevant. But again, this one has many omissions and inaccuracies.

#6 paul.betafive (Sep 18, 2013)
Further documentation is on the roadmap but I won't have time for it for a while yet...

Manpages for the config files, package file format and package control fields will all eventually be needed.

#7 paul.betafive (Sep 28, 2013)
The manpage for opkg.conf needs to address issue 64 .
Comment 1 Alejandro del Castillo 2015-09-20 22:20:46 UTC
Created attachment 2748 [details]
add_manpages
Comment 2 Alejandro del Castillo 2015-09-20 22:21:14 UTC
Created attachment 2749 [details]
add_manpages2
Comment 3 Alejandro del Castillo 2018-12-26 17:26:29 UTC
Opkg already has man pages for the main binary, opkg-conf and opkg-key