This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
suitable markup for "service" ?
- From: Leni Mayo <leni at moniker dot net>
- To: docbook at lists dot oasis-open dot org
- Date: Tue, 21 May 2002 18:01:27 +1000
- Subject: DOCBOOK: suitable markup for "service" ?
I'm working on a document where the notion of a "service" frequently
crops up. Examples of services: syslog, network, cron, inetd,
sendmail, sshd etc.
Some properties of "service":
- long-running - usually starts when a computer boots
- considered infrastructure by other applications
- service may be a process (eg syslog), or may not (eg network)
As a docbook newbie, none of the following seem to quite fit the bill:
<application>syslog</application>
<command>syslog</command>
<systemitem class="resource">syslog</systemitem>
<systemitem> seems like the right element, but none of the class
values seem right.
I wondered whether a new class value for <systemitem> would make
sense, but subsequently discarded all of:
- "servicename" - too vague
- "processname", to label a (long running) process on an
operating system, eg:
<systemitem class="processname">init</systemitem>
but service is a slightly more general notion,
- "assignedname", referring to names assigned by some authority,
capturing (for example) the keywords at:
http://www.iana.org/assignments/port-numbers
So I guess I'm sharing the puzzlement and seeking suggestions re: the
best choice of markup. The problem domain is:
http://www.fastboot.org/doc/serel-overview/visualisation.html
Leni.