4a897203bc
groff treats '-' (the character you get when you hit the "minus" key on the keyboard) as "hyphen", not as "minus". Thus it renders incorrectly in some locales, and line-wraps strangely. groff treats the two-character sequence "\-" as "minus", and the four-character sequence "\(hy" as "hyphen". Details here: https://lists.debian.org/debian-devel/2003/03/msg01481.html This commit replaces every instance of "-" in our manpages where the meaning is "minus" with "\-", so it works right. This fixes many lintian warnings.
32 lines
904 B
Text
32 lines
904 B
Text
.TH rtapi_app_main "3rtapi" "2008-05-26" "LinuxCNC Documentation" "HAL"
|
|
.SH NAME
|
|
|
|
rtapi_app_main \- User-provided function to initialize a component
|
|
|
|
.SH SYNTAX
|
|
.nf
|
|
.B #include <rtapi_app.h>
|
|
.HP
|
|
.BI "int rtapi_app_main(void) {" ... "}"
|
|
.fi
|
|
.SH ARGUMENTS
|
|
None
|
|
|
|
.SH DESCRIPTION
|
|
The body of \fBrtapi_app_main\fR, which is provided by the component author,
|
|
generally consists of a call to rtapi_init or hal_init, followed by other
|
|
component-specific initialization code.
|
|
|
|
.SH RETURN VALUE
|
|
Return 0 for success. Return a negative errno value (e.g., \-EINVAL) on
|
|
error. Existing code also returns RTAPI or HAL error values, but using
|
|
negative errno values gives better diagnostics from insmod.
|
|
|
|
.SH REALTIME CONSIDERATIONS
|
|
Called automatically by the rtapi infrastructure in an initialization (not
|
|
realtime) context.
|
|
|
|
.SH SEE ALSO
|
|
\fBrtapi_app_exit(3rtapi)\fR,
|
|
\fBrtapi_init(3rtapi)\fR,
|
|
\fBhal_init(3hal)\fR
|