[PATCH v3] Weston: weston.ini man page

[Pekka Paalanen]

On Sat, 12 Jan 2013 04:58:40 -0700
Scott Moreau <oreaus at gmail.com> wrote:

> Hi Martin,
> 
> Thanks for working on this. A few comments below.
> 
> On Fri, Jan 11, 2013 at 9:40 PM, Martin Minarik <
> minarik11 at student.fiit.stuba.sk> wrote:
> 
> > Track changes in weston.ini format: core, input-method sections.
> > animation: make zoom, fade bold.
> > More examples for keymap layous.
> > Example for term=xterm-256color
> > ---
> >  man/weston.ini.5 |  268
> > ++++++++++++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 268 insertions(+)
> >  create mode 100644 man/weston.ini.5
> >
> > diff --git a/man/weston.ini.5 b/man/weston.ini.5
> > new file mode 100644
> > index 0000000..a580242
> > --- /dev/null
> > +++ b/man/weston.ini.5
> > @@ -0,0 +1,268 @@
> > +.\" shorthand for double quote that works everywhere.
> > +.ds q \N'34'
> > +.TH weston.ini 5 "weston 0.95.0" "Wayland "
> >
> 
> Shouldn't the version here reflect latest weston?

Actually the version should be substituted during the build, see
http://cgit.freedesktop.org/wayland/weston/commit/?id=424820f4bc148accd9904953fb3702de87421e02

The date is hardcoded, since it reflects the age of the content,
ignoring simple typo fixes and such. The version reflects the
package version from which this man-page was installed.

The linked commit also shows how to add a new man category to the
build, category 7, and if you need to add more automatic substitutions,
those can be added to MAN_SUBST as sed scripts.

So, in the source tree we would have weston.ini.man, and then the build
will generate a weston.ini.5.

> > +.BR "shell          " "Desktop customisation"
> >
> 
> I am curious if there is a preferred spelled for words such as customize
> and optimizations. The discrepancy here is 's' vs 'z'.

I think this is a British vs. American English thing, and IIRC most
things are written in American, i.e. with a 'z'. Unless I recalled that
exactly the wrong way...


Thanks,
pq