Bug 8338

Summary: Manpages
Product: [Yocto Project Subprojects] opkg Reporter: Alejandro del Castillo <alejandro.delcastillo>
Component: opkgAssignee: Alejandro del Castillo <alejandro.delcastillo>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: Undecided    
Version: unspecified   
Target Milestone: ---   
Hardware: x86   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)
Attachments:
Description Flags
add none

Description Alejandro del Castillo 2015-09-20 22:19:03 UTC
Created attachment 2747 [details]
add

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 2016-12-09 19:25:38 UTC
Commit 	741b5f808d09d30fb195fdec96025c92d31b4d03 added a man page for opkg.conf.