forked from LinuxCNC/linuxcnc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Strated to create an adoc man page for eachman page
- Loading branch information
Showing
28 changed files
with
408 additions
and
156 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= EXPORT_FUNCTION(3rtapi) | ||
|
||
== NAME | ||
|
||
EXPORT_FUNCTION - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
= MODULE_AUTOR(3rtapi) | ||
|
||
== NAME | ||
|
||
MODULE_AUTHOR - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
= MODULE_DESCRIPTION(3rtapi) | ||
|
||
== NAME | ||
|
||
MODULE_DESCRIPTION - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.adoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
= MODULE_LICENSE(3rtapi) | ||
|
||
== NAME | ||
|
||
MODULE_LICENSE - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.adoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= RTAPI_MP_ARRAY_INT(3rtapi) | ||
|
||
== NAME | ||
|
||
RTAPI_MP_ARRAY_INT - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= RTAPI_MP_ARRAY_LONG(3rtapi) | ||
|
||
== NAME | ||
|
||
RTAPI_MP_ARRAY_LONG - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= RTAPI_MP_ARRAY_STRING(3rtapi) | ||
|
||
== NAME | ||
|
||
RTAPI_MP_ARRAY_STRING - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= RTAPI_MP_INT(3rtapi) | ||
|
||
== NAME | ||
|
||
RTAPI_MP_INT - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= RTAPI_MP_LONG(3rtapi) | ||
|
||
== NAME | ||
|
||
RTAPI_MP_LONG - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= RTAPI_MP_STRING(3rtapi) | ||
|
||
== NAME | ||
|
||
RTAPI_MP_STRING - Specifying module parameters | ||
|
||
include::rtapi_module_param.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= hal_bit_t(3hal) | ||
|
||
== NAME | ||
|
||
hal_bit_t - typedefs for HAL datatypes | ||
|
||
include::hal_type_t.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= hal_bool(3hal) | ||
|
||
== NAME | ||
|
||
hal_bool - typedefs for HAL datatypes | ||
|
||
include::hal_type_t.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
:manvolnum: 3 | ||
|
||
= hal_del_funct_from_thread(3hal) | ||
|
||
== NAME | ||
|
||
hal_del_funct_from_thread - cause a function to be executed at regular intervals | ||
|
||
== SYNTAX | ||
|
||
int hal_add_funct_to_thread(const char *_funct_name_, const char | ||
*_thread_name_, int position) | ||
|
||
int hal_del_funct_from_thread(const char *_funct_name_, const char | ||
*_thread_name_) | ||
|
||
== ARGUMENTS | ||
|
||
funct_name:: | ||
The name of the function. | ||
thread_name:: | ||
The name of the thread. | ||
position:: | ||
The desired location within the thread. This determines when the | ||
function will run, in relation to other functions in the thread. A | ||
positive number indicates the desired location as measured from the | ||
beginning of the thread, and a negative is measured from the end. So | ||
+1 means this function will become the first one to run, +5 means it | ||
will be the fifth one to run, -2 means it will be next to last, and -1 | ||
means it will be last. Zero is illegal. | ||
|
||
== DESCRIPTION | ||
|
||
*hal_add_funct_to_thread* adds a function exported by a realtime HAL | ||
component to a realtime thread. This determines how often and in what | ||
order functions are executed. | ||
|
||
*hal_del_funct_from_thread* removes a function from a thread. | ||
|
||
== RETURN VALUE | ||
|
||
Returns a HAL status code. | ||
|
||
== REALTIME CONSIDERATIONS | ||
|
||
Call only from realtime init code, not from other realtime or | ||
non-realtime code. | ||
|
||
== SEE ALSO | ||
|
||
hal_thread_new(3hal), hal_export_funct(3hal) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
:manvolnum: 3 | ||
|
||
= hal_export_functf(3hal) | ||
|
||
== NAME | ||
|
||
hal_export_functf - create a realtime function callable from a thread | ||
|
||
== SYNTAX | ||
|
||
int hal_export_funct(const char *name, void (*funct) (void *, long), | ||
void *arg, int uses_fp, int reentrant, int comp_id); | ||
|
||
== DESCRIPTION | ||
|
||
*hal_export_functf* is similar to hal_export_funct except that it also does | ||
printf-style formatting to compute the function name. | ||
If successful, it returns 0. | ||
On failure it returns a negative error code. | ||
|
||
== RETURN VALUE | ||
|
||
Returns a HAL status code. | ||
|
||
== SEE ALSO | ||
|
||
hal_export_funct(3hal) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
:manvolnum: 3 | ||
|
||
= hal_get_lock(3hal) | ||
|
||
== NAME | ||
|
||
hal_get_lock - Get the HAL lock level | ||
|
||
== SYNTAX | ||
|
||
int hal_get_lock() | ||
|
||
== ARGUMENTS | ||
|
||
lock_type:: | ||
The desired lock type, which may be a bitwise combination of: | ||
*HAL_LOCK_LOAD*, *HAL_LOCK_CONFIG*, *HAL_LOCK_PARAMS*, or | ||
*HAL_LOCK_PARAMS*. *HAL_LOCK_NONE* or 0 locks nothing, and | ||
*HAL_LOCK_ALL locks everything.* | ||
|
||
== RETURN VALUE | ||
|
||
*hal_get_lock* returns the current HAL lock level or a HAL status code. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= hal_port_t(3hal) | ||
|
||
== NAME | ||
|
||
hal_port_t - typedefs for HAL datatypes | ||
|
||
include::hal_type_t.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
:manvolnum: 3 | ||
|
||
= hal_s32_t(3hal) | ||
|
||
== NAME | ||
|
||
hal_s32_t - typedefs for HAL datatypes | ||
|
||
include::hal_type_t.3.body[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.