Add riscv-sim.exp
[dejagnu.git] / doc / dejagnu-help.1
blob110da928116ed8bd40cf85738947d9f81d137bea
1 .\" Copyright (C), 2018  Free Software Foundation, Inc.
2 .\" You may distribute this file under the terms of the GNU Free
3 .\" Documentation License.
4 .Dd December 19, 2018
5 .Os GNU
6 .Dt DEJAGNU-HELP 1 URM
7 .Sh NAME
8 .Nm dejagnu\ help
9 .Nd display manual pages for DejaGnu auxiliary commands
10 .Sh SYNOPSIS
11 .Nm dejagnu\ help
12 .Op Ar options...
13 .Ao Ar command Ac
14 .Sh DESCRIPTION
15 The
16 .Nm
17 command displays long-form documentation for DejaGnu auxiliary commands.
18 .Sh OPTIONS
19 .Bl -tag -width ".Fl v , -verbose"
20 .It Fl v , -verbose
21 Emit additional output describing the operation of
22 .Nm
23 itself.
24 .It Fl w , -path
25 This option is simply passed on to
26 .Nm man .
27 .It Fl W
28 This option is simply passed on to
29 .Nm man .
30 .El
31 .Sh FILES
32 The
33 .Nm
34 command checks for man pages in a
35 .Pa doc/
36 directory next to the
37 .Pa commands/
38 directory where this script is located.
39 If the page is found there, a full file name is given to
40 .Nm man .
41 Otherwise, only the command name is given and the search described in
42 .Xr man 1
43 is performed.
44 .Sh SEE ALSO
45 .Xr man 1
46 .Sh AUTHORS
47 Jacob Bachmeyer
48 .Sh BUGS
49 Currently only supports man pages.
50 .\"  LocalWords:  Dt URM Nm DejaGnu Ao Xr