[src/trunk]: src/share/man/man9 - Stop showing struct rasops_info; readers ca...

[rin <rin%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/b050a5287f3f
branches:  trunk
changeset: 458714:b050a5287f3f
user:      rin <rin%NetBSD.org@localhost>
date:      Wed Aug 07 13:46:02 2019 +0000

description:
- Stop showing struct rasops_info; readers can read the header itself.
- Correct description for optimized font widths.
- Remove strange blank line.

diffstat:

 share/man/man9/rasops.9 |  87 ++++++------------------------------------------
 1 files changed, 11 insertions(+), 76 deletions(-)

diffs (122 lines):

diff -r 285a8ecc5dd9 -r b050a5287f3f share/man/man9/rasops.9
--- a/share/man/man9/rasops.9   Wed Aug 07 13:23:12 2019 +0000
+++ b/share/man/man9/rasops.9   Wed Aug 07 13:46:02 2019 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: rasops.9,v 1.17 2017/07/03 21:28:48 wiz Exp $
+.\"     $NetBSD: rasops.9,v 1.18 2019/08/07 13:46:02 rin Exp $
 .\"
 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -27,7 +27,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd January 13, 2012
+.Dd August 7, 2019
 .Dt RASOPS 9
 .Os
 .Sh NAME
@@ -51,78 +51,7 @@
 The primary data type for using the raster operations is the
 .Em rasops_info
 structure in
-.Pa dev/rasops/rasops.h :
-.Bd -literal
-struct rasops_info {
-
-       /*
-        * These must be filled in by the caller
-        */
-       int     ri_depth;       /* depth in bits */
-       u_char  *ri_bits;       /* ptr to bits */
-       int     ri_width;       /* width (pels) */
-       int     ri_height;      /* height (pels) */
-       int     ri_stride;      /* stride in bytes */
-
-       /*
-        * If you want shadow framebuffer support, point ri_hwbits
-        * to the real framebuffer, and ri_bits to the shadow framebuffer
-        */
-       u_char  *ri_hwbits;
-
-       /*
-        * These can optionally be left zeroed out. If you fill ri_font,
-        * but aren't using wsfont, set ri_wsfcookie to -1.
-        */
-       struct  wsdisplay_font *ri_font;
-       int     ri_wsfcookie;   /* wsfont cookie */
-       void    *ri_hw;         /* driver private data */
-       int     ri_crow;        /* cursor row */
-       int     ri_ccol;        /* cursor column */
-       int     ri_flg;         /* various operational flags */
-
-       /*
-        * These are optional and will default if zero. Meaningless
-        * on depths other than 15, 16, 24 and 32 bits per pel. On
-        * 24 bit displays, ri_{r,g,b}num must be 8.
-        */
-       u_char  ri_rnum;        /* number of bits for red */
-       u_char  ri_gnum;        /* number of bits for green */
-       u_char  ri_bnum;        /* number of bits for blue */
-       u_char  ri_rpos;        /* which bit red starts at */
-       u_char  ri_gpos;        /* which bit green starts at */
-       u_char  ri_bpos;        /* which bit blue starts at */
-
-       /*
-        * These are filled in by rasops_init()
-        */
-       int     ri_emuwidth;    /* width we actually care about */
-       int     ri_emuheight;   /* height we actually care about */
-       int     ri_emustride;   /* bytes per row we actually care about */
-       int     ri_rows;        /* number of rows (characters) */
-       int     ri_cols;        /* number of columns (characters) */
-       int     ri_delta;       /* row delta in bytes */
-       int     ri_pelbytes;    /* bytes per pel (may be zero) */
-       int     ri_fontscale;   /* fontheight * fontstride */
-       int     ri_xscale;      /* fontwidth * pelbytes */
-       int     ri_yscale;      /* fontheight * stride */
-       u_char  *ri_origbits;   /* where screen bits actually start */
-       int     ri_xorigin;     /* where ri_bits begins (x) */
-       int     ri_yorigin;     /* where ri_bits begins (y) */
-       int32_t ri_devcmap[16]; /* color -> framebuffer data */
-
-       /*
-        * The emulops you need to use, and the screen caps for wscons
-        */
-       struct  wsdisplay_emulops ri_ops;
-       int     ri_caps;
-
-       /*
-        * Callbacks so we can share some code
-        */
-       void    (*ri_do_cursor)(struct rasops_info *);
-};
-.Ed
+.Pa dev/rasops/rasops.h .
 .Pp
 Valid values for the
 .Em ri_flg
@@ -173,7 +102,13 @@
 and
 .Fa wantcols
 are the number of rows and columns we'd like.
-In terms of optimization, fonts that are a multiple of 8 pixels wide
+In terms of optimization, bitmap fonts of width
+.Bl -item -offset indent -compact
+.It
+8 or 16 (all depths)
+.It
+12 (depths other than 1)
+.El
 work the best.
 .It Fn rasops_reconfig "ri" "wantrows" "wantcols"
 Reconfigure a
@@ -186,7 +121,7 @@
 are the number of rows and columns we'd like.
 Passing zero for either one of
 them uses the default - normally 80x25 but it can be changed with
-.Bd -literal -offset indent
+.Bd -literal -offset indent -compact
 options RASOPS_DEFAULT_WIDTH=80
 options RASOPS_DEFAULT_HEIGHT=25
 .Ed