NAME
cdoc - view component documentation for installed components
SYNOPSIS
cdoc --help
cdoc [--verbose|-v] type
DESCRIPTION
cdoc is a tool for viewing nicely formatted documentation on installed components. It uses an OpenComputers feature wherein component API functions, when tostringed, return a documentation string. As a result, cdoc may not fully work on some emulators.
When invoked, cdoc will search for a component of type type. If the component is installed in the system, cdoc will iterate through all methods, tostring them, and output the result into /tmp/cdoc_type. cdoc will then display the file for viewing in the system's manual pager, usually less(1).
EXAMPLES
cdoc --help
Print the help page for cdoc.
cdoc gpu
Display documentation for the gpu component.
COPYRIGHT
Monolith System Interfaces (c) 2020 Ocawesome101 under the GNU GPLv3.
SEE ALSO
less(1), man(1)