wiki:Usage/UserDocumentation

Version 1 (modified by sil, 12 years ago) (diff)

initial user documentation

  1. User Documentation
    1. About the CMT data(structure)
  2. Web-interface
  3. Command Line Interface
    1. Add object(s): -a, --add
      1. Syntax
      2. Use case
    2. Change object(s): -c, --change
      1. Syntax
      2. Use case
    3. Generate a configfile: -g, --generate
      1. Syntax
      2. Use case
    4. List object(s): -l, --list
      1. Syntax
      2. Use case

User Documentation

CMT can be used with different user interfaces:

  • Web interface: An easy-to-use, self explainable, interface based on Django Admin. You only need a webbrowser to use this interface.
  • Command Line Interface (CLI): A less-easy-to-use interface which could be used to make mass-updates. The CLI offers the user some powerful functions which aren't possible on the web-interface. To use this interface you need to install CMT on the computer you're using.

Please keep in mind: Both interfaces are lacking of an undo-function, so be careful when you're about to make any changes in the data you've stored in CMT.

About the CMT data(structure)

Web-interface

Command Line Interface

Add object(s): -a, --add

Syntax

Use case

Change object(s): -c, --change

Syntax

Use case

Generate a configfile: -g, --generate

Syntax

Use case

List object(s): -l, --list

Syntax

Use case