linuxcnc/docs/man/man3/rtapi_task_self.3rtapi
Sebastian Kuzminsky 4a897203bc docs: fix hyphen/minus confusion in manpages
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.
2018-01-18 08:12:31 -07:00

21 lines
546 B
Text

.TH rtapi_task_self "3rtapi" "2015-04-18" "LinuxCNC Documentation" "RTAPI"
.SH NAME
rtapi_task_self \- Retrieve ID of current task
.SH SYNTAX
.HP
void rtapi_task_self()
.SH DESCRIPTION
\fBrtapi_task_self\fR retrieves the current task, or \-EINVAL if not in a
realtime task (e.g., in startup or shutdown code).
.SH REALTIME CONSIDERATIONS
May be called from init/cleanup code, and from within realtime tasks.
.SH RETURN VALUE
The task number previously returned by \fBrtapi_task_new\fR or \-EINVAL.
.SH SEE ALSO
\fBrtapi_task_new(3rtapi)\fR