summaryrefslogtreecommitdiff
path: root/usr/src/man
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man')
-rw-r--r--usr/src/man/Makefile33
-rw-r--r--usr/src/man/Makefile.man62
-rw-r--r--usr/src/man/man1/Makefile28
-rw-r--r--usr/src/man/man1/foo.136
-rw-r--r--usr/src/man/man3x/Makefile32
-rw-r--r--usr/src/man/man3x/foo.3x53
-rw-r--r--usr/src/man/man7/Makefile28
-rw-r--r--usr/src/man/man7/foo.731
8 files changed, 303 insertions, 0 deletions
diff --git a/usr/src/man/Makefile b/usr/src/man/Makefile
new file mode 100644
index 0000000..8705b8c
--- /dev/null
+++ b/usr/src/man/Makefile
@@ -0,0 +1,33 @@
+#
+# This file and its contents are supplied under the terms of the
+# Common Development and Distribution License ("CDDL"), version 1.0.
+# You may only use this file in accordance with the terms of version
+# 1.0 of the CDDL.
+#
+# A full copy of the text of the CDDL should have accompanied this
+# source. A copy of the CDDL is also available via the Internet
+# at http://www.illumos.org/license/CDDL.
+#
+
+#
+# Copyright 2011, Richard Lowe
+#
+
+SUBDIRS= man1 \
+ man3x \
+ man7
+
+.PARALLEL: $(SUBDIRS)
+
+all := TARGET = all
+clean := TARGET = clean
+clobber := TARGET = clobber
+install := TARGET = install
+check := TARGET = check
+
+all check clean clobber install: $(SUBDIRS)
+
+$(SUBDIRS): FRC
+ @cd $@; pwd; $(MAKE) $(TARGET)
+
+FRC:
diff --git a/usr/src/man/Makefile.man b/usr/src/man/Makefile.man
new file mode 100644
index 0000000..1b26bf0
--- /dev/null
+++ b/usr/src/man/Makefile.man
@@ -0,0 +1,62 @@
+#
+# This file and its contents are supplied under the terms of the
+# Common Development and Distribution License ("CDDL"), version 1.0.
+# You may only use this file in accordance with the terms of version
+# 1.0 of the CDDL.
+#
+# A full copy of the text of the CDDL should have accompanied this
+# source. A copy of the CDDL is also available via the Internet
+# at http://www.illumos.org/license/CDDL.
+#
+
+#
+# Copyright 2011, Richard Lowe
+# Copyright 2014 Nexenta Systems, Inc. All rights reserved.
+#
+
+MANDOC= $(ONBLD_TOOLS)/bin/${MACH}/mandoc
+ROOTMAN= $(ROOT)/usr/share/man
+ROOTHASMAN= $(ROOT)/usr/has/man
+FILEMODE= 0444
+
+# The manual section being built, client Makefiles must set this to, for e.g.
+# "3perl", with case matching that of the section name as installed.
+#
+# MANSECT=
+
+MANCHECKS= $(MANFILES:%=%.check)
+ROOTMANFILES= $(MANFILES:%=$(ROOTMAN)/man$(MANSECT)/%)
+ROOTMANLINKS= $(MANLINKS:%=$(ROOTMAN)/man$(MANSECT)/%)
+
+$(ROOTMAN)/man$(MANSECT)/% $(ROOTHASMAN)/man$(MANSECT)/%: %
+ $(INS.file)
+
+#
+# Note that new mandoc adds some checks for lots of extra whitespace.
+# We don't want to check our legacy pages for that. There are thousands
+# and thousands of them in our man pages. Please still check them
+# manually when editing (git pbchk will do so for you.)
+#
+$(MANCHECKS):
+ @$(EGREP) -q "^.TH" $(@:%.check=%) || \
+ ( $(ECHO) "checking $(@:%.check=%)"; \
+ $(MANDOC) -Tlint $(@:%.check=%) )
+
+$(MANLINKS):
+ $(RM) $@; $(SYMLINK) $(LINKSRC) $@
+
+$(ROOTMANLINKS): $(MANLINKS)
+ $(RM) $@; $(CP) -RP $(@F) $(@D)
+
+all:
+
+check: $(MANCHECKS)
+
+clean:
+
+clobber:
+ $(RM) $(MANLINKS)
+
+.PARALLEL:
+
+FRC:
diff --git a/usr/src/man/man1/Makefile b/usr/src/man/man1/Makefile
new file mode 100644
index 0000000..f0fbf24
--- /dev/null
+++ b/usr/src/man/man1/Makefile
@@ -0,0 +1,28 @@
+#
+# This file and its contents are supplied under the terms of the
+# Common Development and Distribution License ("CDDL"), version 1.0.
+# You may only use this file in accordance with the terms of version
+# 1.0 of the CDDL.
+#
+# A full copy of the text of the CDDL should have accompanied this
+# source. A copy of the CDDL is also available via the Internet
+# at http://www.illumos.org/license/CDDL.
+#
+
+#
+# Copyright 2011, Richard Lowe
+#
+
+include $(SRC)/Makefile.master
+
+MANSECT= 1
+
+MANFILES= foo.1
+
+MANLINKS=
+
+.KEEP_STATE:
+
+include $(SRC)/man/Makefile.man
+
+install: $(ROOTMANFILES) $(ROOTMANLINKS)
diff --git a/usr/src/man/man1/foo.1 b/usr/src/man/man1/foo.1
new file mode 100644
index 0000000..3a0023e
--- /dev/null
+++ b/usr/src/man/man1/foo.1
@@ -0,0 +1,36 @@
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source. A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright 2015 Nexenta Systems, Inc.
+.\"
+.Dd "Apr 7, 2015"
+.Dt FOO 1
+.Os
+.Sh NAME
+.Nm foo
+.Nd example command
+.Sh SYNOPSIS
+.Nm foo
+.Op Fl v
+.Sh DESCRIPTION
+The
+.Nm
+command is a dummy example for the on-skeleton repository.
+It does nothing interesting, other than demonstrate a
+command and a library.
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Fl v
+Verbose mode.
+.El
+.Sh SEE ALSO
+.Xr foo 3x ,
+.Xr foo 7
diff --git a/usr/src/man/man3x/Makefile b/usr/src/man/man3x/Makefile
new file mode 100644
index 0000000..f48fc91
--- /dev/null
+++ b/usr/src/man/man3x/Makefile
@@ -0,0 +1,32 @@
+#
+# This file and its contents are supplied under the terms of the
+# Common Development and Distribution License ("CDDL"), version 1.0.
+# You may only use this file in accordance with the terms of version
+# 1.0 of the CDDL.
+#
+# A full copy of the text of the CDDL should have accompanied this
+# source. A copy of the CDDL is also available via the Internet
+# at http://www.illumos.org/license/CDDL.
+#
+
+#
+# Copyright 2011, Richard Lowe
+#
+
+include $(SRC)/Makefile.master
+
+MANSECT= 3x
+
+MANFILES= foo.3x
+
+MANLINKS= foo_getcnt.3x foo_message.3x libfoo.3x
+
+foo_getcnt.3x := LINKSRC = foo.3x
+foo_message.3x := LINKSRC = foo.3x
+libfoo.3x := LINKSRC = foo.3x
+
+.KEEP_STATE:
+
+include $(SRC)/man/Makefile.man
+
+install: $(ROOTMANFILES) $(ROOTMANLINKS)
diff --git a/usr/src/man/man3x/foo.3x b/usr/src/man/man3x/foo.3x
new file mode 100644
index 0000000..c0f8717
--- /dev/null
+++ b/usr/src/man/man3x/foo.3x
@@ -0,0 +1,53 @@
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source. A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright 2015 Nexenta Systems, Inc.
+.\"
+.Dd "Apr 7, 2015"
+.Dt FOO 3X
+.Os
+.Sh NAME
+.Nm foo_getcnt ,
+.Nm foo_message ,
+.Nm libfoo
+.Nd get counter stored in /dev/foo
+.Sh SYNOPSIS
+.In libfoo/foo.h
+.Ft int
+.Fo foo_getcnt
+.Fa int *
+.Fc
+.Ft int
+.Fo foo_message
+.Fa void
+.Fc
+.Sh DESCRIPTION
+The
+.Fn foo_getcnt
+function gets a counter from the
+.Sy /dev/foo
+device.
+The
+.Fn foo_message
+function returns a message.
+.Sh RETURN VALUES
+Upon successful completion,
+.Fn foo_message
+returns
+.Sy 0 .
+Otherwise, it returns an
+.Sy errno
+value.
+.Sh ERRORS
+No errors are defined.
+.Sh SEE ALSO
+.Xr foo 1 ,
+.Xr foo 7
diff --git a/usr/src/man/man7/Makefile b/usr/src/man/man7/Makefile
new file mode 100644
index 0000000..6ba1f78
--- /dev/null
+++ b/usr/src/man/man7/Makefile
@@ -0,0 +1,28 @@
+#
+# This file and its contents are supplied under the terms of the
+# Common Development and Distribution License ("CDDL"), version 1.0.
+# You may only use this file in accordance with the terms of version
+# 1.0 of the CDDL.
+#
+# A full copy of the text of the CDDL should have accompanied this
+# source. A copy of the CDDL is also available via the Internet
+# at http://www.illumos.org/license/CDDL.
+#
+
+#
+# Copyright 2011, Richard Lowe
+#
+
+include $(SRC)/Makefile.master
+
+MANSECT= 7
+
+MANFILES= foo.7
+
+MANLINKS=
+
+.KEEP_STATE:
+
+include $(SRC)/man/Makefile.man
+
+install: $(ROOTMANFILES) $(ROOTMANLINKS)
diff --git a/usr/src/man/man7/foo.7 b/usr/src/man/man7/foo.7
new file mode 100644
index 0000000..660c34e
--- /dev/null
+++ b/usr/src/man/man7/foo.7
@@ -0,0 +1,31 @@
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source. A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright 2015 Nexenta Systems, Inc.
+.\"
+.Dd "Apr 7, 2015"
+.Dt FOO 7
+.Os
+.Sh NAME
+.Nm foo
+.Nd example "foo" driver
+.Sh SYNOPSIS
+.In sys/foo.h
+.Sh DESCRIPTION
+The
+.Fn foo
+driver is a simple example that just implements one
+.Xr ioctl 2
+function:
+.Sy FOO_IOC_GETCNT .
+.Sh SEE ALSO
+.Xr foo 1 ,
+.Xr libfoo 3x