LinuxCNC Documentation

ІМ’Я

halcompile — збирає, компілює та встановлює компоненти LinuxCNC HAL

СИНТАКСИС

halcompile [--compile|--preprocess|--document|--adoc|--view-doc] compfile…​

sudo halcompile [--install|--install-doc] compfile…​

halcompile --compile --userspace cfile…​

sudo halcompile --install --userspace cfile…​

sudo halcompile --install --userspace pyfile…​

Коли особистості використовуються у файлі comp, екземпляри HAL експортуються послідовно (зазвичай за допомогою взаємовиключних параметрів count= або names=). Якщо кількість експорту перевищує максимальну кількість особистостей, наступні особистості призначаються за модулем максимальної кількості дозволених особистостей.

За замовчуванням максимальна кількість особистостей становить 64. Щоб змінити це обмеження, скористайтеся опцією --personalities= у halcompile. Наприклад, щоб встановити максимальну кількість елементів особистості на 4: [sudo] halcompile --personalities=4 --install …​

Не використовуйте [sudo] для встановлення RIP.

ВАРІАНТИ

-a, --adoc

Витягти з компонента лише документацію у форматі asciidoc.

-c, --compile

Скомпілюйте компонент або модуль на C-вихідному коді.

-d, --document

Витягує документацію у форматі сторінки керівництва з компонента (збирає asciidoc, а потім конвертує його у сторінку керівництва). Цей параметр вимагає встановлення asciidoctor(1) або a2x(1) у вашій системі.

-h, -?, --help

Показати коротке повідомлення про використання та вийти.

-i, --install

Зберіть та встановіть компонент.

-J, --view-doc

Застаріло. Перегляд сторінки керівництва компонента (збирає asciidoc, перетворює на сторінку керівництва та запускає man(1)). Ця опція вимагає встановлення asciidoctor(1) або a2x(1) у вашій системі.

-j, --install-doc

Встановіть документацію сторінки керівництва у usr/share/man1 або usr/share/man9, залежно від того, чи це компонент простору користувача, чи компонент реального часу.

-k file, --keep-adoc=file

Зберігайте створений файл asciidoc під час створення документації manpage. Файл зберігається в file. Ви не можете вказати кілька вхідних файлів під час використання цієї опції, і вона не діє, якщо за допомогою опції -a або --adoc запитується лише документація у форматі asciidoc.

-l, --require-license

Застаріло. Компонент завжди повинен мати тег ліцензія.

-o file, --outfile=file

Записати вивід у файл. Можна використовувати тільки з обробкою --preprocess, --adoc та --document.

-P int, --personalities=int (за замовчуванням: 64)

Встановіть максимальну кількість персоналій у компоненті.

-p, --preprocess

З файлу компонента генерувати лише C-файл.

-U, --unix

Вимагати, щоб вихідний код мав закінчення рядків у стилі Unix, що підтримують лише NL.

-u, --userspace

Створіть C-код у просторі користувача (не реального часу). За замовчуванням збираються компоненти реального часу.

--extra-compile-args=args

Додаткові аргументи, що передаються компілятору C.

--extra-link-args=args

Додаткові аргументи, що передаються компонувальнику.

ОПИС

halcompile performs many different functions:

  • Компілювати файли .comp та .c у компоненти реального часу HAL .so або .ko (прапорець --compile)

  • Компілювати файли .comp та .c у компоненти HAL, що не працюють у реальному часі (прапорець --compile --userspace)

  • Попередня обробка файлів .comp у файли .c (прапорець --preprocess)

  • Витяг документації з файлів .comp у файли asciidoc або розділу сторінок man 1 або 9 (прапорці --adoc та --document)

  • Відображати документацію з файлів .comp на екрані (прапорець --view-doc)

  • Скомпілюйте та встановіть файли .comp та .c у відповідний каталог для компонентів реального часу HAL (прапорець --install), що може вимагати від sudo запису до системних каталогів.

  • Встановіть файли .c та .py у відповідний каталог для компонентів HAL, які не працюють у реальному часі (прапорець --install --userspace), що може вимагати від sudo запису до системних каталогів.

  • Витягти документацію з файлів .comp у файли сторінок довідки .1 або .9 у відповідному системному каталозі (прапорець --install), що може вимагати від sudo запису до системних каталогів.

  • Попередня обробка файлів .comp у файли .c (прапорець --preprocess)

ДИВІТЬСЯ ТАКОЖ

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

  • pydoc, HAL and Creating Non-realtime Python Components in the LinuxCNC documentation for documentation on the Python interface to HAL components