Differences between revisions 1 and 2
Revision 1 as of 2006-11-24 17:13:49
Size: 1120
Editor: scott
Comment: first document
Revision 2 as of 2011-08-26 04:10:18
Size: 1120
Editor: localhost
Comment: converted to 1.6 markup
No differences found!

The following is the recommended practice for event naming:

  • Name your events in lower case:
    startup
  • Separate multiple words with dashes (-), not underscores:

    block-device-added
  • If you wish to namespace events, use a period (.):

    lsb.some-thing-happed
    debian.some-other-thing
  • System-level namespacing will use a forward slash (/):

    startup/failed
    ~scott/personal-event
  • Use arguments for information that is normally used to filter the event. First argument should be the most related to the event:
    network-device-added eth0
    path-mounted /usr hda1
  • Use environment variables for incidental information, to save the job having to look it up:
    network-device-added eth0
      IF_NAME=eth0
      IF_ADDR=...
  • Environment variables are all capitals, words separated by underscores (_) and usually share a common prefix.

  • Document your event in a manpage. Give the arguments and environment, and describe when the event is issued and what it means.
    network-device-added(5)

-- CategoryDoc

EventNaming (last edited 2011-08-26 04:10:18 by localhost)