use .In for header, remove trailing space
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@13996 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
@@ -1,33 +1,33 @@
|
|||||||
.\" Copyright (c) 2004 Kungliga Tekniska H<>gskolan
|
.\" Copyright (c) 2004 Kungliga Tekniska H<>gskolan
|
||||||
.\" (Royal Institute of Technology, Stockholm, Sweden).
|
.\" (Royal Institute of Technology, Stockholm, Sweden).
|
||||||
.\" All rights reserved.
|
.\" All rights reserved.
|
||||||
.\"
|
.\"
|
||||||
.\" Redistribution and use in source and binary forms, with or without
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
.\" modification, are permitted provided that the following conditions
|
.\" modification, are permitted provided that the following conditions
|
||||||
.\" are met:
|
.\" are met:
|
||||||
.\"
|
.\"
|
||||||
.\" 1. Redistributions of source code must retain the above copyright
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
.\" notice, this list of conditions and the following disclaimer.
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
.\"
|
.\"
|
||||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
.\" notice, this list of conditions and the following disclaimer in the
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
.\" documentation and/or other materials provided with the distribution.
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
.\"
|
.\"
|
||||||
.\" 3. Neither the name of the Institute nor the names of its contributors
|
.\" 3. Neither the name of the Institute nor the names of its contributors
|
||||||
.\" may be used to endorse or promote products derived from this software
|
.\" may be used to endorse or promote products derived from this software
|
||||||
.\" without specific prior written permission.
|
.\" without specific prior written permission.
|
||||||
.\"
|
.\"
|
||||||
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
||||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
||||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
.\" SUCH DAMAGE.
|
.\" SUCH DAMAGE.
|
||||||
.\" $Id$
|
.\" $Id$
|
||||||
.\"
|
.\"
|
||||||
.Dd June 26, 2004
|
.Dd June 26, 2004
|
||||||
@@ -52,7 +52,7 @@
|
|||||||
.Sh LIBRARY
|
.Sh LIBRARY
|
||||||
The roken library (libroken, -lroken)
|
The roken library (libroken, -lroken)
|
||||||
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
||||||
.Fd #include <rtbl.h>
|
.In rtbl.h
|
||||||
.Ft int
|
.Ft int
|
||||||
.Fn rtbl_add_column "rtbl_t table" "const char *column_name" "unsigned int flags"
|
.Fn rtbl_add_column "rtbl_t table" "const char *column_name" "unsigned int flags"
|
||||||
.Ft int
|
.Ft int
|
||||||
@@ -84,7 +84,7 @@ The roken library (libroken, -lroken)
|
|||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
This set of functions assemble a simple table consisting of rows and
|
This set of functions assemble a simple table consisting of rows and
|
||||||
columns, allowing it to be printed with certain options. Typical use
|
columns, allowing it to be printed with certain options. Typical use
|
||||||
would be output from tools such as
|
would be output from tools such as
|
||||||
.Xr ls 1
|
.Xr ls 1
|
||||||
or
|
or
|
||||||
.Xr netstat 1 ,
|
.Xr netstat 1 ,
|
||||||
@@ -97,15 +97,15 @@ and destroyed with
|
|||||||
.Fn rtbl_destroy .
|
.Fn rtbl_destroy .
|
||||||
.Pp
|
.Pp
|
||||||
Global flags on the table are set with
|
Global flags on the table are set with
|
||||||
.Fa rtbl_set_flags
|
.Fa rtbl_set_flags
|
||||||
and retrieved with
|
and retrieved with
|
||||||
.Fa rtbl_get_flags .
|
.Fa rtbl_get_flags .
|
||||||
At present the only defined flag is
|
At present the only defined flag is
|
||||||
.Dv RTBL_HEADER_STYLE_NONE
|
.Dv RTBL_HEADER_STYLE_NONE
|
||||||
which supresses printing the header.
|
which supresses printing the header.
|
||||||
.Pp
|
.Pp
|
||||||
Before adding data to the table, one or more columns need to be
|
Before adding data to the table, one or more columns need to be
|
||||||
created. This would normally be done with
|
created. This would normally be done with
|
||||||
.Fn rtbl_add_column_by_id ,
|
.Fn rtbl_add_column_by_id ,
|
||||||
.Fa column_id
|
.Fa column_id
|
||||||
is any number of your choice (it's used only to identify columns),
|
is any number of your choice (it's used only to identify columns),
|
||||||
@@ -113,7 +113,7 @@ is any number of your choice (it's used only to identify columns),
|
|||||||
is the header to print at the top of the column, and
|
is the header to print at the top of the column, and
|
||||||
.Fa flags
|
.Fa flags
|
||||||
are flags specific to this column. Currently the only defined flag is
|
are flags specific to this column. Currently the only defined flag is
|
||||||
.Dv RTBL_ALIGN_RIGHT ,
|
.Dv RTBL_ALIGN_RIGHT ,
|
||||||
aligning column entries to the right. Columns are printed in the order
|
aligning column entries to the right. Columns are printed in the order
|
||||||
they are added.
|
they are added.
|
||||||
.Pp
|
.Pp
|
||||||
@@ -133,15 +133,15 @@ is whatever string you wish to include in that cell. It should not
|
|||||||
include newlines.
|
include newlines.
|
||||||
For columns added with
|
For columns added with
|
||||||
.Fn rtbl_add_column
|
.Fn rtbl_add_column
|
||||||
you must use
|
you must use
|
||||||
.Fn rtbl_add_column_entry
|
.Fn rtbl_add_column_entry
|
||||||
instead.
|
instead.
|
||||||
.Pp
|
.Pp
|
||||||
.Fn rtbl_new_row
|
.Fn rtbl_new_row
|
||||||
fills all columns with blank entries until they all have the same
|
fills all columns with blank entries until they all have the same
|
||||||
number of rows.
|
number of rows.
|
||||||
.Pp
|
.Pp
|
||||||
Each column can have a separate prefix and suffix, set with
|
Each column can have a separate prefix and suffix, set with
|
||||||
.Fa rtbl_set_column_affix_by_id ;
|
.Fa rtbl_set_column_affix_by_id ;
|
||||||
.Fa rtbl_set_column_prefix
|
.Fa rtbl_set_column_prefix
|
||||||
allows setting the prefix only by column name. In addition to this,
|
allows setting the prefix only by column name. In addition to this,
|
||||||
@@ -194,8 +194,8 @@ Column A Column B Column C
|
|||||||
A-1 B-1 C-1
|
A-1 B-1 C-1
|
||||||
A-2 B-2 C-2
|
A-2 B-2 C-2
|
||||||
A-3 B-3 C-3
|
A-3 B-3 C-3
|
||||||
A-4
|
A-4
|
||||||
B-4
|
B-4
|
||||||
C-4
|
C-4
|
||||||
.Ed
|
.Ed
|
||||||
.\" .Sh SEE ALSO
|
.\" .Sh SEE ALSO
|
||||||
|
Reference in New Issue
Block a user