Skip to content

Include examples/ with installation? #10

Description

@ziegast

New SIE customers typically get a tutorial session on how to read NMSG data, and I typically start by using nmsgtool presentation output to demonstrate. When they are ready to do script or C programming, I refer to the examples that come with the source and compare it to nmsgtool functionality. I typically download the latest source file (nmsg-$version.tar.gz) and extract the examples/ subdirectory. During installation it may be a good idea to have the examples/ subdirectory copied to a system documentation area like /usr/local/share/doc/nmsg or /usr/share/doc/nmsg so that they're available to reference without extra work.

It's possible that we don't need to install the examples/ if we know that github or some other online place will be available (for example: https://github.com/farsightsec/nmsg/tree/master/examples). Thoughts?

The same request would would apply to python-nmsg script examples and maybe Perl Net::Nmsg script examples, but I thought I'd try asking for nmsg first. If there's consensus that it's a good idea for nmsg, I'll reach out for the others.

Thanks,
Eric Ziegast

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions