From 531d985fa9298376a7cd844a844282ddc826d86f Mon Sep 17 00:00:00 2001
From: Elan Amir <elan@ucbvax.Berkeley.EDU>
Date: Fri, 15 Jan 1993 01:07:23 -0800
Subject: [PATCH] \*m -> \(dg. Made functions ANSI style declarations.

SCCS-vsn: lib/libcurses/PSD.doc/fns.doc 1.2
---
 usr/src/lib/libcurses/PSD.doc/fns.doc | 311 ++++++++------------------
 1 file changed, 93 insertions(+), 218 deletions(-)

diff --git a/usr/src/lib/libcurses/PSD.doc/fns.doc b/usr/src/lib/libcurses/PSD.doc/fns.doc
index 0fb01be66d..91fa3a430c 100644
--- a/usr/src/lib/libcurses/PSD.doc/fns.doc
+++ b/usr/src/lib/libcurses/PSD.doc/fns.doc
@@ -3,11 +3,10 @@
 .\"
 .\" %sccs.include.redist.roff%
 .\"
-.\"     @(#)fns.doc	1.1 (Berkeley) %G%
+.\"     @(#)fns.doc	1.2 (Berkeley) %G%
 .\"
 .Ds
-.Fd addch ch \*m
-char	ch;
+.Fn addch "char ch" \(dg
 .De
 Add the character
 .Vn ch
@@ -31,8 +30,7 @@ in the normal tabstop positions of
 every eight characters.
 \*(Es
 .Ds
-.Fd addstr str \*m
-char	*str;
+.Fn addstr "char *str" \(dg
 .De
 Add the string pointed to by
 .Vn str
@@ -40,7 +38,7 @@ on the window at the current \*y.
 \*(Es
 In this case, it will put on as much as it can.
 .Ds
-.Fd baudrate "" \*m
+.Fn baudrate "" \(dg
 .De
 Returns the output baud rate of the terminal.
 This is a system dependent constant
@@ -50,9 +48,7 @@ on BSD systems,
 which is included by
 .b <curses.h> ).
 .Ds
-.Fd box win\*,vert\*,hor
-WINDOW	*win;
-char	vert\*,hor;
+.Fn box "WINDOW win" "char vert" "char hor"
 .De
 .Pp
 Draws a box around the window using
@@ -64,11 +60,11 @@ If scrolling is not allowed,
 and the window encompasses the lower right-hand corner of the terminal,
 the corners are left blank to avoid a scroll.
 .Ds
-.Fd cbreak "" \*m
+.Fn cbreak "" \(dg
 .De
 Set or the terminal to cbreak mode.
 .Ds
-.Fd clear "" \*m
+.Fn clear "" \(dg
 .De
 Resets the entire window to blanks.
 If
@@ -82,9 +78,7 @@ call.
 This also moves the current \*y
 to (0\*,0).
 .Ds
-.Fd clearok scr\*,boolf \*m
-WINDOW	*scr;
-int	boolf;
+.Fn clearok "WINDOW *scr" "int boolf" \(dg
 .De
 Sets the clear flag for the screen
 .Vn scr .
@@ -112,19 +106,19 @@ even if the window passed to
 .Fn refresh
 is not a screen.
 .Ds
-.Fd clrtobot "" \*m
+.Fn clrtobot "" \(dg
 .De
 Wipes the window clear from the current \*y to the bottom.
 This does not force a clear-screen sequence on the next refresh
 under any circumstances.
 \*(Nm
 .Ds
-.Fd clrtoeol "" \*m
+.Fn clrtoeol "" \(dg
 .De
 Wipes the window clear from the current \*y to the end of the line.
 \*(Nm
 .Ds
-.Fd crmode "" \*m
+.Fn crmode "" \(dg
 .De
 Identical to 
 .Fn cbreak .
@@ -135,21 +129,20 @@ and
 is retained for backwards compatibility
 with ealier versions of the library.
 .Ds
-.Fd delch
+.Fn delch ""
 .De
 Delete the character at the current \*y.
 Each character after it on the line shifts to the left,
 and the last character becomes blank.
 .Ds
-.Fd deleteln
+.Fn deleteln ""
 .De
 Delete the current line.
 Every line below the current one will move up,
 and the bottom line will become blank.
 The current \*y will remain unchanged.
 .Ds
-.Fd delwin win
-WINDOW	*win;
+.Fn delwin "WINDOW *win"
 .De
 Deletes the window from existence.
 All resources are freed for future use by
@@ -164,11 +157,11 @@ Therefore,
 subwindows should be deleted before their
 outer windows are.
 .Ds
-.Fd echo "" \*m
+.Fn echo "" \(dg
 .De
 Sets the terminal to echo characters.
 .Ds
-.Fd endwin
+.Fn endwin ""
 .De
 Finish up window routines before exit.
 This restores the terminal to the state it was before
@@ -185,7 +178,7 @@ This is especially useful for resetting tty stats
 when trapping rubouts via
 .b signal (2).
 .Ds
-.Fd erase "" \*m
+.Fn erase "" \(dg
 .De
 Erases the window to blanks without setting the clear flag.
 This is analagous to
@@ -195,16 +188,14 @@ on a
 .Fn refresh .
 \*(Nm
 .Ds
-.Fd erasechar "" \*m
+.Fn erasechar "" \(dg
 .De
 Returns the erase character
 for the terminal,
 .i i.e. ,
 the character used by the user to erase a single character from the input.
 .Ds
-.Fd flushok win\*,boolf \*m
-WINDOW	*win;
-int	boolf;
+.Fn flushok "WINDOW *win" "int boolf"
 .De
 Normally,
 .Fn refresh
@@ -224,8 +215,7 @@ it will do the
 if it is FALSE.
 it will not.
 .Ds
-.Fd fullname termbuf\*,name
-char	*termbuf\*,*name;
+.Fn fullname "char *termbuf"  "char *name"
 .De
 .Fn longname
 fills in
@@ -248,8 +238,7 @@ is the same as
 except that it gives the fullest name given in the entry,
 which can be quite verbose.
 .Ds
-.Fd getcap str "" "char *"
-char	*str;
+.Fn getcap "char *str"
 .De
 Return a pointer to the
 .b termcap
@@ -259,7 +248,7 @@ capability described by
 .b termcap (5)
 for details).
 .Ds
-.Fd getch "" \*m
+.Fn getch "" \(dg
 .De
 Gets a character from the terminal and (if necessary)
 echos it on the window.
@@ -281,8 +270,7 @@ whatever routine you call to read characters will set
 for you,
 and then reset to the original mode when finished.
 .Ds
-.Fd getstr str \*m
-char	*str;
+.Fn getstr "char *str" \(dg
 .De
 Get a string through the window
 and put it in the location pointed to by
@@ -292,21 +280,19 @@ It sets tty modes if necessary,
 and then calls
 .Fn getch
 (or
-.Fn wgetch ) "" win
+.Fn wgetch )
 to get the characters needed to fill in the string
 until a newline or EOF is encountered.
 The newline stripped off the string.
 \*(Es
 .Ds
-.Fd gettmode
+.Fn gettmode ""
 .De
 Get the tty stats.
 This is normally called by
 .Fn initscr .
 .Ds
-.Fd getyx win\*,y\*,x \*m
-WINDOW	*win;
-int	y\*,x;
+.Fn getyx "WINDOW *win" "int y" "int x"
 .De
 Puts the current \*y of
 .Vn win
@@ -322,9 +308,7 @@ of
 and
 .Vn x .
 .Ds
-.Fd idlok win\*,boolf
-WINDOW	*win;
-int	boolf;
+.Fn idlok "WINDOW *win" "int boolf"
 .De
 Reserved for future use.
 This will eventually signal to
@@ -332,12 +316,12 @@ This will eventually signal to
 that it is all right to use the insert and delete line sequences
 when updating the window.
 .Ds
-.Fd inch "" \*m
+.Fn inch "" \(dg
 .De
 Returns the character at the current position on the given window.
 This does not make any changes to the window.
 .Ds
-.Fd initscr
+.Fn initscr ""
 .De
 Initialize the screen routines.
 This must be called before any of the screen routines are used.
@@ -362,8 +346,7 @@ otherwise it is taken from the
 .b termcap
 description.
 .Ds
-.Fd insch c
-char	c;
+.Fn insch "char c"
 .De
 Insert
 .Vn c
@@ -372,7 +355,7 @@ Each character after it shifts to the right,
 and the last character disappears.
 \*(Es
 .Ds
-.Fd insertln
+.Fn insertln ""
 .De
 Insert a line above the current one.
 Every line below the current line
@@ -381,16 +364,14 @@ and the bottom line will disappear.
 The current line will become blank,
 and the current \*y will remain unchanged.
 .Ds
-.Fd killchar "" \*m
+.Fn killchar "" \(dg
 .De
 Returns the line kill character
 for the terminal,
 .i i.e. ,
 the character used by the user to erase an entire line from the input.
 .Ds
-.Fd leaveok win\*,boolf \*m
-WINDOW	*win;
-int	boolf;
+.Fn leaveok "WINDOW *win" "int boolf" \(dg
 .De
 Sets the boolean flag for leaving the cursor after the last change.
 If
@@ -406,19 +387,16 @@ This flag
 (initialy FALSE)
 retains its value until changed by the user.
 .Ds
-.Fd longname termbuf\*,name
-char	*termbuf\*,*name;
+.Fn longname "char *termbuf" "char *name"
 .De
 .Ds
-.Fd move y\*,x \*m
-int	y\*,x;
+.Fn move "int y" "int x"
 .De
 Change the current \*y of the window to
 .Vn y\*,x ). (
 \*(Es
 .Ds
-.Fd mvcur lasty\*,lastx\*,newy\*,newx
-int	lasty\*,lastx\*,newy\*,newx;
+.Fn mvcur "int lasty" "int lastx" "int newy" "int newx"
 .De
 Moves the terminal's cursor from
 .Vn lasty\*,lastx ) (
@@ -437,9 +415,7 @@ and
 should be used to move the cursor position,
 so that the routines know what's going on.
 .Ds
-.Fd mvwin win\*,y\*,x
-WINDOW	*win;
-int	y, x;
+.Fn mvwin "WINDOW *win" "int y" "int x"
 .De
 Move the home position of the window
 .Vn win
@@ -456,8 +432,8 @@ also returns ERR if you attempt to move it off its main window.
 If you move a main window,
 all subwindows are moved along with it.
 .Ds
-.Fd newwin lines\*,cols\*,begin\*_y\*,begin\*_x "" "WINDOW *"
-int     lines\*,cols\*,begin\*_y\*,begin\*_x;
+.Ft "WINDOW *"
+.Fn newwin "int lines" "int cols" "int begin_y" "int begin_x" 
 .De
 Create a new window with
 .Vn lines
@@ -480,9 +456,9 @@ Thus, to get a new window of dimensions
 \(mu
 .Vn COLS ,
 use
-.Fn newwin . "" 0\*,0\*,0\*,0
+.Fn newwin 0 0 0 0 .
 .Ds
-.Fd nl "" \*m
+.Fn nl "" \(dg
 .De
 Set the terminal to nl mode,
 .i i.e. ,
@@ -495,11 +471,11 @@ If the mapping is not done,
 can do more optimization,
 so it is recommended, but not required, to turn it off.
 .Ds
-.Fd nocbreak "" \*m
+.Fn nocbreak "" \(dg
 .De
 Unset the terminal from cbreak mode.
 .Ds
-.Fd nocrmode "" \*m
+.Fn nocrmode "" \(dg
 .De
 Identical to
 .Fn nocbreak .
@@ -508,22 +484,21 @@ The misnamed macro
 is retained for backwards compatibility
 with ealier versions of the library.
 .Ds
-.Fd noecho "" \*m
+.Fn noecho "" \(dg
 .De
 Turn echoing of characters off.
 .Ds
-.Fd nonl "" \*m
+.Fn nonl "" \(dg
 .De
 Unset the terminal to from nl mode.  See 
 .Fn nl .
 .Ds
-.Fd noraw "" \*m
+.Fn noraw "" \(dg
 .De
 Unset the terminal from raw mode.  See 
 .Fn raw .
 .Ds
-.Fd overlay win1\*,win2
-WINDOW	*win1\*,*win2;
+.Fn overlay "WINDOW *win1" "WINDOW *win2"
 .De
 Overlay
 .Vn win1
@@ -542,8 +517,7 @@ leave the contents of the space on
 .Vn win2
 untouched.
 .Ds
-.Fd overwrite win1\*,win2
-WINDOW	*win1\*,*win2;
+.Fn overwrite "WINDOW *win1" "WINDOW *win2"
 .De
 Overwrite
 .Vn win1
@@ -562,8 +536,7 @@ blanks on
 become blank on
 .Vn win2 .
 .Ds
-.Fd printw fmt\*,arg1\*,arg2\*,...
-char	*fmt;
+.Fn printw "char *fmt" "..."
 .De
 Performs a
 .Fn printf
@@ -576,23 +549,7 @@ It is often advisable to use the field width options of
 to avoid leaving things on the window from earlier calls.
 \*(Es
 .Ds
-.Fd \*_putchar c
-char	c;
-.De
-Put out a character using the
-.Fn putchar
-macro.
-This function is used to output every character
-that
-.b curses
-generates.
-Thus,
-it can be redefined by the user who wants to do non-standard things
-with the output.
-It is named with an initial \*(lq\*_\*(rq
-because it usually should be invisible to the programmer.
-.Ds
-.Fd raw "" \*m
+.Fn raw "" \(dg
 .De
 Set the terminal to raw mode.
 On version 7
@@ -606,7 +563,7 @@ this also turns of newline mapping
 (see
 .Fn nl ).
 .Ds
-.Fd refresh "" \*m
+.Fn refresh "" \(dg
 .De
 Synchronize the terminal screen with the desired window.
 If the window is not a screen,
@@ -625,7 +582,7 @@ and repainted as it is currently.
 This is very useful for allowing the redrawing of the screen
 when the user has garbage dumped on his terminal.
 .Ds
-.Fd resetty "" \*m
+.Fn resetty "" \(dg
 .De
 .Fn resetty
 restores them to what
@@ -636,34 +593,30 @@ These functions are performed automatically by
 and
 .Fn endwin .
 .Ds
-.Fd savetty "" \*m
+.Fn savetty "" \(dg
 .De
 .Fn savetty
 saves the current tty characteristic flags. See
 .Fn resetty .
 .Ds
-.Fd scanw fmt\*,arg1\*,arg2\*,...
-char	*fmt;
+.Fn scanw "char *fmt" "..."
 .De
 Perform a
 .Fn scanf
 through the window using
 .Vn fmt .
-It does this using consecutive
-.Fn getch 's
+It does this using consecutive calls to 
+.Fn getch
 (or
-.Fn wgetch 's). "" win
+.Fn wgetch ).
 \*(Es
 .Ds
-.Fd scroll win
-WINDOW	*win;
+.Fn scroll "WINDOW *win"
 .De
 Scroll the window upward one line.
 This is normally not used by the user.
 .Ds
-.Fd scrollok win\*,boolf \*m
-WINDOW	*win;
-int	boolf;
+.Fn scrollok "WINDOW *win" "int boolf" \(dg
 .De
 Set the scroll flag for the given window.
 If
@@ -671,33 +624,28 @@ If
 is FALSE, scrolling is not allowed.
 This is its default setting.
 .Ds
-.Fd setterm name
-char	*name;
+.Fn setterm "char *name"
 .De
 Set the terminal characteristics to be those of the terminal named
 .Vn name ,
-getting the terminal size from the
-.b TIOCGWINSZ
-.Fn ioctl "" "" 2
-if it exists,
-otherwise from the environment.
+getting the terminal size using
+.i tgetent(3).
 This is normally called by
 .Fn initscr .
 .Ds
-.Fd standend "" \*m
+.Fn standend "" \(dg
 .De
 End standout mode initiated by
 .Fn standout .
 .Ds
-.Fd standout "" \*m
+.Fn standout "" \(dg
 .De
 Causes any characters added to the window
 to be put in standout mode on the terminal
 (if it has that capability).
 .Ds
-.Fd subwin win\*,lines\*,cols\*,begin\*_y\*,begin\*_x "" "WINDOW *"
-WINDOW	*win;
-int	lines\*,cols\*,begin\*_y\*,begin\*_x;
+.Ft "WINDOW *"
+.Fn subwin "WINDOW *win" "int lines" "int cols" "int begin_y" "int begin_x"
 .De
 Create a new window with
 .Vn lines
@@ -725,9 +673,7 @@ or
 .Vn "COLS \- begin\*_x" ) (
 respectively.
 .Ds
-.Fd touchline win\*,y\*,startx\*,endx
-WINDOW	*win;
-int	y\*,startx\*,endx;
+.Fn touchline "WINDOW *win" "int y" "int startx" "int endx"
 .De
 This function performs a function similar to
 .Fn touchwin
@@ -742,8 +688,7 @@ the last change mark is set to be
 if it is currently less than
 .Vn endx .
 .Ds
-.Fd touchoverlap win1\*,win2
-WINDOW	*win1, *win2;
+.Fn touchoverlap "WINDOW *win1" "WINDOW *win2"
 .De
 Touch the window
 .Vn win2
@@ -752,15 +697,13 @@ in the area which overlaps with
 If they do not overlap,
 no changes are made.
 .Ds
-.Fd touchwin win
-WINDOW	*win;
+.Fn touchwin "WINDOW *win"
 .De
 Make it appear that the every location on the window
 has been changed.
 This is usually only needed for refreshes with overlapping windows.
 .Ds
-.Fd unctrl ch \*m
-char	ch;
+.Fn unctrl "char *ch" \(dg
 .De
 This is actually a debug function for the library,
 but it is of general usefulness.
@@ -774,7 +717,7 @@ you may have to have
 .b #include\ <unctrl.h>
 in your file.
 .Ds
-.Fd tstp
+.Fn tstp
 .De
 If the new
 .b tty (4)
@@ -785,27 +728,21 @@ and then put the process to sleep.
 When the process gets restarted,
 it restores the tty state
 and then calls
-.Fn wrefresh "" "" curscr
+.Fn wrefresh "curscr"
 to redraw the screen.
 .Fn initscr
 sets the signal
 SIGTSTP
 to trap to this routine.
 .Ds
-.Fd vwprintw win\*,fmt\*,ap
-WINDOW 	*win;
-const char *fmt;
-va_list ap;
+.Fn vwprintw "WINDOW *win" "const char *fmt" "va_list ap"
 .De
 Identical to 
 .Fn printw 
 except that it takes both a window specification and a pointer to a variable
 length argument list.
 .Ds
-.Fd vwscanw win\*,fmt\*,ap
-WINDOW	*win;
-const char *fmt;
-va_list ap;
+.Fn vwscanw "WINDOW *win" "const char *fmt" "va_list ap"
 .De
 Identical to 
 .Fn scanw
@@ -817,85 +754,23 @@ The following functions differ from the standard functions only in their
 specification of a window, rather than the use of the default
 .Vn stdscr.
 .Ds
-.Fd waddch win\*,ch
-WINDOW	*win;
-char	ch;
-.Dg
-.Ds
-.Fd waddstr win\*,str
-WINDOW	*win;
-char	*str;
-.Dg
-.Ds
-.Fd wclear win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd wclrtobot win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd wclrtoeol win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd wdelch win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd wdeleteln win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd werase win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd wgetch win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd wgetstr win\*,str
-WINDOW	*win;
-char	*str;
-.Dg
-.Ds
-.Fd winch win \*m
-WINDOW	*win;
-.Dg
-.Ds
-.Fd winsch win\*,c
-WINDOW	*win;
-char	c;
-.Dg
-.Ds
-.Fd winsertln win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd wmove win\*,y\*,x
-WINDOW	*win;
-int	y\*,x;
-.Dg
-.Ds
-.Fd wprintw win\*,fmt\*,arg1\*,arg2\*,...
-WINDOW	*win;
-char	*fmt;
-.Dg
-.Ds
-.Fd wrefresh win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd wscanw win\*,fmt\*,arg1\*,arg2\*,...
-WINDOW	*win;
-char	*fmt;
-.Dg
-.Ds
-.Fd wstandend win
-WINDOW	*win;
-.Dg
-.Ds
-.Fd wstandout win
-WINDOW	*win;
+.Fn waddch "WINDOW *win" "char ch" ,
+.Fn waddstr "WINDOW *win" "char *str" ,
+.Fn wclear "WINDOW *win" , 
+.Fn wclrtobot "WINDOW *win" , 
+.Fn wclrtoeol "WINDOW *win" , 
+.Fn wdelch "WINDOW *win" , 
+.Fn wdeleteln "WINDOW *win" ,
+.Fn werase "WINDOW *win" ,
+.Fn wgetch "WINDOW *win" ,
+.Fn wgetstr "WINDOW *win" "char *str" ,
+.Fn winch "WINDOW *win" \(dg
+.Fn winsch "WINDOW *win" "char c" ,
+.Fn winsertln "WINDOW *win" ,
+.Fn wmove "WINDOW *win" "int y" int x" ,
+.Fn wprintw "WINDOW *win" "char *fmt" "..." ,
+.Fn wrefresh "WINDOW *win" ,
+.Fn wscanw "WINDOW *win" "char *fmt" "..." ,
+.Fn wstandend "WINDOW *win" ,
+.Fn wstandout "WINDOW *win" .
 .Dg
-- 
2.20.1