comp

NAME
SYNOPSIS
DESCRIPTION
SEE ALSO

NAME

comp − Build, compile and install LinuxCNC HAL components

SYNOPSIS

comp [--compile|--preprocess|--document|--view-doc] compfile...

sudo comp [--install|--install-doc] compfile...

comp --compile --userspace cfile...

sudo comp --install --userspace cfile...
sudo
comp --install --userspace pyfile...

DESCRIPTION

comp performs many different functions:

Compile .comp and .c files into .so or .ko HAL realtime components (the --compile flag)

Compile .comp and .c files into HAL userspace components (the --compile --userspace flag)

Preprocess .comp files into .c files (the --preprocess flag)

Extract documentation from .comp files into .9 manpage files (the --document flag)

Display documentation from .comp files onscreen (the --view-doc flag)

Compile and install .comp and .c files into the proper directory for HAL realtime components (the --install flag), which may require sudo to write to system directories.

Install .c and .py files into the proper directory for HAL userspace components (the --install --userspace flag), which may require sudo to write to system directories.

Extract documentation from .comp files into .9 manpage files in the proper system directory (the --install flag), which may require sudo to write to system directories.

Preprocess .comp files into .c files (the --preprocess flag)

SEE ALSO

Comp HAL Component Generator in the LinuxCNC documentation for a full description of the .comp syntax, along with examples

pydoc hal and Creating Userspace Python Components in the LinuxCNC documentation for documentation on the Python interface to HAL components

comp(9) for documentation on the "two input comparator with hysteresis", a HAL realtime component with the same name as this program