Date: Tue, 28 Dec 2004 00:29:23 +0000 (GMT) From: n-kogane@syd.odn.ne.jp To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/75544: typos in man3 manual pages, acl.3, assertions.3, curs_beep.3, curs_color.3, curs_extend.3, dialog.3, dlinfo.3, eventlib.3, exec.3. Message-ID: <20041228002923.E8E8E1024B@kces6.koganemaru.co.jp> Resent-Message-ID: <200412271530.iBRFUMpa067553@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 75544 >Category: docs >Synopsis: typos in man3 manual pages, acl.3, assertions.3, curs_beep.3, curs_color.3, curs_extend.3, dialog.3, dlinfo.3, eventlib.3, exec.3. >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Mon Dec 27 15:30:22 GMT 2004 >Closed-Date: >Last-Modified: >Originator: Nobuyuki Koganemaru >Release: FreeBSD 4.11-RC1 i386 >Organization: KOGANEMARU Computer Engineering Service Corporation. >Environment: FreeBSD kcesx3.koganemaru.co.jp 4.10-RELEASE FreeBSD 4.10-RELEASE #0: Tue May 25 22:47:12 GMT 2004 root@perseus.cse.buffalo.edu:/usr/obj/usr/src/sys/GENERIC i386 >Description: I found some typos in acl.3, assertions.3, curs_beep.3, curs_color.3, curs_extend.3, dialog.3, dlinfo.3, eventlib.3, exec.3. and erases trailing spaces. >How-To-Repeat: Do "man 3 xxxxx". >Fix: diff -u acl.3.orig ./acl.3 --- acl.3.orig Sat Dec 18 00:08:17 2004 +++ ./acl.3 Mon Dec 27 23:45:06 2004 @@ -37,7 +37,7 @@ .In sys/types.h .In sys/acl.h .Sh DESCRIPTION -As shipped, +As shipped, .Fx 4.0 permits file systems to export Access Control Lists via the VFS, and provides a library for userland @@ -130,7 +130,7 @@ .Fn acl_valid_file_np , .Fn acl_valid_fd_np .Pp -Thee functions are described in +Three functions are described in .Xr acl_valid 3 , and may be used to validate an ACL as correct POSIX.1e-semantics, or as appropriate for a particular file system object regardless of semantics. @@ -170,7 +170,7 @@ POSIX.1e is described in IEEE POSIX.1e draft 17. Discussion of the draft continues on the cross-platform POSIX.1e implementation mailing list. To join this list, see the -.Fx +.Fx POSIX.1e implementation page for more information. .Sh HISTORY diff -u assertions.3.orig ./assertions.3 --- assertions.3.orig Sat Dec 18 00:08:16 2004 +++ ./assertions.3 Mon Dec 27 23:47:20 2004 @@ -59,7 +59,7 @@ .Fn INVARIANT macros evaluate a boolean expression, and if it is false, they invoke the current assertion failure callback. The default callback will print a message -to +to .Li stderr describing the failure, and then cause the program to dump core. If the @@ -94,7 +94,7 @@ .Pp When an .Fn assertion_failure_callback -is called, the +is called, the .Fa filename and .Fa line @@ -112,10 +112,10 @@ and may be used by the callback to determine the type of the failing assertion. .Fa condition -is the literal text of the assertion that failed. +is the literal text of the assertion that failed. .Fa print_errno will be non-zero if the callback should print -.Fa strerror "errno" +.Fn strerror "errno" as part of its output. .Pp .Fn assertion_type_to_text diff -u curs_beep.3.orig ./curs_beep.3 --- curs_beep.3.orig Sat Dec 18 00:08:07 2004 +++ ./curs_beep.3 Mon Dec 27 23:49:21 2004 @@ -45,13 +45,14 @@ alert is possible, nothing happens. Nearly all terminals have an audible alert (bell or beep), but only some can flash the screen. .SH RETURN VALUE -These routines return \fBOK\fR if they succeed in beeping or flashing, +These routines return \fBOK\fR if they succeed in beeping or flashing, \fBERR\fR otherwise. .SH EXTENSIONS SVr4's beep and flash routines always returned \fBOK\fR, so it was not possible to tell when the beep or flash failed. .SH PORTABILITY -These functions are defined in the XSI Curses standard, Issue 4. Like SVr4, it +These functions are described in the XSI Curses standard, Issue 4. +Like SVr4, it specifies that they always return \fBOK\fR. .SH SEE ALSO \fBcurses\fR(3X) diff -u curs_color.3.orig ./curs_color.3 --- curs_color.3.orig Sat Dec 18 00:08:07 2004 +++ ./curs_color.3 Mon Dec 27 23:50:43 2004 @@ -201,7 +201,7 @@ .PP The assumption that \fBCOLOR_BLACK\fR is the default background color for all terminals can be modified using the -\fBassume_default_colors\fP extension, +\fBassume_default_colors\fP extension. .. .SH SEE ALSO \fBcurses\fR(3X), diff -u curs_extend.3.orig ./curs_extend.3 --- curs_extend.3.orig Sat Dec 18 00:08:07 2004 +++ ./curs_extend.3 Mon Dec 27 23:51:59 2004 @@ -57,11 +57,11 @@ is able to use user-defined or nonstandard names which may be compiled into the terminfo description, i.e., via the terminfo or termcap interfaces. -Normally these names are available for use, since the essential descision +Normally these names are available for use, since the essential decision is made by using the \fB-x\fP option of \fItic\fP to compile extended terminal definitions. However you can disable this feature -to ensure compatiblity with other implementations of curses +to ensure compatibility with other implementations of curses .. .SH PORTABILITY These routines are specific to ncurses. They were not supported on diff -u dialog.3.orig ./dialog.3 --- dialog.3.orig Sat Dec 18 00:08:21 2004 +++ ./dialog.3 Tue Dec 28 00:01:45 2004 @@ -127,15 +127,15 @@ .Fn end_dialog "void" .Ft "int" .Fn dialog_ftree "unsigned char *filename" "unsigned char FS" "unsigned char *title" "unsigned char *prompt" "int height" "int width" "int menu_height" "unsigned char **result" -.Ft "int" -.Fo dialog_tree -.Fa "unsigned char **names" +.Ft "int" +.Fo dialog_tree +.Fa "unsigned char **names" .Fa "int size" -.Fa "unsigned char FS" -.Fa "unsigned char *title" +.Fa "unsigned char FS" +.Fa "unsigned char *title" .Fa "unsigned char *prompt" -.Fa "int height" -.Fa "int width" +.Fa "int height" +.Fa "int width" .Fa "int menu_height" .Fa "unsigned char **result" .Fc @@ -393,7 +393,7 @@ .Va fire actions are used to override the default behavior, and .Va it -to the same for the OK button. +does the same for the OK button. .Pp Using either API behavior, the .Va ch @@ -682,7 +682,7 @@ .Va menu_height sets the height of the tree subwindow inside the .Fn dialog_ftree -box and must be set. +box and must be set. .Va title is shown centered on the upper border of the .Fn dialog_ftree @@ -728,7 +728,7 @@ .Fn dialog_ftree on ESC, the function returns -1. .Pp -.Fn dialog_tree +.Fn dialog_tree function returns the same results as .Fn dialog_ftree . If 0 is returned, result will contain a pointer from the array @@ -764,7 +764,8 @@ command and were soon split into a separate library and command by .An Andrey Chernov . -.An Marc van Kempen implemented most of the +.An Marc van Kempen +implemented most of the extra controls and objects, .An Jordan Hubbard added the dialogMenuItem renovations and this man page and diff -u dlinfo.3.orig ./dlinfo.3 --- dlinfo.3.orig Sat Dec 18 00:08:11 2004 +++ ./dlinfo.3 Tue Dec 28 00:04:10 2004 @@ -84,8 +84,8 @@ .Fa handle argument. .Ft Link_map -stuctures are maintained as double-linked list by -.Xr ld.so 1 +structures are maintained as double-linked list by +.Xr ld.so 1 in same order as .Fn dlopen and @@ -104,7 +104,7 @@ const char *l_name; /* Absolute Path to Library */ const void *l_ld; /* Pointer to .dynamic in memory */ struct link_map *l_next, /* linked list of of mapped libs */ - *l_prev; + *l_prev; .Ed .Bl -tag -width Ds .It l_addr @@ -232,7 +232,7 @@ .Ed .Sh RETURN VALUES .Fn dlinfo -returns 0 on success, or -1 if error occured. +returns 0 on success, or -1 if error occurred. Whenever an error has been detected, a message detailing it can be retrieved via a call to .Fn dlerror . diff -u eventlib.3.orig ./eventlib.3 --- eventlib.3.orig Sat Dec 18 00:08:16 2004 +++ ./eventlib.3 Tue Dec 28 00:07:02 2004 @@ -120,9 +120,9 @@ .Ft int .Fn evSetIdleTimer "evContext opaqueCtx" "evTimerFunc func" "void *uap" \ "struct timespec max_idle" "evTimerID *opaqueID" -.Ft int +.Ft int .Fn evTouchIdleTimer "evContext opaqueCtx" "evTimerID id" -.Ft int +.Ft int .Fn evResetIdleTimer "evContext opaqueCtx" "evTimerID id" "evTimerFunc func" \ "void *uap" "struct timespec max_idle" .Ft int @@ -196,7 +196,7 @@ .Fn evCreate creates an event context which is needed by all the other functions in this library. All information used internally by this library is bound to this -context, rather than to static storage. This makes the library +context, rather than to static storage. This makes the library .Dq thread safe , and permits other library functions to use events without disrupting the application's use of events. @@ -236,14 +236,14 @@ .Fa EV_NULL , which tells .Fn evGetNext -that it should return a special -.Dq no-op +that it should return a special +.Dq no-op event, which is ignored by .Fn evDispatch but handled correctly by .Fn evDrop . .Fa EV_NULL -can be necessary to the correct functioning of a caller\-written equivilent to +can be necessary to the correct functioning of a caller\-written equivalent to .Fn evMainLoop , wherein perterbations caused by external system events must be polled for, and the default behaviour of internally ignoring such events is undesirable. @@ -309,10 +309,10 @@ The functions .Fn evTimeSpec and -.Fn evTimeVal +.Fn evTimeVal are utilities which allow the caller to convert a .Dq Fa struct timeval -to a +to a .Dq Fa struct timespec (the function of .Fn evTimeSpec ) @@ -359,16 +359,16 @@ .Xr gettimeofday 2 . ) .Pp The function -.Fn evLastEventTime +.Fn evLastEventTime returns the .Dq Fa struct timespec -which describes the last time that certain events happened to the -event context indicated by +which describes the last time that certain events happened to the +event context indicated by .Fa opaqueCtx . This value is updated by -.Fn evCreate +.Fn evCreate and -.Fn evGetNext +.Fn evGetNext (upon entry and after .Xr select 2 returns); it is routinely compared with other times in the internal handling @@ -391,18 +391,18 @@ .Fa due argument equal to .Dq Fn evConsTime 0 0 -means +means .Dq due immediately . The .Fa opaqueID argument, if specified as a value other than .Fa NULL , -will be used to store the resulting -.Dq timer \s-1ID\s+1 , +will be used to store the resulting +.Dq timer \s-1ID\s+1 , useful as an argument to .Fn evClearTimer . -Note that in a -.Dq one\-shot +Note that in a +.Dq one\-shot timer (which has an .Fa inter argument equal to @@ -438,7 +438,7 @@ will exist within the event library. .Pp The function -.Fn evSetIdleTimer +.Fn evSetIdleTimer is similar to (and built on) .Fn evSetTimer ; it registers an idle timer event which provides for the function call to @@ -450,24 +450,24 @@ time has passed since the time the idle timer was .Dq last touched ; originally, this is set to the time returned by -.Fn evLastEventTime -(described above) for the event context specified by -.Fa opaqueCtx . -This is a -.Dq one\-shot +.Fn evLastEventTime +(described above) for the event context specified by +.Fa opaqueCtx . +This is a +.Dq one\-shot timer, but the time at which the .Fa func is actually called can be changed by recourse to .Fn evTouchIdleTimer -(described below). The pointer to the underlying -.Dq timer \s-1ID\s+1 +(described below). The pointer to the underlying +.Dq timer \s-1ID\s+1 is returned in .Fa opaqueID , if it is .No non- Ns Dv NULL . .Pp The -.Fn evTouchIdleTimer +.Fn evTouchIdleTimer function updates the idle timer associated with .Fa id , setting its idea of the time it was last accessed to the value returned by @@ -496,7 +496,7 @@ function unregisters the idle timer associated with .Fa id . See the discussion under -.Fn evClearTimer , +.Fn evClearTimer , above, for information regarding caller handling of the .Fa uap associated with the corresponding @@ -510,20 +510,20 @@ on the given event context's wait queue with the associated (possibly .Dv NULL ) .Dq Fa tag ; -if +if .Fa id -is +is .No non- Ns Dv NULL , -then it will contain the -.Dq wait \s-1ID\s+1 +then it will contain the +.Dq wait \s-1ID\s+1 associated with the created queue element. .Pp The function -.Fn evDo -marks +.Fn evDo +marks .Em all -of the -.Dq waiting +of the +.Dq waiting functions in the given event context's wait queue with the associated (possibly .Dv NULL ) .Dq Fa tag @@ -533,12 +533,12 @@ .Fn evGetNext . .Pp The function -.Fn evUnwait +.Fn evUnwait will search for the -.Dq wait \s-1ID\s+1 +.Dq wait \s-1ID\s+1 .Fa id in the wait queue of the given event context; if an element with the given -.Fa id +.Fa id is not found, then the .Dq done queue of that context is searched. If found, the queue element is removed @@ -660,9 +660,9 @@ .Pp The function .Fn evTimeRW -sets the stream associated with the given stream \s-1ID\s+1 +sets the stream associated with the given stream \s-1ID\s+1 .Dq Fa id -to have the idle timer associated with the timer \s-1ID\s+1 +to have the idle timer associated with the timer \s-1ID\s+1 .Dq Fa timer . .Pp The function @@ -721,7 +721,7 @@ .Fn \*(lp*func\*(rp will be .Fa -1 -if an error occurred that prevented this connection from completing +if an error occurred that prevented this connection from completing successfully. In this case .Fn errno will have been set and the socket described by @@ -777,13 +777,13 @@ .Pp The function .Fn evInitID -will initialize an opaque -.Dq evConn \s-1ID\s+1 , -.Dq evFile \s-1ID\s+1 , -.Dq evStream \s-1ID\s+1 , -.Dq evTimer \s-1ID\s+1 , -.Dq evWait \s-1ID\s+1 , -.Dq evContext , +will initialize an opaque +.Dq evConn \s-1ID\s+1 , +.Dq evFile \s-1ID\s+1 , +.Dq evStream \s-1ID\s+1 , +.Dq evTimer \s-1ID\s+1 , +.Dq evWait \s-1ID\s+1 , +.Dq evContext , or .Dq evEvent , which is passed by reference. @@ -804,9 +804,9 @@ to indicate failure. .Sh FILE .Pa heap.h , -which is in the +which is in the .Pa src/lib/isc -directory of the current +directory of the current .Sy BIND distribution. .Sh ERRORS @@ -825,8 +825,8 @@ .Fa FD_SETSIZE , meaning that the application's limit is higher than the library's. .It Bq Er ENOENT -The specified -.Dq event \s-1ID\s+1 +The specified +.Dq event \s-1ID\s+1 does not exist. .It Bq Er EWOULDBLOCK No events have occurred and the diff -u exec.3.orig ./exec.3 --- exec.3.orig Sat Dec 18 00:08:11 2004 +++ ./exec.3 Tue Dec 28 00:09:43 2004 @@ -159,7 +159,7 @@ as being ambiguous here, although only the critical error .Er EACCES is really ambiguous), -then these functions will act as if they stat the file to determine +then these functions will act as if they state the file to determine whether the file exists and has suitable execute permissions. If it does, they will return immediately with the global variable .Va errno @@ -266,7 +266,7 @@ upon which they returned. They now return for .Er ETXTBSY , -and determine existence and executability more carefully. +and determine existence and executablity more carefully. In particular, .Er EACCES for inaccessible directories in the path prefix is no longer >Release-Note: >Audit-Trail: >Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20041228002923.E8E8E1024B>