tango-controls / tango-doc

The official documentation for Tango controls
http://tango-controls.readthedocs.io
8 stars 27 forks source link

Documentation for tango_admin #200

Closed daneos closed 4 years ago

daneos commented 5 years ago

The tango_admin utility is not documented. It may be worth documenting sice it is usually a part of Tango packages.

PhilLAL commented 5 years ago

Yes, it is not clear for newcomers that it is possible to add devices through command line. A good base is the output of tango_admin --help (or tango_admin without any correct argument) which could be rewritten.

I put it there to make it accessible:

$ /usr/lib/tango/tango_admin --help

Usage: 
 --help         Prints this help 
 --ping-database    [max_time (s)] Ping database 
 --check-device <dev>    Check if the device is defined in DB
 --add-server <exec/inst> <class> <dev list (comma separated)>   Add a server in DB
 --delete-server <exec/inst> [--with-properties]   Delete a server from DB
 --check-server <exec/inst>   Check if a device server is defined in DB
 --server-list  Display list of server names
 --server-instance-list <exec>   Display list of server instances for the given server name
 --add-property <dev> <prop_name> <prop_value (comma separated for array)>    Add a device property in DB
 --delete-property <dev> <prop_name>   Delete a device property from DB 
 --tac-enabled Check if the TAC (Tango Access Control) is enabled
 --ping-device <dev> [max_time (s)] Check if the device is running
 --ping-network [max_time (s)] [-v] Ping network