[oi-dev] what transforms and/or actuators for man pages?

Tim Mooney Tim.Mooney at ndsu.edu
Tue Oct 8 21:34:00 UTC 2019


What are the recommended transforms to include in a component's .p5m file
for man pages?

The "Packaging and Delivering Software with IPS" guide has an example
(chapter 4, pages 27-28) of:

<transform dir file link hardlink path=opt/.+/man(/.+)? -> \
     default facet.doc.man true>
<transform file path=opt/.+/man(/.+)? -> \
     add restart_fmri svc:/application/man-index:default>

The /usr/share/pkg/transform/documentation file has the same thing, but
for /usr/share/man, rather than the example above, for /opt.


The actual .p5m files in oi-userland use a wide variety of transforms
for man pages, such as

<transform file path=usr/share/man/(man3/.+$) -> set action.hash %<\1> >
<transform file path=usr.*/man/.+ -> default mangler.man.stability uncommitted>

or

<transform file path=usr.*/man/.+ -> default mangler.man.stability Uncommitted>

or

<transform file path=usr.*/man/.+ -> default mangler.man.stability volatile>

or

<transform file path=usr.*/man/.+ -> default mangler.man.stability "pass-through volatile">

I don't see any current .p5m files that use the restart_fmri for OI's
service svc:/system/update-man-index:default , which I'm assuming is
equivalent to the svc:/application/man-index:default from the example.

So, what are best practices for man page transforms for OI?

Thanks!

Tim
-- 
Tim Mooney                                             Tim.Mooney at ndsu.edu
Enterprise Computing & Infrastructure /
Division of Information Technology    /                701-231-1076 (Voice)
North Dakota State University, Fargo, ND 58105-5164




More information about the oi-dev mailing list