summaryrefslogtreecommitdiff
path: root/usr/src/man/man3c
diff options
context:
space:
mode:
authorPeter Tribble <peter.tribble@gmail.com>2021-06-21 19:27:33 +0100
committerPeter Tribble <peter.tribble@gmail.com>2021-06-22 19:23:45 +0100
commitc432de9c6e1189ea0aa9b0fe1c35c18427653f27 (patch)
treef224755b67a1e348f953d5a1132f7d4b64cf4a63 /usr/src/man/man3c
parent0b9a51588b7231474f7b4009cb9cad83e4db7b74 (diff)
downloadillumos-joyent-c432de9c6e1189ea0aa9b0fe1c35c18427653f27.tar.gz
13883 Malformed #include statements in the manual
Reviewed by: Toomas Soome <tsoome@me.com> Reviewed by: Andy Fiddaman <andy@omnios.org> Reviewed by: Richard Lowe <richlowe@richlowe.net> Approved by: Dan McDonald <danmcd@joyent.com>
Diffstat (limited to 'usr/src/man/man3c')
-rw-r--r--usr/src/man/man3c/cset.3c21
-rw-r--r--usr/src/man/man3c/mkfifo.3c13
-rw-r--r--usr/src/man/man3c/posix_openpt.3c20
-rw-r--r--usr/src/man/man3c/wsscanf.3c13
4 files changed, 14 insertions, 53 deletions
diff --git a/usr/src/man/man3c/cset.3c b/usr/src/man/man3c/cset.3c
index 5d6b7f8a39..58291d7cf0 100644
--- a/usr/src/man/man3c/cset.3c
+++ b/usr/src/man/man3c/cset.3c
@@ -3,11 +3,10 @@
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH CSET 3C "Nov 16, 2003"
+.TH CSET 3C "June 18, 2021"
.SH NAME
cset, csetlen, csetcol, csetno, wcsetno \- get information on EUC codesets
.SH SYNOPSIS
-.LP
.nf
#include <euc.h>
@@ -32,9 +31,7 @@ cset, csetlen, csetcol, csetno, wcsetno \- get information on EUC codesets
.fi
.SH DESCRIPTION
-.sp
-.LP
-Both \fBcsetlen()\fR and \fBcsetcol()\fR take a code set number \fIcodeset\fR,
+Both \fBcsetlen()\fR and \fBcsetcol()\fR take a code set number \fIcodeset\fR,
which must be 0, 1, 2, or 3. The \fBcsetlen()\fR function returns the number of
bytes needed to represent a character of the given Extended Unix Code (EUC)
code set, excluding the single-shift characters SS2 and SS3 for codesets 2 and
@@ -48,7 +45,7 @@ For example,
.sp
.in +2
.nf
-#include<euc.h>
+#include <euc.h>
\|.\|.\|.
x+=csetcol(csetno(c));
.fi
@@ -66,8 +63,8 @@ example,
.sp
.in +2
.nf
-#include<euc.h>
-#include<widec.h>
+#include <euc.h>
+#include <widec.h>
\|.\|.\|.
x+=csetcol(wcsetno(pc));
.fi
@@ -78,8 +75,6 @@ x+=csetcol(wcsetno(pc));
increments a counter "x" (such as the cursor position) by the width of the
Process Code character \fIpc\fR.
.SH USAGE
-.sp
-.LP
These functions work only for the EUC locales.
.sp
.LP
@@ -87,8 +82,6 @@ The \fBcset()\fR, \fBcsetlen()\fR, \fBcsetcol()\fR, \fBcsetno()\fR, and
\fBwcsetno()\fR functions can be used safely in multithreaded applications, as
long as \fBsetlocale\fR(3C) is not being called to change the locale.
.SH ATTRIBUTES
-.sp
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -103,6 +96,4 @@ MT-Level MT-Safe with exceptions
.TE
.SH SEE ALSO
-.sp
-.LP
-\fBsetlocale\fR(3C) \fBeuclen\fR(3C), \fBattributes\fR(5)
+\fBsetlocale\fR(3C), \fBeuclen\fR(3C), \fBattributes\fR(5)
diff --git a/usr/src/man/man3c/mkfifo.3c b/usr/src/man/man3c/mkfifo.3c
index 40e2927aa4..7c55928d76 100644
--- a/usr/src/man/man3c/mkfifo.3c
+++ b/usr/src/man/man3c/mkfifo.3c
@@ -45,11 +45,10 @@
.\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
.\" Copyright (c) 2014, Joyent, Inc.
.\"
-.TH MKFIFO 3C "Apr 24, 2002"
+.TH MKFIFO 3C "June 18, 2021"
.SH NAME
mkfifo, mkfifoat \- make a FIFO special file
.SH SYNOPSIS
-.LP
.nf
#include <sys/types.h>
#include <sys/stat.h>
@@ -62,7 +61,6 @@ mkfifo, mkfifoat \- make a FIFO special file
.fi
.SH DESCRIPTION
-.LP
The \fBmkfifo()\fR and \fBmkfifoat()\fR functions create a new FIFO special file
named by the pathname pointed to by \fIpath\fR. The file permission bits of the
new FIFO are initialized from \fImode\fR. The file permission bits of the
@@ -96,11 +94,9 @@ the \fBst_atime\fR, \fBst_ctime\fR, and \fBst_mtime\fR fields of the file. Also,
the \fBst_ctime\fR and \fBst_mtime\fR fields of the directory that contains the
new entry are marked for update.
.SH RETURN VALUES
-.LP
Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
returned and \fBerrno\fR is set to indicate the error.
.SH ERRORS
-.LP
The \fBmkfifo()\fR and \fBmkfifoat()\fR functions will fail if:
.sp
.ne 2
@@ -217,7 +213,6 @@ component is longer than {\fBNAME_MAX\fR}.
.RE
.SH EXAMPLES
-.LP
\fBExample 1 \fRCreate a FIFO File
.sp
.LP
@@ -228,8 +223,8 @@ permissions for the group and others.
.sp
.in +2
.nf
-#include sys/types.h>
-#include sys/stat.h>
+#include <sys/types.h>
+#include <sys/stat.h>
int status;
\&...
status = mkfifo("/home/cnd/mod_done", S_IWUSR | S_IRUSR |
@@ -238,7 +233,6 @@ status = mkfifo("/home/cnd/mod_done", S_IWUSR | S_IRUSR |
.in -2
.SH ATTRIBUTES
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -255,6 +249,5 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.LP
\fBmkdir\fR(1), \fBchmod\fR(2), \fBexec\fR(2), \fBmknod\fR(2), \fBumask\fR(2),
\fBstat.h\fR(3HEAD), \fBufs\fR(7FS), \fBattributes\fR(5), \fBstandards\fR(5)
diff --git a/usr/src/man/man3c/posix_openpt.3c b/usr/src/man/man3c/posix_openpt.3c
index 716778eb21..16193b89f3 100644
--- a/usr/src/man/man3c/posix_openpt.3c
+++ b/usr/src/man/man3c/posix_openpt.3c
@@ -43,11 +43,10 @@
.\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
.\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
.\"
-.TH POSIX_OPENPT 3C "Dec 1, 2003"
+.TH POSIX_OPENPT 3C "June 18, 2021"
.SH NAME
posix_openpt \- open a pseudo terminal device
.SH SYNOPSIS
-.LP
.nf
#include <stdlib.h>
#include <fcntl.h>
@@ -56,8 +55,6 @@ posix_openpt \- open a pseudo terminal device
.fi
.SH DESCRIPTION
-.sp
-.LP
The \fBposix_openpt()\fR function establishes a connection between a master
device for a pseudo-terminal and a file descriptor. The file descriptor is used
by other I/O functions that refer to that pseudo-terminal.
@@ -92,15 +89,11 @@ controlling terminal for the process.
.LP
The behavior of other values for the \fIoflag\fR argument is unspecified.
.SH RETURN VALUES
-.sp
-.LP
Upon successful completion, the \fBposix_openpt()\fR function opens a master
pseudo-terminal device and returns a non-negative integer representing the
lowest numbered unused file descriptor. Otherwise, -1 is returned and
\fBerrno\fR is set to indicate the error.
.SH ERRORS
-.sp
-.LP
The \fBposix_openpt()\fR function will fail if:
.sp
.ne 2
@@ -151,7 +144,6 @@ Out of STREAMS resources.
.RE
.SH EXAMPLES
-.LP
\fBExample 1 \fROpen a pseudo-terminal.
.sp
.LP
@@ -161,8 +153,8 @@ device and a file descriptor.
.sp
.in +2
.nf
-#include fcntl.h>
-#include stdio.h>
+#include <fcntl.h>
+#include <stdio.h>
int masterfd, slavefd;
char *slavedevice;
@@ -184,15 +176,11 @@ if (slavefd < 0)
.in -2
.SH USAGE
-.sp
-.LP
This function provides a method for portably obtaining a file descriptor of a
master terminal device for a pseudo-terminal. The \fBgrantpt\fR(3C) and
\fBptsname\fR(3C) functions can be used to manipulate mode and ownership
permissions and to obtain the name of the slave device, respectively.
.SH ATTRIBUTES
-.sp
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -209,7 +197,5 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
-.LP
\fBopen\fR(2), \fBgrantpt\fR(3C), \fBptsname\fR(3C), \fBunlockpt\fR(3C),
\fBattributes\fR(5), \fBstandards\fR(5)
diff --git a/usr/src/man/man3c/wsscanf.3c b/usr/src/man/man3c/wsscanf.3c
index 84b7e096ad..cd55f8776f 100644
--- a/usr/src/man/man3c/wsscanf.3c
+++ b/usr/src/man/man3c/wsscanf.3c
@@ -3,21 +3,18 @@
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH WSSCANF 3C "Dec 29, 1996"
+.TH WSSCANF 3C "June 18, 2021"
.SH NAME
wsscanf \- formatted input conversion
.SH SYNOPSIS
-.LP
.nf
-#include<stdio.h>
+#include <stdio.h>
#include <widec.h>
\fBint\fR \fBwsscanf\fR(\fBwchar_t *\fR\fIs\fR, \fBconst char *\fR\fIformat\fR, \fB/*\fR \fIpointer\fR */ ... );
.fi
.SH DESCRIPTION
-.sp
-.LP
The \fBwsscanf()\fR function reads Process Code characters from the Process
Code string \fIs\fR, interprets them according to the \fIformat\fR, and stores
the results in its arguments. It expects, as arguments, a control string
@@ -32,13 +29,9 @@ the regular \fBsscanf\fR(3C) function except that the source is a Process Code
string for \fBwsscanf()\fR and on Extended Unix Code (EUC) character string for
\fBsscanf\fR(3C).
.SH RETURN VALUES
-.sp
-.LP
Upon successful completion, \fBwsscanf()\fR returns the number of characters
matched. Otherwise, it returns a negative value.
.SH ATTRIBUTES
-.sp
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -53,6 +46,4 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
-.LP
\fBwsprintf\fR(3C), \fBprintf\fR(3C), \fBscanf\fR(3C), \fBattributes\fR(5)