Skip to content

Commit 0b47539

Browse files
authored
Merge pull request #4212 from BsAtHome/fix_halcmd-man-formatting
docs: fix halcmd.1 manual page formatting.
2 parents de863df + f926df1 commit 0b47539

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

docs/src/man/man1/halcmd.1.adoc

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ and press tab to complete the names of items such as pins and signals.
6161
== COMMANDS
6262

6363
Commands tell *halcmd* what to do. Normally *halcmd* reads a single
64-
command from the command line and executes it. If the '*-f*' option is
64+
command from the command line and executes it. If the *-f* option is
6565
used to read commands from a file, *halcmd* reads each line of the file
66-
as a new command. Anything following '*#*' on a line is a comment.
66+
as a new command. Anything following *#* on a line is a comment.
6767

6868
*loadrt* _modname_::
6969
(short for "load realtime module")
@@ -74,10 +74,10 @@ In systems with kernel-based realtime support (e.g. RTAI), *halcmd*
7474
calls the *linuxcnc_module_helper* to load realtime modules.
7575
*linuxcnc_module_helper* is a setuid program and is compiled with a
7676
whitelist of modules it is allowed to load. This is currently just a
77-
list of *LinuxCNC*-related modules. The *linuxcnc_module_helper* execs
77+
list of **LinuxCNC**-related modules. The *linuxcnc_module_helper* execs
7878
insmod, so return codes and error messages are those from insmod.
7979
Administrators who wish to restrict which users can load these
80-
*LinuxCNC*-related kernel modules can do this by setting the permissions
80+
**LinuxCNC**-related kernel modules can do this by setting the permissions
8181
and group on *linuxcnc_module_helper* appropriately.
8282

8383
In systems with userspace-based realtime support (e.g. Preempt-RT) and
@@ -95,12 +95,11 @@ requested component with a call to *dlopen(3)*.
9595
(_load_ __Us__e__r__space component) Executes the given
9696
_UNIX-command_, usually to load a non-realtime component. _[flags]_
9797
may be one or more of:
98-
+
99-
* *-W* to wait for the component to become ready.
98+
* *-W* - to wait for the component to become ready.
10099
The component is assumed to have the same name as the first argument of the command.
101-
* *-Wn name* to wait for the component, which will have the given name.
102-
* *-w* to wait for the program to exit
103-
* *-i* to ignore the program return value (with -w)
100+
* *-n* _name_ - to wait for the component, which will have the given name.
101+
* *-w* - to wait for the program to exit
102+
* *-i* - to ignore the program return value (with -w)
104103
*waitusr* _name_::
105104
(_wait_ for __Us__e__r__space component) Waits for non-realtime
106105
component _name_ to disconnect from HAL (usually on exit). The
@@ -268,10 +267,10 @@ If _item_ is omitted (or *all*), *save* does the equivalent of *comp*, *alias*,
268267
or *alias* of the specified type.
269268
*list* _type_ [_pattern_]::
270269
Prints the names of HAL items of the specified type. 'type' is
271-
'*comp*', '*pin*', '*sig*', '*param*', '*funct*', or '*thread*'. If
270+
*comp*, *pin*, *sig*, *param*, *funct*, or *thread*. If
272271
'pattern' is specified it prints only those names that match the
273-
pattern, which may be a 'shell glob'. For '*sig*', '*pin*' and
274-
'*param*', the first pattern may be -t**datatype** where datatype is
272+
pattern, which may be a 'shell glob'. For *sig*, *pin* and
273+
*param*, the first pattern may be -t**datatype** where datatype is
275274
the data type (e.g., 'float') in this case, the listed pins, signals,
276275
or parameters are restricted to the given data type Names are printed
277276
on a single line, space separated.
@@ -285,8 +284,8 @@ If _item_ is omitted (or *all*), *save* does the equivalent of *comp*, *alias*,
285284
Unlocks HAL to some degree. tune - some tuning is possible (*setp* &
286285
such). all - HAL completely unlocked.
287286
*status* [_type_]::
288-
Prints status info about HAL. 'type' is '*lock*', '*mem*', or '*all*'.
289-
If 'type' is omitted, it assumes '*all*'.
287+
Prints status info about HAL. 'type' is *lock*, *mem*, or *all*.
288+
If 'type' is omitted, it assumes *all*.
290289
*debug* [_level_]::
291290
Sets the rtapi messaging level (see man3 rtapi_set_msg_level).
292291
*help* [_command_]::

0 commit comments

Comments
 (0)