Mechanically kill hard sentence breaks.
This commit is contained in:
parent
69cc5b91a0
commit
f97d4ddfed
@ -143,17 +143,20 @@
|
|||||||
The dialog library attempts to provide a fairly simplistic set of
|
The dialog library attempts to provide a fairly simplistic set of
|
||||||
fixed-presentation menus, input boxes, gauges, file requestors and
|
fixed-presentation menus, input boxes, gauges, file requestors and
|
||||||
other general purpose GUI (a bit of a stretch, since it uses
|
other general purpose GUI (a bit of a stretch, since it uses
|
||||||
ncurses) objects. Since the library also had its roots in a
|
ncurses) objects.
|
||||||
|
Since the library also had its roots in a
|
||||||
shell-script writer's utility (see the
|
shell-script writer's utility (see the
|
||||||
.Xr dialog 1
|
.Xr dialog 1
|
||||||
command), the
|
command), the
|
||||||
early API was somewhat primitively based on strings being passed in or
|
early API was somewhat primitively based on strings being passed in or
|
||||||
out and parsed. This API was later extended to take either the
|
out and parsed.
|
||||||
|
This API was later extended to take either the
|
||||||
original arguments or arrays of
|
original arguments or arrays of
|
||||||
.Va dialogMenuItem
|
.Va dialogMenuItem
|
||||||
structures,
|
structures,
|
||||||
giving the user much more control over the internal behavior of each
|
giving the user much more control over the internal behavior of each
|
||||||
control. The
|
control.
|
||||||
|
The
|
||||||
.Va dialogMenuItem
|
.Va dialogMenuItem
|
||||||
structure internals are public:
|
structure internals are public:
|
||||||
.Bd -literal -offset indent
|
.Bd -literal -offset indent
|
||||||
@ -183,12 +186,14 @@ display and action hooks (the
|
|||||||
.Dv data
|
.Dv data
|
||||||
variable being available for
|
variable being available for
|
||||||
the convenience of those hooks) when more tightly coupled feedback between
|
the convenience of those hooks) when more tightly coupled feedback between
|
||||||
a menu object and user code is required. The
|
a menu object and user code is required.
|
||||||
|
The
|
||||||
.Va selected
|
.Va selected
|
||||||
hook also
|
hook also
|
||||||
allows you to verify whether or not a given item is selected (the cursor is
|
allows you to verify whether or not a given item is selected (the cursor is
|
||||||
over it) for implementing pretty much any possible context-sensitive
|
over it) for implementing pretty much any possible context-sensitive
|
||||||
behavior. A number of clever tricks for simulating various kinds of item
|
behavior.
|
||||||
|
A number of clever tricks for simulating various kinds of item
|
||||||
types can also be done by adjusting the values of
|
types can also be done by adjusting the values of
|
||||||
.Va lbra
|
.Va lbra
|
||||||
(default: '['),
|
(default: '['),
|
||||||
@ -227,7 +232,8 @@ The following flags are in the upper 16 bits of return status:
|
|||||||
.Pp
|
.Pp
|
||||||
Two special globals also exist for putting a dialog at any arbitrary
|
Two special globals also exist for putting a dialog at any arbitrary
|
||||||
X,Y location (the early designers rather short-sightedly made no provisions
|
X,Y location (the early designers rather short-sightedly made no provisions
|
||||||
for this). If set to zero, the default centering behavior will be in
|
for this).
|
||||||
|
If set to zero, the default centering behavior will be in
|
||||||
effect.
|
effect.
|
||||||
.Pp
|
.Pp
|
||||||
Below is a short description of the various functions:
|
Below is a short description of the various functions:
|
||||||
@ -287,7 +293,8 @@ The
|
|||||||
.Fn dialog_create_rc
|
.Fn dialog_create_rc
|
||||||
function dumps dialog library settings into
|
function dumps dialog library settings into
|
||||||
.Pa filename
|
.Pa filename
|
||||||
for later retrieval as defaults. Returns 0 on success, -1 on failure.
|
for later retrieval as defaults.
|
||||||
|
Returns 0 on success, -1 on failure.
|
||||||
.Pp
|
.Pp
|
||||||
The
|
The
|
||||||
.Fn dialog_yesno
|
.Fn dialog_yesno
|
||||||
@ -308,7 +315,8 @@ The default selection is
|
|||||||
.Em Yes .
|
.Em Yes .
|
||||||
If the
|
If the
|
||||||
.Em Yes
|
.Em Yes
|
||||||
button is chosen, return FALSE. If
|
button is chosen, return FALSE.
|
||||||
|
If
|
||||||
.Em \&No ,
|
.Em \&No ,
|
||||||
return TRUE.
|
return TRUE.
|
||||||
.Pp
|
.Pp
|
||||||
@ -338,7 +346,8 @@ otherwise it is simply passed to
|
|||||||
If
|
If
|
||||||
.Va pause
|
.Va pause
|
||||||
is TRUE, a final confirmation requestor will be put up when execution
|
is TRUE, a final confirmation requestor will be put up when execution
|
||||||
terminates. Returns 0 on success, -1 on failure.
|
terminates.
|
||||||
|
Returns 0 on success, -1 on failure.
|
||||||
.Pp
|
.Pp
|
||||||
The
|
The
|
||||||
.Fn dialog_textbox
|
.Fn dialog_textbox
|
||||||
@ -362,7 +371,8 @@ The
|
|||||||
and
|
and
|
||||||
.Va it
|
.Va it
|
||||||
arguments are of particular importance since they,
|
arguments are of particular importance since they,
|
||||||
together, determine which of the 2 available APIs to use. To use the
|
together, determine which of the 2 available APIs to use.
|
||||||
|
To use the
|
||||||
older and traditional interface,
|
older and traditional interface,
|
||||||
.Va cnt
|
.Va cnt
|
||||||
should be a positive
|
should be a positive
|
||||||
@ -374,7 +384,8 @@ the strings are
|
|||||||
expected to be in prompt and title order for each item and the
|
expected to be in prompt and title order for each item and the
|
||||||
.Va result
|
.Va result
|
||||||
parameter is expected to point to an array where the
|
parameter is expected to point to an array where the
|
||||||
prompt string of the item selected will be copied. To use the newer
|
prompt string of the item selected will be copied.
|
||||||
|
To use the newer
|
||||||
interface,
|
interface,
|
||||||
.Va cnt
|
.Va cnt
|
||||||
should be a
|
should be a
|
||||||
@ -385,11 +396,13 @@ structures pointed to by
|
|||||||
.Va it
|
.Va it
|
||||||
(which should be of type
|
(which should be of type
|
||||||
.Vt dialogMenuItem "*" ) ,
|
.Vt dialogMenuItem "*" ) ,
|
||||||
one structure per item. In the new interface, the
|
one structure per item.
|
||||||
|
In the new interface, the
|
||||||
.Va result
|
.Va result
|
||||||
variable is used as a simple boolean (not a pointer) and should be NULL if
|
variable is used as a simple boolean (not a pointer) and should be NULL if
|
||||||
.Va it
|
.Va it
|
||||||
only points to menu items and the default OK and Cancel buttons are desired. If
|
only points to menu items and the default OK and Cancel buttons are desired.
|
||||||
|
If
|
||||||
.Va result
|
.Va result
|
||||||
is non-NULL, then
|
is non-NULL, then
|
||||||
.Va it
|
.Va it
|
||||||
@ -427,7 +440,8 @@ The
|
|||||||
and
|
and
|
||||||
.Va it
|
.Va it
|
||||||
arguments are of particular importance since they,
|
arguments are of particular importance since they,
|
||||||
together, determine which of the 2 available APIs to use. To use the
|
together, determine which of the 2 available APIs to use.
|
||||||
|
To use the
|
||||||
older and traditional interface,
|
older and traditional interface,
|
||||||
.Va cnt
|
.Va cnt
|
||||||
should be a positive
|
should be a positive
|
||||||
@ -441,7 +455,8 @@ each item and the
|
|||||||
.Va result
|
.Va result
|
||||||
parameter is expected to point to an
|
parameter is expected to point to an
|
||||||
array where the prompt string of the item(s) selected will be
|
array where the prompt string of the item(s) selected will be
|
||||||
copied. To use the newer interface,
|
copied.
|
||||||
|
To use the newer interface,
|
||||||
.Va cnt
|
.Va cnt
|
||||||
should be a
|
should be a
|
||||||
.Em negative
|
.Em negative
|
||||||
@ -451,14 +466,16 @@ structures pointed to by
|
|||||||
.Va it
|
.Va it
|
||||||
(which should be of type
|
(which should be of type
|
||||||
.Ft "dialogMenuItem *" ) ,
|
.Ft "dialogMenuItem *" ) ,
|
||||||
one structure per item. In the new interface,
|
one structure per item.
|
||||||
|
In the new interface,
|
||||||
the
|
the
|
||||||
.Va result
|
.Va result
|
||||||
variable is used as a simple boolean (not a pointer)
|
variable is used as a simple boolean (not a pointer)
|
||||||
and should be NULL if
|
and should be NULL if
|
||||||
.Va it
|
.Va it
|
||||||
only points to menu items and the default OK and Cancel
|
only points to menu items and the default OK and Cancel
|
||||||
buttons are desired. If
|
buttons are desired.
|
||||||
|
If
|
||||||
.Va result
|
.Va result
|
||||||
is non-NULL, then
|
is non-NULL, then
|
||||||
.Va it
|
.Va it
|
||||||
@ -477,7 +494,8 @@ actions are used to override the default behavior, and
|
|||||||
to the same for the OK button.
|
to the same for the OK button.
|
||||||
.Pp
|
.Pp
|
||||||
In the standard API model, the menu supports the selection of multiple items,
|
In the standard API model, the menu supports the selection of multiple items,
|
||||||
each of which is marked with an `X' character to denote selection. When
|
each of which is marked with an `X' character to denote selection.
|
||||||
|
When
|
||||||
the OK button is selected, the prompt values for all items selected are
|
the OK button is selected, the prompt values for all items selected are
|
||||||
concatenated into the
|
concatenated into the
|
||||||
.Va result
|
.Va result
|
||||||
@ -488,7 +506,8 @@ In the new API model, it is not actually necessary to preserve
|
|||||||
each item is displayed or marked as "selected" is fully configurable.
|
each item is displayed or marked as "selected" is fully configurable.
|
||||||
You could have a single checklist menu that actually contained a group
|
You could have a single checklist menu that actually contained a group
|
||||||
of items with "radio" behavior, "checklist" behavior and standard menu
|
of items with "radio" behavior, "checklist" behavior and standard menu
|
||||||
item behavior. The only reason to call
|
item behavior.
|
||||||
|
The only reason to call
|
||||||
.Fn dialog_checklist
|
.Fn dialog_checklist
|
||||||
over
|
over
|
||||||
.Fn dialog_radiolist
|
.Fn dialog_radiolist
|
||||||
@ -511,7 +530,8 @@ The
|
|||||||
and
|
and
|
||||||
.Va it
|
.Va it
|
||||||
arguments are of particular importance since they,
|
arguments are of particular importance since they,
|
||||||
together, determine which of the 2 available APIs to use. To use the
|
together, determine which of the 2 available APIs to use.
|
||||||
|
To use the
|
||||||
older and traditional interface,
|
older and traditional interface,
|
||||||
.Va cnt
|
.Va cnt
|
||||||
should be a positive
|
should be a positive
|
||||||
@ -525,7 +545,8 @@ each item and the
|
|||||||
.Va result
|
.Va result
|
||||||
parameter is expected to point to an
|
parameter is expected to point to an
|
||||||
array where the prompt string of the item(s) selected will be
|
array where the prompt string of the item(s) selected will be
|
||||||
copied. To use the newer interface,
|
copied.
|
||||||
|
To use the newer interface,
|
||||||
.Va cnt
|
.Va cnt
|
||||||
should be a
|
should be a
|
||||||
.Dv negative
|
.Dv negative
|
||||||
@ -535,14 +556,16 @@ structures pointed to by
|
|||||||
.Va it
|
.Va it
|
||||||
(which should be of type
|
(which should be of type
|
||||||
.Ft "dialogMenuItem *" ,
|
.Ft "dialogMenuItem *" ,
|
||||||
one structure per item. In the new interface,
|
one structure per item.
|
||||||
|
In the new interface,
|
||||||
the
|
the
|
||||||
.Va result
|
.Va result
|
||||||
variable is used as a simple boolean (not a pointer)
|
variable is used as a simple boolean (not a pointer)
|
||||||
and should be NULL if
|
and should be NULL if
|
||||||
.Va it
|
.Va it
|
||||||
only points to menu items and the default OK and Cancel
|
only points to menu items and the default OK and Cancel
|
||||||
buttons are desired. If
|
buttons are desired.
|
||||||
|
If
|
||||||
.Va result
|
.Va result
|
||||||
is non-NULL, then
|
is non-NULL, then
|
||||||
.Va it
|
.Va it
|
||||||
@ -561,7 +584,8 @@ does the same for the traditional OK button.
|
|||||||
.Pp
|
.Pp
|
||||||
In the standard API model, the menu supports the selection of only one
|
In the standard API model, the menu supports the selection of only one
|
||||||
of multiple items, the currently active item marked with an `*'
|
of multiple items, the currently active item marked with an `*'
|
||||||
character to denote selection. When the OK button is selected, the
|
character to denote selection.
|
||||||
|
When the OK button is selected, the
|
||||||
prompt value for this item is copied into the
|
prompt value for this item is copied into the
|
||||||
.Va result
|
.Va result
|
||||||
string.
|
string.
|
||||||
@ -571,7 +595,8 @@ In the new API model, it is not actually necessary to preserve
|
|||||||
each item is displayed or marked as "selected" is fully configurable.
|
each item is displayed or marked as "selected" is fully configurable.
|
||||||
You could have a single radio menu that actually contained a group
|
You could have a single radio menu that actually contained a group
|
||||||
of items with "checklist" behavior, "radio" behavior and standard menu
|
of items with "checklist" behavior, "radio" behavior and standard menu
|
||||||
item behavior. The only reason to call
|
item behavior.
|
||||||
|
The only reason to call
|
||||||
.Fn dialog_radiolist
|
.Fn dialog_radiolist
|
||||||
over
|
over
|
||||||
.Fn dialog_checklistlist
|
.Fn dialog_checklistlist
|
||||||
@ -635,7 +660,8 @@ Returns 0 on success, -1 on failure.
|
|||||||
.Pp
|
.Pp
|
||||||
The
|
The
|
||||||
.Fn dialog_gauge
|
.Fn dialog_gauge
|
||||||
function displays a horizontal bar-graph style gauge. A value of
|
function displays a horizontal bar-graph style gauge.
|
||||||
|
A value of
|
||||||
.Em 100
|
.Em 100
|
||||||
for
|
for
|
||||||
.Em perc
|
.Em perc
|
||||||
@ -701,7 +727,8 @@ and
|
|||||||
are positive numbers, they set the absolute
|
are positive numbers, they set the absolute
|
||||||
size of the whole
|
size of the whole
|
||||||
.Fn dialog_ftree
|
.Fn dialog_ftree
|
||||||
box. If
|
box.
|
||||||
|
If
|
||||||
.Va height
|
.Va height
|
||||||
and
|
and
|
||||||
.Va width
|
.Va width
|
||||||
@ -721,7 +748,8 @@ is shown inside the
|
|||||||
.Fn dialog_ftree
|
.Fn dialog_ftree
|
||||||
box above the tree subwindow and can contain
|
box above the tree subwindow and can contain
|
||||||
.Ql \e\&n
|
.Ql \e\&n
|
||||||
to split lines. One can navigate in
|
to split lines.
|
||||||
|
One can navigate in
|
||||||
the tree by pressing UP/DOWN or
|
the tree by pressing UP/DOWN or
|
||||||
.Sm off
|
.Sm off
|
||||||
.So \&+ Sc \&/ So \&- Sc ,
|
.So \&+ Sc \&/ So \&- Sc ,
|
||||||
@ -737,23 +765,29 @@ HOME/END or
|
|||||||
.Sm on
|
.Sm on
|
||||||
A leaf of the
|
A leaf of the
|
||||||
tree is selected by pressing TAB or LEFT/RIGHT the OK
|
tree is selected by pressing TAB or LEFT/RIGHT the OK
|
||||||
button and pressing ENTER. filename may contain data like
|
button and pressing ENTER.
|
||||||
|
filename may contain data like
|
||||||
.Xr find 1
|
.Xr find 1
|
||||||
output, as well as like the output of
|
output, as well as like the output of
|
||||||
.Xr find 1
|
.Xr find 1
|
||||||
with
|
with
|
||||||
.Fl d
|
.Fl d
|
||||||
option. Some of the transient paths to the leaves of the tree may
|
option.
|
||||||
be absent. Such data is corrected when fed from filename.
|
Some of the transient paths to the leaves of the tree may
|
||||||
|
be absent.
|
||||||
|
Such data is corrected when fed from filename.
|
||||||
.Pp
|
.Pp
|
||||||
The function returns 0 and a pointer to the selected leaf (to the path to
|
The function returns 0 and a pointer to the selected leaf (to the path to
|
||||||
the leaf from the root of the tree) into result, if the OK button was
|
the leaf from the root of the tree) into result, if the OK button was
|
||||||
selected. The memory allocated for the building of the tree is freed on
|
selected.
|
||||||
|
The memory allocated for the building of the tree is freed on
|
||||||
exiting
|
exiting
|
||||||
.Fn dialog_ftree .
|
.Fn dialog_ftree .
|
||||||
The memory for the result line should be freed
|
The memory for the result line should be freed
|
||||||
later manually, if necessary. If the Cancel button was selected, the
|
later manually, if necessary.
|
||||||
function returns 1. In case of exiting
|
If the Cancel button was selected, the
|
||||||
|
function returns 1.
|
||||||
|
In case of exiting
|
||||||
.Fn dialog_ftree
|
.Fn dialog_ftree
|
||||||
on ESC, the function returns -1.
|
on ESC, the function returns -1.
|
||||||
.Pp
|
.Pp
|
||||||
|
@ -32,19 +32,23 @@
|
|||||||
.Ar name ...
|
.Ar name ...
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
.Nm Man
|
.Nm Man
|
||||||
formats and displays the on-line manual pages. This version knows
|
formats and displays the on-line manual pages.
|
||||||
|
This version knows
|
||||||
about the
|
about the
|
||||||
.Ev MANPATH
|
.Ev MANPATH
|
||||||
and
|
and
|
||||||
.Ev PAGER
|
.Ev PAGER
|
||||||
environment variables, so you can have
|
environment variables, so you can have
|
||||||
your own set(s) of personal man pages and choose whatever program you
|
your own set(s) of personal man pages and choose whatever program you
|
||||||
like to display the formatted pages. If section is specified,
|
like to display the formatted pages.
|
||||||
|
If section is specified,
|
||||||
.Nm
|
.Nm
|
||||||
only looks in that section of the manual. You may also specify the
|
only looks in that section of the manual.
|
||||||
|
You may also specify the
|
||||||
order to search the sections for entries and which preprocessors to
|
order to search the sections for entries and which preprocessors to
|
||||||
run on the source files via command line options or environment
|
run on the source files via command line options or environment
|
||||||
variables. If enabled by the system administrator, formatted man
|
variables.
|
||||||
|
If enabled by the system administrator, formatted man
|
||||||
pages will also be compressed with the `%compress%' command to save
|
pages will also be compressed with the `%compress%' command to save
|
||||||
space.
|
space.
|
||||||
.Pp
|
.Pp
|
||||||
@ -59,7 +63,8 @@ uses
|
|||||||
(which is built into the
|
(which is built into the
|
||||||
.Nm
|
.Nm
|
||||||
binary)
|
binary)
|
||||||
to determine the path to search. This option overrides the
|
to determine the path to search.
|
||||||
|
This option overrides the
|
||||||
.Ev MANPATH
|
.Ev MANPATH
|
||||||
environment variable.
|
environment variable.
|
||||||
.It Fl P Ar pager
|
.It Fl P Ar pager
|
||||||
@ -80,7 +85,8 @@ environment variable.
|
|||||||
By default,
|
By default,
|
||||||
.Nm
|
.Nm
|
||||||
will exit after displaying the first manual page it
|
will exit after displaying the first manual page it
|
||||||
finds. Using this option forces
|
finds.
|
||||||
|
Using this option forces
|
||||||
.Nm
|
.Nm
|
||||||
to display all the manual pages
|
to display all the manual pages
|
||||||
that match
|
that match
|
||||||
@ -208,7 +214,8 @@ is set, its value is used as the path to search for manual pages.
|
|||||||
If
|
If
|
||||||
.Ev MANROFFSEQ
|
.Ev MANROFFSEQ
|
||||||
is set, its value is used to determine the set of preprocessors run
|
is set, its value is used to determine the set of preprocessors run
|
||||||
before running nroff or troff. By default, pages are passed through
|
before running nroff or troff.
|
||||||
|
By default, pages are passed through
|
||||||
the table preprocessor before nroff.
|
the table preprocessor before nroff.
|
||||||
.It Ev MANSECT
|
.It Ev MANSECT
|
||||||
If
|
If
|
||||||
@ -218,7 +225,8 @@ is set, its value is used to determine which manual sections to search.
|
|||||||
If
|
If
|
||||||
.Ev PAGER
|
.Ev PAGER
|
||||||
is set, its value is used as the name of the program to use to display
|
is set, its value is used as the name of the program to use to display
|
||||||
the man page. By default,
|
the man page.
|
||||||
|
By default,
|
||||||
.Nm %pager%
|
.Nm %pager%
|
||||||
is used.
|
is used.
|
||||||
.El
|
.El
|
||||||
|
@ -440,7 +440,7 @@ archive).
|
|||||||
To archive all files from the directory
|
To archive all files from the directory
|
||||||
.Pa srcdir ,
|
.Pa srcdir ,
|
||||||
which were modified
|
which were modified
|
||||||
after Feb. 9th 1997, 13:00 h, use
|
after Feb.\& 9th 1997, 13:00 h, use
|
||||||
.Dl "tar -c -f backup.tar --newer-mtime 'Feb 9 13:15 1997' srcdir/"
|
.Dl "tar -c -f backup.tar --newer-mtime 'Feb 9 13:15 1997' srcdir/"
|
||||||
.Pp
|
.Pp
|
||||||
Other possible time specifications are
|
Other possible time specifications are
|
||||||
|
Loading…
x
Reference in New Issue
Block a user