README.md

NSClient++ documentation

Index

• Manual:
  • NSClient++
  • Getting Started
  • Theory
  • Checking Things
  • Installing NSClient++
  • Configuration
  • FAQ
• About:
  • Documentation
  • Whats New
    • 0.4.0
    • 0.4.1
    • 0.4.2
    • 0.4.3
    • 0.4.4
    • 0.5.0
  • Building NSClient++
  • Reporting Bugs
  • Copyright
  • License
• Tutorial: tutorial/index.md
• Howto:
  • Checking things
  • Performance Counters
  • External scripts
  • Running commands
  • NRPE
  • NSCA
  • Migrate from 0.3
• Reference:
  • Reference
  • Check commands:
    • CheckDisk (Windows)
    • CheckExternalScripts
    • CheckEventLog (Windows)
    • CheckHelpers
    • CheckLogFile
    • CheckMKClient
    • CheckMKServer
    • CheckNet
    • CheckNSCP
    • CheckSystemUnix (unix)
    • CheckSystem (Windows)
    • CheckTaskSched (Windows)
    • CheckWMI (Windows)
  • Clients & Servers:
    • WEBServer
    • WEBClient
    • NRPEServer
    • NRPEClient
    • NSClientServer
    • NSCAServer
    • NSCAClient
    • NRDPClient
    • SMTPClient
    • GraphiteClient
    • SyslogClient
    • CollectdClient
  • Helper modules:
    • Scheduler
    • SimpleFileWriter
    • CommandClient
    • SimpleCache
    • PythonScript
    • LUAScript
    • DotnetPlugins
  • API:
    • API
    • Plugin

About documentation

The NSClient++ documentation is written in GitHub flavored Markdown. It is located in the docs/ directory and can be edited with your preferred editor. You can also edit it online on GitHub.

vim docs/installing.md

In order to review and test changes, you can install the mkdocs Python library.

pip install mkdocs

Note: Use at least 0.16, 0.14 has this bug.

This allows you to start a local mkdocs viewer instance on http://localhost:8000

mkdocs serve

Changes on the chapter layout can be done inside the mkdocs.yml file in the main tree.