Source-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[src/trunk]: src Briefly document <paths.h>.



details:   https://anonhg.NetBSD.org/src/rev/7e291aaf8dd1
branches:  trunk
changeset: 763663:7e291aaf8dd1
user:      jruoho <jruoho%NetBSD.org@localhost>
date:      Wed Mar 30 10:06:58 2011 +0000

description:
Briefly document <paths.h>.

diffstat:

 distrib/sets/lists/comp/mi |   5 +-
 share/man/man3/Makefile    |   4 +-
 share/man/man3/paths.3     |  98 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 104 insertions(+), 3 deletions(-)

diffs (153 lines):

diff -r ac71fee66c03 -r 7e291aaf8dd1 distrib/sets/lists/comp/mi
--- a/distrib/sets/lists/comp/mi        Wed Mar 30 09:47:02 2011 +0000
+++ b/distrib/sets/lists/comp/mi        Wed Mar 30 10:06:58 2011 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: mi,v 1.1604 2011/03/26 19:55:27 christos Exp $
+#      $NetBSD: mi,v 1.1605 2011/03/30 10:06:58 jruoho Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -7591,6 +7591,7 @@
 ./usr/share/man/cat3/pam_vinfo.0               comp-c-catman           .cat,pam
 ./usr/share/man/cat3/pam_vprompt.0             comp-c-catman           .cat,pam
 ./usr/share/man/cat3/parsedate.0               comp-c-catman           .cat
+./usr/share/man/cat3/paths.0                   comp-c-catman           .cat
 ./usr/share/man/cat3/pause.0                   comp-c-catman           .cat
 ./usr/share/man/cat3/pcap.0                    comp-c-catman           .cat
 ./usr/share/man/cat3/pcap_activate.0           comp-c-catman           .cat
@@ -13630,6 +13631,7 @@
 ./usr/share/man/html3/pam_vinfo.html           comp-c-htmlman          html,pam
 ./usr/share/man/html3/pam_vprompt.html         comp-c-htmlman          html,pam
 ./usr/share/man/html3/parsedate.html           comp-c-htmlman          html
+./usr/share/man/html3/paths.html               comp-c-htmlman          html
 ./usr/share/man/html3/pause.html               comp-c-htmlman          html
 ./usr/share/man/html3/pcap.html                        comp-c-htmlman          html
 ./usr/share/man/html3/pcap_activate.html       comp-c-htmlman          html
@@ -19661,6 +19663,7 @@
 ./usr/share/man/man3/pam_vinfo.3               comp-c-man              .man,pam
 ./usr/share/man/man3/pam_vprompt.3             comp-c-man              .man,pam
 ./usr/share/man/man3/parsedate.3               comp-c-man              .man
+./usr/share/man/man3/paths.3                   comp-c-man              .man
 ./usr/share/man/man3/pause.3                   comp-c-man              .man
 ./usr/share/man/man3/pcap.3                    comp-c-man              .man
 ./usr/share/man/man3/pcap_activate.3           comp-c-man              .man
diff -r ac71fee66c03 -r 7e291aaf8dd1 share/man/man3/Makefile
--- a/share/man/man3/Makefile   Wed Mar 30 09:47:02 2011 +0000
+++ b/share/man/man3/Makefile   Wed Mar 30 10:06:58 2011 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.70 2011/03/19 04:59:44 jruoho Exp $
+#      $NetBSD: Makefile,v 1.71 2011/03/30 10:06:59 jruoho Exp $
 #      @(#)Makefile    8.2 (Berkeley) 12/13/93
 
 MAN=   _DIAGASSERT.3 __CONCAT.3 __UNCONST.3 CMSG_DATA.3 \
@@ -10,7 +10,7 @@
        cdefs.3 dirent.3 dlfcn.3 dl_iterate_phdr.3 end.3 \
        fast_divide32.3 ffs32.3 gcq.3 \
        ilog2.3 intro.3 inttypes.3 iso646.3 \
-       makedev.3 offsetof.3 queue.3 rbtree.3 sigevent.3 \
+       makedev.3 offsetof.3 paths.3 queue.3 rbtree.3 sigevent.3 \
        stdarg.3 stdbool.3 stddef.3 stdint.3 stdlib.3 sysexits.3 \
        tgmath.3 timeradd.3 timeval.3 tree.3 typeof.3 types.3 varargs.3
 
diff -r ac71fee66c03 -r 7e291aaf8dd1 share/man/man3/paths.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man3/paths.3    Wed Mar 30 10:06:58 2011 +0000
@@ -0,0 +1,98 @@
+.\" $NetBSD: paths.3,v 1.1 2011/03/30 10:06:59 jruoho Exp $
+.\"
+.\" Copyright (c) 2011 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Jukka Ruohonen.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd March 30, 2011
+.Os
+.Dt PATHS 3
+.Sh NAME
+.Nm paths
+.Nd default system paths
+.Sh SYNOPSIS
+.In paths.h
+.Sh DESCRIPTION
+The
+.In paths.h
+header defines some default paths used in
+.Nx .
+All defined constants are prefixed with
+.Dv _PATH .
+The constants include:
+.Bl -enum -offset indent
+.It
+The default user search path set by
+.Xr login 1
+and associated utilities such as
+.Xr rshd 8 .
+This is defined by
+.Dv _PATH_DEFPATH
+and includes directories such as
+.Pa /usr/bin
+and
+.Pa /usr/local/bin .
+.It
+Default paths for some utilities and device nodes.
+Examples include such paths as
+.Pa /dev/null
+.Pq Dv _PATH_DEVNULL ,
+.Pa /dev/mem
+.Pq Dv _PATH_MEM ,
+and
+.Pa /etc/nologin
+.Pq Dv _PATH_NOLOGIN ,
+among others.
+.It
+Paths for some default directories such as
+.Pa /dev
+.Pq Dv _PATH_DEV
+and
+.Pa /tmp
+.Pq Dv _PATH_TMP
+as well as paths for some miscellaneous utilities such as
+.Xr csh 1 ,
+.Pa /bin/csh
+.Pq Dv _PATH_CSHELL .
+.El
+.Sh SEE ALSO
+.Xr whereis 1 ,
+.Xr sysexits 3 ,
+.Xr types 3 ,
+.Xr hier 7
+.\"
+.\" XXX: Fill this.
+.\"
+.\" .Sh HISTORY
+.\" The
+.\" .In paths.h
+.\" header first appeared in
+.\" .Bx ????
+.Sh CAVEATS
+The
+.In paths.h
+header is specific to
+.Nx .



Home | Main Index | Thread Index | Old Index