diff options
Diffstat (limited to 'usr/src/man/man4')
189 files changed, 680 insertions, 55328 deletions
diff --git a/usr/src/man/man4/FSS.4 b/usr/src/man/man4/FSS.4 new file mode 100644 index 0000000000..33b0136c4f --- /dev/null +++ b/usr/src/man/man4/FSS.4 @@ -0,0 +1,231 @@ +.\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 2019 Joyent, Inc. +.\" +.\" 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] +.\" +.Dd December 17, 2019 +.Dt FSS 4 +.Os +.Sh NAME +.Nm FSS +.Nd Fair share scheduler +.Sh DESCRIPTION +The fair share scheduler (FSS) guarantees application performance by explicitly +allocating shares of CPU resources to projects. +A share indicates a project's +entitlement to available CPU resources. +Because shares are meaningful only in +comparison with other project's shares, the absolute quantity of shares is not +important. +Any number that is in proportion with the desired CPU entitlement +can be used. +.Pp +The goals of the FSS scheduler differ from the traditional time-sharing +scheduling class (TS). +In addition to scheduling individual LWPs, the FSS +scheduler schedules projects against each other, making it impossible for any +project to acquire more CPU cycles simply by running more processes +concurrently. +.Pp +A project's entitlement is individually calculated by FSS independently for +each processor set if the project contains processes bound to them. +If a +project is running on more than one processor set, it can have different +entitlements on every set. +A project's entitlement is defined as a ratio +between the number of shares given to a project and the sum of shares of all +active projects running on the same processor set. +An active project is one +that has at least one running or runnable process. +Entitlements are recomputed +whenever any project becomes active or inactive, or whenever the number of +shares is changed. +.Pp +Processor sets represent virtual machines in the FSS scheduling class and +processes are scheduled independently in each processor set. +That is, processes +compete with each other only if they are running on the same processor set. +When a processor set is destroyed, all processes that were bound to it are +moved to the default processor set, which always exists. +Empty processor sets +(that is, sets without processors in them) have no impact on the FSS scheduler +behavior. +.Pp +If a processor set contains a mix of TS/IA and FSS processes, the fairness of +the FSS scheduling class can be compromised because these classes use the same +range of priorities. +Fairness is most significantly affected if processes +running in the TS scheduling class are CPU-intensive and are bound to +processors within the processor set. +As a result, you should avoid having +processes from TS/IA and FSS classes share the same processor set. +RT and FSS +processes use disjoint priority ranges and therefore can share processor sets. +.Pp +As projects execute, their CPU usage is accumulated over time. +The FSS +scheduler periodically decays CPU usages of every project by multiplying it +with a decay factor, ensuring that more recent CPU usage has greater weight +when taken into account for scheduling. +The FSS scheduler continually adjusts +priorities of all processes to make each project's relative CPU usage converge +with its entitlement. +.Pp +While FSS is designed to fairly allocate cycles over a long-term time period, +it is possible that projects will not receive their allocated shares worth of +CPU cycles due to uneven demand. +This makes one-shot, instantaneous analysis of +FSS performance data unreliable. +.Pp +Note that share is not the same as utilization. +A project may be allocated 50% +of the system, although on the average, it uses just 20%. +Shares serve to cap a +project's CPU usage only when there is competition from other projects running +on the same processor set. +When there is no competition, utilization may be +larger than entitlement based on shares. +Allocating a small share to a busy +project slows it down but does not prevent it from completing its work if the +system is not saturated. +.Pp +The configuration of CPU shares is managed by the name server as a property of +the +.Xr project 5 +database. +In the following example, an entry in the +.Pa /etc/project +file sets the number of shares for project +.Sy x-files +to 10: +.Bd -literal -offset 2n +x-files:100::::project.cpu-shares=(privileged,10,none) +.Ed +.Pp +Projects with undefined number of shares are given one share each. +This means +that such projects are treated with equal importance. +Projects with 0 shares +only run when there are no projects with non-zero shares competing for the same +processor set. +The maximum number of shares that can be assigned to one project +is 65535. +.Pp +You can use the +.Xr prctl 1 +command to determine the current share +assignment for a given project: +.Bd -literal -offset 2n +$ prctl -n project.cpu-shares -i project x-files +.Ed +.Pp +or to change the amount of shares if you have root privileges: +.Bd -literal -offset 2n +# prctl -r -n project.cpu-shares -v 5 -i project x-files +.Ed +.Pp +See the +.Xr prctl 1 +man page for additional information on how to modify and +examine resource controls associated with active processes, tasks, or projects +on the system. +See +.Xr resource_controls 7 +for a description of the resource +controls supported in the current release of the Solaris operating system. +.Pp +By default, project +.Sy system +(project ID 0) includes all system daemons +started by initialization scripts and has an +.Dq unlimited +amount of shares. +That +is, it is always scheduled first no matter how many shares are given to other +projects. +.Pp +The following command sets FSS as the default scheduler for the system: +.Bd -literal -offset 2n +# dispadmin -d FSS +.Ed +.Pp +This change will take effect on the next reboot. +Alternatively, you can move +processes from the time-share scheduling class (as well as the special case of +init) into the FSS class without changing your default scheduling class and +rebooting by becoming +.Sy root , +and then using the +.Xr priocntl 1 +command, as shown in the following example: +.Bd -literal -offset 2n +# priocntl -s -c FSS -i class TS +# priocntl -s -c FSS -i pid 1 +.Ed +.Sh CONFIGURING SCHEDULER WITH DISPADMIN +You can use the +.Xr dispadmin 8 +command to examine and tune the FSS +scheduler's time quantum value. +Time quantum is the amount of time that a +thread is allowed to run before it must relinquish the processor. +The following +example dumps the current time quantum for the fair share scheduler: +.Bd -literal -offset 2n +$ dispadmin -g -c FSS + # + # Fair Share Scheduler Configuration + # + RES=1000 + # + # Time Quantum + # + QUANTUM=110 +.Ed +.Pp +The value of the QUANTUM represents some fraction of a second with the +fractional value determined by the reciprocal value of RES. +With the default +value of RES = 1000, the reciprocal of 1000 is \&.001, or milliseconds. +Thus, by +default, the QUANTUM value represents the time quantum in milliseconds. +.Pp +If you change the RES value using +.Xr dispadmin 8 +with the +.Fl r +option, you also change the QUANTUM value. +For example, instead of quantum of 110 with RES +of 1000, a quantum of 11 with a RES of 100 results. +The fractional unit is different while the amount of time is the same. +.Pp +You can use the +.Fl s +option to change the time quantum value. +Note that such changes are not preserved across reboot. +Please refer to the +.Xr dispadmin 8 +man page for additional information. +.Sh SEE ALSO +.Xr prctl 1 , +.Xr priocntl 1 , +.Xr priocntl 2 , +.Xr project 5 , +.Xr resource_controls 7 , +.Xr dispadmin 8 , +.Xr psrset 8 +.Pp +.%T System Administration Guide: Virtualization Using the Solaris Operating System diff --git a/usr/src/man/man4/Intro.4 b/usr/src/man/man4/Intro.4 index ce2f7eb2f7..2f7fabf221 100644 --- a/usr/src/man/man4/Intro.4 +++ b/usr/src/man/man4/Intro.4 @@ -1,3 +1,6 @@ +.\" Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 1989 AT&T +.\" Copyright 2020 Joyent, Inc. .\" .\" The contents of this file are subject to the terms of the .\" Common Development and Distribution License (the "License"). @@ -14,37 +17,193 @@ .\" fields enclosed by brackets "[]" replaced with your own identifying .\" information: Portions Copyright [yyyy] [name of copyright owner] .\" -.\" -.\" Copyright 2015 Nexenta Systems, Inc. All rights reserved. -.\" Copyright 1989 AT&T -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" -.Dd Mar 18, 2015 +.Dd January 6, 2020 .Dt INTRO 4 .Os .Sh NAME .Nm Intro , .Nm intro -.Nd introduction to file formats and configurations +.Nd introduction to special files .Sh DESCRIPTION -This section outlines the formats of various files and configurations of -various subsystems. -The C structure declarations for the file formats are given where applicable. -Usually, the headers containing these structure declarations can be found in the -directories -.Pa /usr/include -or -.Pa /usr/include/sys . -For inclusion in C language programs, however, the syntax -.Sy #include -.Sm off -< -.Em filename.h No > -.Sm on -or -.Sy #include -.Sm off -< -.Sy sys/ Em filename.h No > -.Sm on -should be used. +This section describes various device and network interfaces available on the +sysstem. +The types of interfaces described include character and block +devices, +.Sy STREAMS +modules, network protocols, file systems, and ioctl requests +for driver subsystems and classes. +.Pp +This section contains the following major collections: +.Bl -tag -width "xxxxx" +.It Pq Sy 4D +The system provides drivers for a variety of hardware devices, such as disk, +magnetic tapes, serial communication lines, mice, and frame buffers, as well +as virtual devices such as pseudo-terminals and windows. +.Pp +This section describes special files that refer to specific hardware +peripherals and device drivers. +.Sy STREAMS +device drivers are also described. +Characteristics of both the hardware device and the corresponding device driver +are discussed where applicable. +.Pp +An application accesses a device through that device's special file. +This +section specifies the device special file to be used to access the device as +well as application programming interface (API) information relevant to the use +of the device driver. +All device special files are located under the +.Pa /devices +directory. +The +.Pa /devices +directory hierarchy attempts to mirror the hierarchy of system +busses, controllers, and devices configured on the system. +Logical device names for special files in +.Pa /devices +are located under the +.Pa /dev +directory. +Although not every special file under +.Pa /devices +will have a corresponding logical entry under +.Pa /dev , +whenever possible, an +application should reference a device using the logical name for the device. +Logical device names are listed in the +.Sy FILES +section of the page for the device in question. +.Pp +This section also describes driver configuration where applicable. +Many device drivers have a driver configuration file of the form +.Em driver_name Ns \&.conf +associated with them (see +.Xr driver.conf 5 ) . +The configuration information stored in the driver +configuration file is used to configure the driver and the device. +Driver configuration files are located in +.Pa /kernel/drv +and +.Pa /usr/kernel/drv . +Driver configuration files for platform dependent +drivers are located in +.Pa /platform/`uname\ -i`/kernel/drv +where +.Pa `uname\ -i` +is the output of the +.Xr uname 1 +command with the +.Fl i +option. +.Pp +Some driver configuration files may contain user configurable properties. +Changes in a driver's configuration file will not take effect until the system +is rebooted or the driver has been removed and re-added (see +.Xr rem_drv 8 +and +.Xr add_drv 8 ) . +.It Pq Sy 4FS +This section describes the programmatic interface for several file systems +supported by SunOS. +.It Pq Sy 4I +This section describes ioctl requests which apply to a class of drivers or +subsystems. +For example, ioctl requests which apply to most tape devices are +discussed in +.Xr mtio 4I . +Ioctl requests relevant to only a specific +device are described on the man page for that device. +The page for the device +in question should still be examined for exceptions to the ioctls listed in +section 4I. +.It Pq Sy 4M +This section describes +.Sy STREAMS +modules. +Note that +.Sy STREAMS +drivers are discussed in section 4D. +.Xr streamio 4I +contains a list of ioctl requests used to manipulate +.Sy STREAMS +modules and interface with the +.Sy STREAMS +framework. +.Xr ioctl 2 +requests specific to a +.Sy STREAMS +module will be discussed on the man page for that module. +.It Pq Sy 4P +This section describes various network protocols available in SunOS. +SunOS supports both socket-based and +.Sy STREAMS Ns -based +network communications. +.Pp +The Internet protocol family, described in +.Xr inet 4P , +is the primary protocol family supported by SunOS, although the system can +support a number of others. +The raw interface provides low-level services, such as +packet fragmentation and reassembly, routing, addressing, and basic transport +for socket-based implementations. +Facilities for communicating using an +Internet-family protocol are generally accessed by specifying the +.Dv AF_INET +address family when binding a socket; see +.Xr socket 3SOCKET +for details. +.Pp +Major protocols in the Internet family include: +.Bl -bullet -offset indent +.It +The Internet Protocol (IP) itself, which supports the universal datagram +format, as described in +.Xr ip 4P . +This is the default protocol for +.Dv SOCK_RAW +type sockets within the +.Dv AF_INET +domain. +.It +The Transmission Control Protocol (TCP); see +.Xr tcp 4P . +This is the default protocol for +.Dv SOCK_STREAM +type sockets. +.It +The User Datagram Protocol (UDP); see +.Xr udp 4P . +This is the default +protocol for +.Dv SOCK_DGRAM +type sockets. +.It +The Address Resolution Protocol (ARP); see +.Xr arp 4P . +.It +The Internet Control Message Protocol (ICMP); see +.Xr icmp 4P . +.El +.El +.Sh SEE ALSO +.Xr ioctl 2 , +.Xr Intro 3 , +.Xr socket 3SOCKET , +.Xr st 4D , +.Xr mtio 4I , +.Xr streamio 4I , +.Xr arp 4P , +.Xr icmp 4P , +.Xr inet 4P , +.Xr ip 4P , +.Xr tcp 4P , +.Xr udp 4P , +.Xr driver.conf 5 , +.Xr add_drv 8 , +.Xr rem_drv 8 +.Pp +.%T System Administration Guide: IP Services +.Pp +.%T STREAMS Programming Guide +.Pp +.%T Writing Device Drivers diff --git a/usr/src/man/man4/Makefile b/usr/src/man/man4/Makefile index 941757d4f3..c367547dff 100644 --- a/usr/src/man/man4/Makefile +++ b/usr/src/man/man4/Makefile @@ -11,285 +11,22 @@ # # Copyright 2011, Richard Lowe -# Copyright 2015, Joyent, Inc. -# Copyright 2018 Nexenta Systems, Inc. -# Copyright 2018 Gary Mills -# Copyright 2021 OmniOS Community Edition (OmniOSce) Association. +# Copyright 2013 Nexenta Systems, Inc. All rights reserved. # include $(SRC)/Makefile.master -MANSECT= 4 +MANSECT= 4 -_MANFILES= Intro.4 \ - NISLDAPmapping.4 \ - a.out.4 \ - admin.4 \ - alias.4 \ - aliases.4 \ - au.4 \ - audit.log.4 \ - audit_class.4 \ - audit_event.4 \ - auth_attr.4 \ - autofs.4 \ - bart_manifest.4 \ - bart_rules.4 \ - bootparams.4 \ - cardbus.4 \ - compver.4 \ - contents.4 \ - contract.4 \ - copyright.4 \ - core.4 \ - crypt.conf.4 \ - crypto_certs.4 \ - ctf.4 \ - d_passwd.4 \ - dacf.conf.4 \ - dat.conf.4 \ - default_fs.4 \ - defaultdomain.4 \ - defaultrouter.4 \ - depend.4 \ - device_allocate.4 \ - device_contract.4 \ - device_maps.4 \ - devices.4 \ - dfstab.4 \ - dhcp_inittab.4 \ - dialups.4 \ - dir_ufs.4 \ - driver.conf.4 \ - ethers.4 \ - exec_attr.4 \ - fdi.4 \ - format.dat.4 \ - fspec.4 \ - fstypes.4 \ - ftp.4 \ - ftpusers.4 \ - fx_dptbl.4 \ - gateways.4 \ - group.4 \ - gsscred.conf.4 \ - hba.conf.4 \ - holidays.4 \ - hosts.4 \ - hosts.equiv.4 \ - hosts_access.4 \ - hosts_options.4 \ - ib.4 \ - ike.config.4 \ - ike.preshared.4 \ - ipf.4 \ - ipmon.4 \ - ipnat.4 \ - ippool.4 \ - inet_type.4 \ - inetd.conf.4 \ - init.4 \ - init.d.4 \ - inittab.4 \ - ipaddrsel.conf.4 \ - ipnodes.4 \ - issue.4 \ - kadm5.acl.4 \ - kdc.conf.4 \ - keytables.4 \ - krb5.conf.4 \ - ldapfilter.conf.4 \ - ldapsearchprefs.conf.4 \ - ldaptemplates.conf.4 \ - logadm.conf.4 \ - logindevperm.4 \ - loginlog.4 \ - magic.4 \ - mailer.conf.4 \ - mech.4 \ - mnttab.4 \ - mpapi.conf.4 \ - nca.if.4 \ - ncad_addr.4 \ - ncakmod.conf.4 \ - ncalogd.conf.4 \ - ncaport.conf.4 \ - ndmp.4 \ - ndpd.conf.4 \ - netconfig.4 \ - netgroup.4 \ - netid.4 \ - netmasks.4 \ - netrc.4 \ - networks.4 \ - nfs.4 \ - nfslog.conf.4 \ - nfssec.conf.4 \ - nodename.4 \ - nologin.4 \ - note.4 \ - notrouter.4 \ - nscd.conf.4 \ - nsmbrc.4 \ - nss.4 \ - nsswitch.conf.4 \ - overlay_files.4 \ - packingrules.4 \ - pam.conf.4 \ - passwd.4 \ - path_to_inst.4 \ - pci.4 \ - phones.4 \ - pkginfo.4 \ - pkgmap.4 \ - policy.conf.4 \ - power.conf.4 \ - printers.4 \ - printers.conf.4 \ - priv_names.4 \ - proc.4 \ - process.4 \ - prof_attr.4 \ - profile.4 \ - project.4 \ - protocols.4 \ - prototype.4 \ - pseudo.4 \ - publickey.4 \ - queuedefs.4 \ - rcmscript.4 \ - remote.4 \ - resolv.conf.4 \ - rmtab.4 \ - rpc.4 \ - rt_dptbl.4 \ - sasl_appname.conf.4 \ - scsi.4 \ - securenets.4 \ - sendmail.4 \ - service_bundle.4 \ - service_provider.conf.4 \ - services.4 \ - shadow.4 \ - sharetab.4 \ - shells.4 \ - slp.conf.4 \ - slpd.reg.4 \ - smb.4 \ - smbautohome.4 \ - smhba.conf.4 \ - sock2path.d.4 \ - space.4 \ - sulog.4 \ - syslog.conf.4 \ - system.4 \ - term.4 \ - terminfo.4 \ - timezone.4 \ - tnf_kernel_probes.4 \ - ts_dptbl.4 \ - ttydefs.4 \ - ttysrch.4 \ - ufsdump.4 \ - updaters.4 \ - user_attr.4 \ - utmp.4 \ - utmpx.4 \ - vfstab.4 \ - warn.conf.4 \ - ypfiles.4 \ - yppasswdd.4 \ - ypserv.4 \ - zoneinfo.4 +MANFILES= FSS.4 \ + Intro.4 \ + cpr.4 \ + ibmf.4 \ + swap.4 -sparc_MANFILES= sbus.4 +MANLINKS= intro.4 -i386_MANFILES= bhyve_config.4 \ - loader.conf.4 \ - sysbus.4 - -_MANLINKS= addresses.4 \ - devid_cache.4 \ - devname_cache.4 \ - dir.4 \ - dumpdates.4 \ - fbtab.4 \ - forward.4 \ - fs.4 \ - hosts.allow.4 \ - hosts.deny.4 \ - intro.4 \ - ipf.conf.4 \ - ipf6.conf.4 \ - ipmon.conf.4 \ - ipnat.conf.4 \ - ippool.conf.4 \ - mdi_ib_cache.4 \ - mdi_scsi_vhci_cache.4 \ - pci_unitaddr_persistent.4 \ - pcie.4 \ - qop.4 \ - rhosts.4 \ - TIMEZONE.4 \ - sendmail.cf.4 \ - snapshot_cache.4 \ - submit.cf.4 \ - wtmp.4 \ - wtmpx.4 - -i386_MANLINKS= isa.4 - -MANFILES= $(_MANFILES) $($(MACH)_MANFILES) -MANLINKS= $(_MANLINKS) $($(MACH)_MANLINKS) - -intro.4 := LINKSRC = Intro.4 - -addresses.4 := LINKSRC = aliases.4 -forward.4 := LINKSRC = aliases.4 - -fs.4 := LINKSRC = default_fs.4 - -devid_cache.4 := LINKSRC = devices.4 -devname_cache.4 := LINKSRC = devices.4 -mdi_ib_cache.4 := LINKSRC = devices.4 -mdi_scsi_vhci_cache.4 := LINKSRC = devices.4 -pci_unitaddr_persistent.4 := LINKSRC = devices.4 -snapshot_cache.4 := LINKSRC = devices.4 - -dir.4 := LINKSRC = dir_ufs.4 - -rhosts.4 := LINKSRC = hosts.equiv.4 - -TIMEZONE.4 := LINKSRC = init.4 - -hosts.allow.4 := LINKSRC = hosts_access.4 -hosts.deny.4 := LINKSRC = hosts_access.4 - -ipf.conf.4 := LINKSRC = ipf.4 -ipf6.conf.4 := LINKSRC = ipf.4 - -ipmon.conf.4 := LINKSRC = ipmon.4 - -ipnat.conf.4 := LINKSRC = ipnat.4 - -ippool.conf.4 := LINKSRC = ippool.4 - -fbtab.4 := LINKSRC = logindevperm.4 - -qop.4 := LINKSRC = mech.4 - -pcie.4 := LINKSRC = pci.4 - -sendmail.cf.4 := LINKSRC = sendmail.4 -submit.cf.4 := LINKSRC = sendmail.4 - -isa.4 := LINKSRC = sysbus.4 - -dumpdates.4 := LINKSRC = ufsdump.4 - -wtmp.4 := LINKSRC = utmp.4 - -wtmpx.4 := LINKSRC = utmpx.4 +intro.4 := LINKSRC = Intro.4 .KEEP_STATE: diff --git a/usr/src/man/man4/NISLDAPmapping.4 b/usr/src/man/man4/NISLDAPmapping.4 deleted file mode 100644 index 91a3cbe0e6..0000000000 --- a/usr/src/man/man4/NISLDAPmapping.4 +++ /dev/null @@ -1,1492 +0,0 @@ -'\" te -.\" Copyright (C) 2006, Sun Microsystems, Inc. All Rights Reserved -.\" 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 NISLDAPMAPPING 4 "November 22, 2021" -.SH NAME -NISLDAPmapping \- mapping file used by the NIS server components -.SH SYNOPSIS -.nf -\fB/var/yp/NISLDAPmapping\fR -.fi - -.SH DESCRIPTION -The \fBNISLDAPmapping\fR file specifies the mapping between NIS map entries and -equivalent Directory Information Tree (DIT) entries. -.sp -.LP -The presence of \fB/var/yp/NISLDAPmapping\fR on a NIS master server causes that -server to obtain NIS data from LDAP. See \fBypserv\fR(4). If -\fB/var/yp/NISLDAPmapping\fR is present but the connection configuration file -that is defined in \fB/etc/default/ypserv\fR cannot be found, a warning is -logged. See \fBypserv\fR(1M). -.sp -.LP -NIS slave servers always obtain their data from a NIS master server, whether or -not that server is getting data from LDAP, and ignore the -\fB/var/yp/NISLDAPmapping\fR file. -.sp -.LP -A simple \fBNISLDAPmapping\fR file is created using \fBinityp2l\fR(1M). You can -customize your \fBNISLDAPmapping\fR file as you require. -.sp -.LP -Each attribute defined below can be specified -in \fB/var/yp/NISLDAPmapping\fR or as an LDAP attribute. If both are -specified, then the attribute in \fB/var/yp/NISLDAPmapping\fR (including empty -values) takes precedence. -.sp -.LP -A continuation is indicated by a '\e' (backslash) in the last position, -immediately before the newline of a line. Characters are escaped, that is, -exempted from special interpretation, when preceded by a backslash character. -.sp -.LP -The '#' (hash) character starts a comment. White space is either ASCII space or -a horizontal tab. In general, lines consist of optional white space, an -attribute name, at least one white space character, and an attribute value. -.SH EXTENDED DESCRIPTION -.SS "File Syntax" -Repeated fields, with separator characters, are described by the following -syntax: -.sp -.ne 2 -.na -\fBOne or more entries\fR -.ad -.RS 24n -entry:entry:entry -.sp -.in +2 -.nf -entry[":"...] -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fBZero or more entries\fR -.ad -.RS 24n -.sp -.in +2 -.nf -[entry":"...] -.fi -.in -2 - -.RE - -.SS "Attributes" -Attributes generally apply to one more more NIS maps. Map names can be -specified either on their own, that is in \fBpasswd.byname\fR, in which case -they apply to all domains, or for individual NIS domains, for example, in -\fBpasswd.byname,example.sun.uk\fR. Where a map is mentioned in more than one -attribute, both versions are applied. If any parts of the attributes are in -conflict, the domain specific version takes precedence over the non-domain -specific version. -.sp -.LP -Each domain specific attributes must appear in \fBNISLDAPmapping\fR before any -related non-domain specific attribute. If non-domain specific attributes appear -first, behavior may be unpredictable. Errors are logged when non-domain -specific attributes are found first. -.sp -.LP -You can associate a group of map names with a \fBdatabaseId\fR. In effect, a -macro is expanded to the group of names. Use this mechanism where the same -group of names is used in many attributes or where domain specific map names -are used. Then, you can make any changes to the domain name in one place. -.sp -.LP -Unless otherwise noted, all elements of the syntaxes below may be surrounded by -white space. Separator characters and white space must be escaped if they are -part of syntactic elements. -.sp -.LP -The following attributes are recognized. -.sp -.ne 2 -.na -\fB\fBnisLDAPdomainContext\fR\fR -.ad -.sp .6 -.RS 4n -The context to use for a NIS domain. -.sp -The syntax for \fBnisLDAPdomainContext\fR is: -.sp -.in +2 -.nf -NISDomainName ":" context -.fi -.in -2 - -The following is an example of the \fBnisLDAPdomainContext\fR attribute: -.sp -.in +2 -.nf -domain.one : dc=site, dc=example, dc=com -.fi -.in -2 - -The mapping file should define the context for each domain before any other -attribute makes use of the \fBNISDomainName\fR specified for that domain. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPyppasswddDomains\fR\fR -.ad -.sp .6 -.RS 4n -Lists the domains for which password changes should be made. NIS password -change requests do not specify the domains in which any given password should -be changed. In traditional NIS this information is effectively hard coded in -the NIS makefile. -.sp -The syntax for the \fBnisLDAPyppasswddDomains\fR attribute is: -.sp -.in +2 -.nf -domainname -.fi -.in -2 - -If there are multiple domains, use multiple \fBnisLDAPyppasswddDomain\fR -entries with one domainname per entry. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPdatabaseIdMapping\fR\fR -.ad -.sp .6 -.RS 4n -Sets up an alias for a group of NIS map names. There is no default value. -.sp -The syntax for the \fBnisLDAPdatabaseIdMapping\fR attribute is: -.sp -.in +2 -.nf -databaseId ":" ["["indexlist"]"] mapname[" "...] -.fi -.in -2 - -where -.sp -.in +2 -.nf -databaseId = Label identifying a (subset of a) NIS - object for mapping purposes. -indexlist = fieldspec[","...] -fieldspec = fieldname "=" fieldvalue -fieldname = The name of a entry field as defined in - nisLDAPnameFields. -fieldvalue = fieldvaluestring | \e" fieldvaluestring \e" -.fi -.in -2 - -\fBindexlist\fR is used for those cases where it is necessary to select a -subset of entries from a NIS map. The subset are those NIS entries that match -the \fBindexlist\fR. If there are multiple specifications indexed for a -particular NIS map, they are tried in the order retrieved until one matches. -Note that retrieval order usually is unspecified for multi-valued LDAP -attributes. Hence, if using indexed specifications when -\fBnisLDAPdatabaseIdMapping\fR is retrieved from LDAP, make sure that the -subset match is unambiguous. -.sp -If the \fBfieldvaluestring\fR contains white space or commas, it must either be -surrounded by double quotes, or the special characters must be escaped. -Wildcards are allowed in the \fBfieldvaluestring\fR. See Wildcards. -.sp -To associate the \fBpasswd.byname\fR and \fBpasswd.byuid\fR maps with the -\fBpasswd databaseId\fR: -.sp -.in +2 -.nf -passwd:passwd.byname passwd.byuid -.fi -.in -2 - -The \fBpasswd\fR and \fBpasswd.adjunct\fR \fBdatabaseIds\fR receive special -handling. In addition to its normal usage, \fBpasswd\fR defines which maps -\fByppasswdd\fR is to update when a \fBpasswd\fR is changed. In addition to its -normal usage \fBpasswd.adjunct\fR defines which maps \fByppasswdd\fR is to -update when an adjunct \fBpasswd\fR is changed. -.sp -You may not alias a single map name to a different name, as the results are -unpredictable. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPentryTtl\fR\fR -.ad -.sp .6 -.RS 4n -Establish TTLs for NIS entries derived from LDAP. -.sp -The syntax for the \fBnisLDAPentryTtl\fR attribute is: -.sp -.in +2 -.nf -mapName[" "...]":" - initialTTLlo ":" initialTTLhi ":" runningTTL -.fi -.in -2 - -where -.sp -.ne 2 -.na -\fB\fBinitialTTLlo\fR\fR -.ad -.RS 16n -The lower limit for the initial \fBTTL\fR (in seconds) for data read from LDAP -when the \fBypserv\fR starts. If the \fBinitialTTLhi\fR also is specified, the -actual \fBinitialTTL\fR will be randomly selected from the interval -\fBinitialTTLlo\fR to \fBinitialTTLhi\fR, inclusive. Leaving the field empty -yields the default value of 1800 seconds. -.RE - -.sp -.ne 2 -.na -\fB\fBinitialTTLhi\fR\fR -.ad -.RS 16n -The upper limit for the initial TTL. If left empty, defaults to 5400 seconds. -.RE - -.sp -.ne 2 -.na -\fB\fBrunningTTL\fR\fR -.ad -.RS 16n -The TTL (in seconds) for data retrieved from LDAP while the ypserv is running. -Leave the field empty to obtain the default value of 3600 seconds. -.RE - -If there is no specification of \fBTTL\fRs for a particular map, the default -values are used. -.sp -If the \fBinitialTTLlo\fR and \fBinitialTTLhi\fR have the same value, the -effect will be that all data known to the \fBypserv\fR at startup times out at -the same time. Depending on NIS data lookup patterns, this could cause spikes -in ypserv-to-LDAP traffic. In order to avoid that, you can specify different -\fBinitialTTLlo\fR and \fBinitialTTLhi\fR values, and obtain a spread in -initial TTLs. -.sp -The following is an example of the \fBnisLDAPentryTtl\fR attribute used to -specify that entries in the NIS host maps read from LDAP should be valid for -four hours. When \fBypserv\fR restarts, the disk database entries are valid for -between two and three hours. -.sp -.in +2 -.nf -hosts.byname hosts.byaddr:7200:10800:14400 -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPobjectDN\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the connection between a group of NIS maps and the LDAP directory. -This attribute also defines the 'order' of the NIS maps. When NIS maps are bulk -copied to or from the DIT, they are processed in the same order as related -\fBnisLDAPobjectDN\fR attributes appear in \fB/var/yp/NISLDAPmapping.\fR -.sp -The syntax for the \fBnisLDAPobjectDN\fR\ attribute is: -.sp -.in +2 -.nf -mapName[" "...] ":" objectDN *( ";" objectDN ) -.fi -.in -2 - -where -.sp -.in +2 -.nf -objectDN = readObjectSpec [":"[writeObjectSpec]] -readObjectSpec = [baseAndScope [filterAttrValList]] -writeObjectSpec = [baseAndScope [attrValList]] -baseAndScope = [baseDN] ["?" [scope]] -filterAttrValList = ["?" [filter | attrValList]]] -scope = "base" | "one" | "sub" -attrValList = attribute "=" value - *("," attribute "=" value) -.fi -.in -2 - -The \fBbaseDN\fR defaults to the value of the \fBnisLDAPdomainContext\fR -attribute for the accessed domain. If the \fBbaseDN\fR ends in a comma, the -\fBnisLDAPdomainContext\fR value is appended. -.sp -\fBscope\fR defaults to one. \fBscope\fR has no meaning and is ignored in a -\fBwriteObjectSpec\fR. -.sp -The \fBfilter\fR is an LDAP search filter and has no default value. -.sp -The \fBattrValList\fR is a list of attribute and value pairs. There is no -default value. -.sp -As a convenience, if an \fBattrValList\fR is specified in a -\fBreadObjectSpec\fR, it is converted to a search filter by ANDing together the -attributes and the values. For example, the attribute and value list: -.sp -.in +2 -.nf -objectClass=posixAccount,objectClass=shadowAccount -.fi -.in -2 - -is converted to the filter: -.sp -.in +2 -.nf -(&(objectClass=posixAccount)\e - (objectClass=shadowAccount)) -.fi -.in -2 - -Map entries are mapped by means of the relevant mapping rules in the -\fBnisLDAPnameFields\fR and \fBnisLDAPattributeFromField\fR . -.sp -If a \fBwriteObjectSpec\fR is omitted, the effect is one of the following: -.RS +4 -.TP -.ie t \(bu -.el o -If there is no trailing colon after the \fBreadObjectSpec\fR, then there is no -write at all. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -If there is a colon after the \fBreadObjectSpec\fR, then \fBwriteObjectSpec\fR -equals \fBreadObjectSpec\fR. -.RE -The following is an example of a \fBnisLDAPobjectDN\fR attribute declaration -that gets the \fBhosts.byaddr\fR map entries from the \fBou=Hosts\fR container -under the default search base and writes to the same place. -.sp -.in +2 -.nf -hosts.byaddr:ou=Hosts,?one?objectClass=ipHost: -.fi -.in -2 - -The following is an example of a \fBnisLDAPobjectDN\fR attribute declaration -that obtains \fBpasswd\fR map entries from the \fBou=People\fR containers under -the default search base, and also from \fBdc=another,dc=domain\fR. -.sp -.in +2 -.nf -passwd:ou=People,?one?\e - objectClass=shadowAccount,\e - objectClass=posixAccount:;\e - ou=People,dc=another,dc=domain,?one?\e - objectClass=shadowAccount,\e - objectClass=posixAccount -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPnameFields\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the content of entries in a NIS map and how they should be broken -into named fields. \fBnisLDAPnameFields\fR is required because NIS -maps do not store information in named fields. -.sp -The syntax for the \fBnisLDAPnameFields\fR attribute is as follows: -.sp -.in +2 -.nf -"nisLDAPnameFields" mapName ":" "(" matchspec "," fieldNames ")" -fieldName = nameOrArrayName[","...] -nameOrArrayName = Name of field or 'array' of repeated fields. -matchspec = \e" formatString \e" -.fi -.in -2 - -\fBformatString\fR may contain a list of \fB%s\fR and \fB%a\fR elements each -of which represents a single named field or a list of repeated fields. A -\fB%a\fR field is interpreted as an IPv4 address or an IPv6 address in -preferred format. If an IPv6 address in non preferred format is found, then it -is converted and a warning is logged. -.sp -Where there are a list of repeated fields, the entire list is stored as one -entry. The fields are broken up into individual entries, based on the internal -separator, at a latter stage. Other characters represent separators which must -be present. Any separator, including whitespace, specified by the -\fBformatString\fR, may be surrounded by a number of whitespace and tab -characters. The whitespace and tab characters are ignored. -.sp -Regardless of the content of this entry some \fBfieldNames\fR are reserved: -.sp -.ne 2 -.na -\fB\fBrf_key\fR\fR -.ad -.RS 18n -The DBM key value. -.RE - -.sp -.ne 2 -.na -\fB\fBrf_ipkey\fR\fR -.ad -.RS 18n -The DBM key value handled as an IP address. See the discussion of \fB%a\fR -fields. -.RE - -.sp -.ne 2 -.na -\fB\fBrf_comment\fR\fR -.ad -.RS 18n -Everything following the first occurrence of a symbol. \fBrf_comment\fR is -defined by \fBnisLDAPcommentChar\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBrf_domain\fR\fR -.ad -.RS 18n -The name of the domain in which the current NIS operation is being carried out. -.RE - -.sp -.ne 2 -.na -\fB\fBrf_searchipkey\fR\fR -.ad -.RS 18n -The \fBrf_searchkey\fR value handled as an IP address. See the discussion of -\fB%a\fR fields above. -.RE - -.sp -.ne 2 -.na -\fB\fBrf_searchkey\fR\fR -.ad -.RS 18n -See the description under \fBnisLDAPattributeFromField\fR below. -.RE - -For example, the \fBrpc.bynumber\fR map has the format: -.sp -.in +2 -.nf -name number alias[" "...] -.fi -.in -2 - -The NIS to LDAP system is instructed to break it into a name, a number, and an -array of alias field by the following entry in the mapping file: -.sp -.in +2 -.nf -nisLDAPnameFields rpc.bynumber : \e - "%s %s %s", name,number,aliases) -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPsplitFields\fR\fR -.ad -.sp .6 -.RS 4n -Defines how a field, or list of fields, named by \fBnisLDAPnameFields\fR is -split into subfields. The original field is compared with each line of this -attribute until one matches. When a match is found named subfields are -generated. In latter operations subfield names can be used in the same way as -other field names. -.sp -The syntax for the \fBnisLDAPsplitFields\fR attribute is as follows: -.sp -.in +2 -.nf -"nisLDAPsplitFields" fieldName ":" splitSpec[","...] -splitSpec = "(" matchspec "," subFieldNames ")" -fieldName = Name of a field from nisLDAPnameFields -subFieldNames = subFieldname[","...] -matchspec = \e" formatString \e" -.fi -.in -2 - -The netgroup \fBmemberTriples\fR can have format \fB(host, user, domain)\fR or -\fBgroupname\fR. The format is specified by the attribute: -.sp -.in +2 -.nf -nisLDAPsplitField memberTriple: \e - ("(%s,%s,%s)", host, user, domain) , \e - ("%s", group) -.fi -.in -2 - -Later operations can then use field names \fBhost\fR, \fBuser\fR, \fBdomain\fR, -\fBgroup\fR or \fBmemberTriple\fR. Because lines are processed in order, if -\fBhost\fR, \fBuser\fR and \fBdomain\fR are found, \fBgroup\fR will not be -generated. -.sp -Several maps and databaseIds may contain fields that are to be split in the -same way. As a consequence, the names of fields to be split must be unique -across all maps and databaseIds. -.sp -Only one level of splitting is supported. That is, a subfield cannot be split -into further subfields. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPrepeatedFieldSeparators\fR\fR -.ad -.sp .6 -.RS 4n -Where there is a list of repeated, splittable fields, -\fBnisLDAPrepeatedFieldSeparators\fR specifies which characters separate -instances of the splittable field. -.sp -The syntax for the \fBnisLDAPrepeatedFieldSeparators\fR attribute is as -follows: -.sp -.in +2 -.nf -"nisLDAPrepeatedFieldSeparators" fieldName \e"sepChar[...]\e" -sepChar = A separator character. -.fi -.in -2 - -The default value is space or tab. If repeated splittable fields are adjacent, -that is, there is no separating character, then the following should be -specified: -.sp -.in +2 -.nf -nisLDAPrepeatedFieldSeparators netIdEntry: "" -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPcommentChar\fR\fR -.ad -.sp .6 -.RS 4n -Specifies which character represents the start of the special comment field in -a given NIS map. If this attribute is not present then the default comment -character \fB#\fR is used. -.sp -To specify that a map uses an asterisk to mark the start of comments. -.sp -.in +2 -.nf -nisLDAPcommentChar mapname : '*' -.fi -.in -2 - -If a map cannot contain comments, then the following attribute should be -specified. -.sp -.in +2 -.nf -nisLDAPcommentChar mapname : '' -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPmapFlags\fR\fR -.ad -.sp .6 -.RS 4n - Indicates if \fBYP_INTERDOMAIN\fR or \fBYP_SECURE\fR entries should be created -in a map. Using \fBnisLDAPmapFlags\fR is equivalent to running -\fBmakedbm\fR(1M) with the \fB-b\fR or the \fB-s\fR option. When a map is -created from the contents of the DIT, the mapping file attribute is the only -source for the \fBYP_INTERDOMAIN\fR or \fBYP_SECURE\fR entries. -.sp -The syntax for the \fBnisLDAPmapFlags\fR attribute is as follows: -.sp -.in +2 -.nf -"nisLDAPmapFlags" mapname ":" ["b"]["s"] -.fi -.in -2 - -By default neither entry is created. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPfieldFromAttribute\fR\fR -.ad -.sp .6 -.RS 4n -Specifies how a NIS entries field values are derived from LDAP attribute -values. -.sp -The syntax for the \fBnisLDAPfieldFromAttribute\fR attribute is as follows: -.sp -.in +2 -.nf -mapName ":" fieldattrspec *("," fieldattrspec) -.fi -.in -2 - -The format of \fBfieldattrspec\fR is shown below at Field and Attribute -Conversion Syntax. -.sp -To map by direct copy and assignment the value of the \fBipHostNumber\fR -attribute to the \fBaddr\fR named field, for example: -.sp -.in +2 -.nf -addr=ipHostNumber -.fi -.in -2 - -Formats for the named field and attribute conversion syntax are discussed -below, including examples of complex attribute to field conversions. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPattributeFromField\fR\fR -.ad -.sp .6 -.RS 4n - Specifies how an LDAP attribute value is derived from a NIS entry field -value. -.sp -The syntax for the \fBnisLDAPattributeFromField\fR attribute is as follows: -.sp -.in +2 -.nf -mapName ":" fieldattrspec *("," fieldattrspec ) -.fi -.in -2 - -The format of \fBfieldattrspec\fR is shown below at Field and Attribute -Conversion Syntax. -.sp -As a special case, if the \fBdn\fR attribute value derived from a -\fBfieldattrspec\fR ends in a comma ("\fB,\fR"), the domains context from -\fBnisLDAPdomainContext\fR is appended. -.sp -Use the following example to map the value of the \fBaddr\fR field to the -\fBipHostNumber\fR attribute by direct copy and assignment: -.sp -.in +2 -.nf -ipHostNumber=addr -.fi -.in -2 - -All relevant attributes, including the \fBdn\fR, must be specified. -.sp -For every map it must be possible to rapidly find a DIT entry based on its key. -There are some maps for which a NIS to LDAP mapping for the key is not -desirable, so a key mapping cannot be specified. In these cases a mapping that -uses the reserved \fBrf_searchkey\fR must be specified. Mappings that use this -field name are ignored when information is mapped into the DIT. -.RE - -.SS "Field and Attribute Conversion Syntax" -The general format of a \fBfieldattrspec\fR is: -.sp -.in +2 -.nf -fieldattrspec = lhs "=" rhs -lhs = lval | namespeclist -rhs = rval | [namespec] -namespeclist = namespec | "(" namespec *("," namespec) ")" -.fi -.in -2 - -.sp -.LP -The \fBlval\fR and \fBrval\fR syntax are defined below at Values. The format of -a \fBnamespec\fR is: -.sp -.ne 2 -.na -\fB\fBnamespec\fR\fR -.ad -.RS 16n -.sp -.in +2 -.nf -["ldap:"] attrspec [searchTriple] | ["yp:"] fieldname -[mapspec] -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBfieldname\fR\fR -.ad -.RS 16n -.sp -.in +2 -.nf -field | "(" field ")" -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBattrspec\fR\fR -.ad -.RS 16n -.sp -.in +2 -.nf -attribute | "(" attribute ")" -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBsearchTriple\fR\fR -.ad -.RS 16n -.sp -.in +2 -.nf -":" [baseDN] ["?" [scope] ["?" [filter]]] -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBbaseDN\fR\fR -.ad -.RS 16n -Base DN for search -.RE - -.sp -.ne 2 -.na -\fB\fBfilter\fR\fR -.ad -.RS 16n -LDAP search filter -.RE - -.sp -.ne 2 -.na -\fB\fBmapspec\fR\fR -.ad -.RS 16n -Map name -.RE - -.sp -.LP -The repository specification in a \fBnamespec\fR defaults is as follows: -.RS +4 -.TP -.ie t \(bu -.el o -For assignments to a field: -.RS - -.sp -.ne 2 -.na -\fBon the \fBLHS\fR\fR -.ad -.RS 14n -yp -.RE - -.sp -.ne 2 -.na -\fBon the \fBRHS\fR\fR -.ad -.RS 14n -ldap -.RE - -.RE - -NIS field values on the \fBRHS\fR are those that exist before the NIS entry is -modified. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -For assignments to an attribute: -.RS - -.sp -.ne 2 -.na -\fBon the \fBLHS\fR\fR -.ad -.RS 14n -ldap -.RE - -.sp -.ne 2 -.na -\fBon the \fBRHS\fR\fR -.ad -.RS 14n -yp -.RE - -.RE - -Attribute values on the \fBRHS\fR are those that exist before the LDAP entry is -modified. -.RE -.sp -.LP -When the field or attribute name is enclosed in parenthesis, it denotes a list -of field or attribute values. For attributes, the meaning is the list of all -attributes of that name, and the interpretation depends on the context. See the -discussion at Values. The list specification is ignored when a -\fBsearchTriple\fR or \fBmapspec\fR is supplied. -.sp -.LP -For fields, the \fBfieldname\fR syntax is used to map multiple attribute -instances to multiple NIS entries. -.sp -.LP -The \fBsearchTriple\fR can be used to specify an attribute from a location -other than the read or write target. The defaultvalues are as follows: -.sp -.ne 2 -.na -\fB\fBbaseDN\fR\fR -.ad -.RS 10n -If \fBbaseDN\fR is omitted, the default is the current \fBobjectDN\fR. If the -\fBbaseDN\fR ends in a comma, the context of the domain is appended from -\fBnisLDAPdomainContext\fR . -.RE - -.sp -.ne 2 -.na -\fB\fBscope\fR\fR -.ad -.RS 10n -one -.RE - -.sp -.ne 2 -.na -\fB\fBfilter\fR\fR -.ad -.RS 10n -Empty -.RE - -.sp -.LP -Similarly, the \fBmapspec\fR can be used to specify a field value from a NIS -map other than the one implicitly indicated by the \fBmapName\fR. If -\fBsearchTriple\fR or \fBmapspec\fR is explicitly specified in a -\fBnamespec\fR, the retrieval or assignment, whether from or to LDAP or NIS, is -performed without checking if read and write are enabled for the LDAP container -or NIS map. -.sp -.LP -The omission of the \fBnamespec\fR in an \fBrhs\fR is only allowed if the -\fBlhs\fR is one or more attributes. The effect is to delete the specified -attribute(s). In all other situations, an omitted \fBnamespec\fR means that the -rule is ignored. -.sp -.LP -The \fBfilter\fR can be a value. See Values. For example, to find the -\fBipHostNumber\fRthat uses the \fBcn\fR, you specify the following in the -\fBfilter\fR field: -.sp -.in +2 -.nf -ldap:ipHostNumber:?one?("cn=%s", (cname, "%s.*")) -.fi -.in -2 - -.sp -.LP -In order to remove ambiguity, the unmodified value of a single field or -attribute must be specified as the following when used in the \fBfilter\fR -field. -.sp -.in +2 -.nf -("%s", namespec) -.fi -.in -2 - -.sp -.LP -If the \fBfilter\fR is not specified, the scope will be base, and the -\fBbaseDN\fR is assumed to be the \fBDN\fR of the entry that contains the -attribute to be retrieved or modified. To use previously existing field or -attribute values in the mapping rules requires a lookup to find those values. -Obviously, this adds to the time required to perform the modification. Also, -there is a window between the time when a value is retrieved and then slightly -later stored back. If the values have changed in the meantime, the change may -be overwritten. -.sp -.LP -When \fBfieldattrspecs\fR are grouped into rule sets, in the value of a -\fBnisLDAPfieldFromAttribute\fR or \fBnisLDAPattributeFromField\fR attribute, -the evaluation of the \fBfieldattrspecs\fR proceed in the listed order. -However, evaluation may be done in parallel for multiple \fBfieldattrspecs\fR. -If there is an error when evaluating a certain \fBfieldattrspec\fR, including -retrieval or assignment of entry or field values, the extent to which the other -\fBfieldattrspec\fR rules are evaluated is unspecified. -.SS "Wildcards" -Where wildcard support is available, it is of the following limited form: -.sp -.ne 2 -.na -\fB\fB*\fR\fR -.ad -.RS 9n -Matches any number of characters -.RE - -.sp -.ne 2 -.na -\fB\fB[x]\fR\fR -.ad -.RS 9n -Matches the character x -.RE - -.sp -.ne 2 -.na -\fB\fB[x-y]\fR\fR -.ad -.RS 9n -Matches any character in the range x to y, inclusive -.RE - -.sp -.LP -Combinations such as \fB[a-cA-C0123]\fR are also allowed, which would match any -one of a, b, c, A, B, C, 0, 1, 2, or 3. -.SS "Substring Extraction" -.in +2 -.nf -substringextract = "(" namespec "," matchspec ")" -name = field or attribute name -matchspec = -.fi -.in -2 - -.sp -.LP -The \fBmatchspec\fR is a string like the \fBsscanf\fR(3C) format string, except -that there may be at most one format specifier, a single \fB%s\fR. The output -value of the \fBsubstringextract\fR is the substring that matches the location -of the \fB%s\fR. -.sp -.LP -If there is no \fB%s\fR in the formatstring, it must instead be a single -character, which is assumed to be a field separator for the \fBnamespec\fR. The -output values are the field values. Wild cards are supported. If there is no -match, the output value is the empty string, " ". -.sp -.LP -For example, if the \fBfieldcname\fR has the value -\fBuser.some.domain.name.\fR, the value of the expression: -.sp -.in +2 -.nf -(cname, "%s.*") -.fi -.in -2 - -.sp -.LP -is \fBuser\fR, which can be used to extract the user name from a NIS principal -name. -.sp -.LP -Similarly, use this expression to extract the third of the colon-separated -fields of the shadow field: -.sp -.in +2 -.nf -(shadow, "*:*:%s:*") -.fi -.in -2 - -.sp -.LP -This form can be used to extract all of the shadow fields. However, a simpler -way to specify that special case is: -.sp -.in +2 -.nf -(shadow, ":") -.fi -.in -2 - -.SS "Values" -.in +2 -.nf -lval = "(" formatspec "," namespec *("," namespec) ")" -rval = "(" formatspec ["," namelist ["," elide] ] ")" - -namelist = name_or_sse *( "," name_or_sse) -name_or_sse = namespec | removespec | substringextract -removespec = list_or_name "-" namespec -list_or_name = "(" namespec ")" | namespec -formatspec = -formatstring = A string combining text and % field specifications -elide = -singlechar = Any character -.fi -.in -2 - -.sp -.LP -The syntax above is used to produce \fBrval\fR values that incorporate field or -attribute values, in a manner like \fBsprintf\fR(3C), or to perform assignments -to \fBlval\fR like \fBsscanf\fR(3C). One important restriction is that the -format specifications,\fB%\fR plus a single character, use the designations -from \fBber_printf\fR(3LDAP). Thus, while \fB%s\fR is used to extract a string -value, \fB%i\fR causes BER conversion from an integer. Formats other than -\fB%s\fR, for instance, \fB%i\fR, are only meaningfully defined in simple -format strings without any other text. -.sp -.LP -The following \fBber_printf()\fR format characters are recognized: -.sp -.in +2 -.nf -b i n o s -.fi -.in -2 - -.sp -.LP -If there are too few format specifiers, the format string may be repeated as -needed. -.sp -.LP -When used as an \fBlval\fR, there is a combination of pattern matching and -assignment, possibly to multiple fields or attributes. -.sp -.LP -In an assignment to an attribute, if the value of the \fBaddr\fR field is -\fB1.2.3.4\fR, the \fBrval\fR: -.sp -.in +2 -.nf -("ipNetworkNumber=%s,", addr) -.fi -.in -2 - -.sp -.LP -produces the value \fBipNetworkNumber=1.2.3.4,\fR, while: -.sp -.in +2 -.nf -("(%s,%s,%s)", host, user, domain) -.fi -.in -2 - -.sp -.LP -results in: -.sp -.in +2 -.nf -(assuming host="xyzzy", user="-", domain="x.y.z") -"(xyzzy,-,x.y.z)" -.fi -.in -2 - -.sp -.LP -The elide character feature is used with attribute lists. So: -.sp -.in +2 -.nf -("%s,", (mgrprfc822mailmember), ",") -.fi -.in -2 - -.sp -.LP -concatenates all \fBmgrprfc822mailmember\fR values into one comma-separated -string, and then elides the final trailing comma. Thus, for -.sp -.in +2 -.nf -mgrprfc822mailmember=usera -mgrprfc822mailmember=userb -mgrprfc822mailmember=userc -.fi -.in -2 - -.sp -.LP -the value would be: -.sp -.in +2 -.nf -usera,userb,userc -.fi -.in -2 - -.sp -.LP -As a special case, to combine an \fBLHS\fR extraction with an \fBRHS\fR -implicit list creates multiple entries and values. So -.sp -.in +2 -.nf -("(%s,%s,%s)", host, user, domain)=(nisNetgroupTriple) -.fi -.in -2 - -.sp -.LP -creates one NIS entry for each \fBnisNetgroupTriple\fR value. -.sp -.LP -The \fB\&'removespec'\fR form is used to exclude previously assigned fields -values from a list. So, if an LDAP entry contains: -.sp -.in +2 -.nf -name: foo -cn: foo -cn: foo1 -cn: foo2 -.fi -.in -2 - -.sp -.LP -and the mapping file specifies : -.sp -.in +2 -.nf -myName = name, \e -myAliases = ("%s ", (cn) - yp:myName, " ") -.fi -.in -2 - -.sp -.LP -then the following assignments are carried out: -.RS +4 -.TP -1. -Assign value \fBfoo\fR to \fBmyName\fR -.RE -.RS +4 -.TP -2. -Assign value \fBfoo foo1 foo2\fR to \fBmyAliases\fR -.RE -.RS +4 -.TP -3. -Remove value of \fBmyName\fR from value \fBmyAliases\fR -.RE -.sp -.LP -This results in the field values \fBmyName\fR is set to \fBfoo\fR, and -\fBmyAliases\fR is set to \fBfoo1 foo2\fR. -.SS "Assignments" -The assignment syntax, also found at Field and Attribute Conversion Syntax, is -as follows: -.sp -.in +2 -.nf -fieldattrspec = lhs "=" rhs -lhs = lval | namespeclist -rhs = rval | namespec -namespeclist = namespec | "(" namespec *("," namespec) ")" -.fi -.in -2 - -.sp -.LP -The general form of a simple assignment, which is a one-to-one mapping of field -to attribute, is: -.sp -.in +2 -.nf -("%s", fieldname)=("%s", attrname) -.fi -.in -2 - -.sp -.LP -As a convenient shorthand, this can also be written as: -.sp -.in +2 -.nf -fieldname=attrname -.fi -.in -2 - -.sp -.LP -A list specification, which is a name enclosed in parenthesis, can be used to -make many-to-many assignments. The expression: -.sp -.in +2 -.nf -(fieldname)=(attrname) -.fi -.in -2 - -.sp -.LP -where there are multiple instances of \fBattrname\fR, creates one NIS entry for -each such instance, differentiated by their \fBfieldname\fR values. The -following combinations of lists are allowed, but they are not particularly -useful: -.sp -.ne 2 -.na -\fB\fB(attrname)=(fieldname)\fR\fR -.ad -.RS 26n -Equivalent to \fBattrname=fieldname\fR -.RE - -.sp -.ne 2 -.na -\fB\fBattrname=(fieldname)\fR\fR -.ad -.RS 26n -Equivalent to \fBattrname=fieldname\fR -.RE - -.sp -.ne 2 -.na -\fB\fB(fieldname)=attrname\fR\fR -.ad -.RS 26n -Equivalent to \fBfieldname=attrname\fR -.RE - -.sp -.ne 2 -.na -\fB\fBfieldname=(attrname)\fR\fR -.ad -.RS 26n -Equivalent to \fBfieldname=attrname\fR -.RE - -.sp -.LP -If a multi-valued \fBRHS\fR is assigned to a single-valued \fBLHS\fR, the -\fBLHS\fR value will be the first of the \fBRHS\fR values. If the \fBRHS\fR is -an attribute list, the first attribute is the first one returned by the LDAP -server when queried. Otherwise, the definition of "first" is implementation -dependent. -.sp -.LP -Finally, the \fBLHS\fR can be an explicit list of fields or attributes, such -as: -.sp -.in +2 -.nf -(name1,name2,name3) -.fi -.in -2 - -.sp -.LP -If the \fBRHS\fR is single-valued, this assigns the \fBRHS\fR value to all -entities in the list. If the \fBRHS\fR is multi-valued, the first value is -assigned to the first entity of the list, the second value to the second -entity, and so on. Excess values or entities are silently ignored. -.SH EXAMPLES -\fBExample 1 \fRAssigning an Attribute Value to a Field -.sp -.LP -The following example illustrates how to assign the value of the -\fBipHostNumber\fR attribute to the \fBaddr\fR field - -.sp -.in +2 -.nf -addr=ipHostNumber -.fi -.in -2 - -.LP -\fBExample 2 \fRCreating Multiple NIS Entries from Multi-Valued LDAP Attributes -.sp -.LP -An LDAP entry with: - -.sp -.in +2 -.nf -cn=name1 -cn=name2 -cn=name3 -.fi -.in -2 - -.sp -.LP -and the following assignments: - -.sp -.in +2 -.nf -cname=cn -(name)=(cn) -.fi -.in -2 - -.sp -.LP -creates three NIS entries. Other attributes and fields are omitted for clarity. - -.sp -.in +2 -.nf -cname=name1, name=name1 -cname=name1, name=name2 -cname=name1, name=name3 -.fi -.in -2 - -.LP -\fBExample 3 \fRAssigning String Constants -.sp -.LP -The following expression sets the \fBpasswd\fR field to x: - -.sp -.in +2 -.nf -passwd=("x") -.fi -.in -2 - -.LP -\fBExample 4 \fRSplitting Field Values to Multi-Valued Attributes -.sp -.LP -The \fBexpansion\fR field contains a comma-separated list of alias member -names. In the following example, the expression assigns each member name to an -instance of \fBmgrprfc822mailmember\fR: - -.sp -.in +2 -.nf -(mgrprfc822mailmember)=(expansion, ",") -.fi -.in -2 - -.SH FILES -.ne 2 -.na -\fB\fB/var/yp/NISLDAPmapping\fR\fR -.ad -.RS 26n -Mapping file used by the NIS server components -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Obsolete -.TE - -.SH SEE ALSO -\fBinityp2l\fR(1M), \fBmakedbm\fR(1M), \fBypserv\fR(1M), -\fBber_printf\fR(3LDAP), \fBsprintf\fR(3C), \fBsscanf\fR(3C), -\fBypserv\fR(4), \fBattributes\fR(5) -.sp -.LP -\fISystem Administration Guide: Naming and Directory Services (DNS, NIS, and -LDAP)\fR diff --git a/usr/src/man/man4/a.out.4 b/usr/src/man/man4/a.out.4 deleted file mode 100644 index 3f4a3a0f8b..0000000000 --- a/usr/src/man/man4/a.out.4 +++ /dev/null @@ -1,108 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.\" 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 A.OUT 4 "Aug 24, 2009" -.SH NAME -a.out \- Executable and Linking Format (ELF) files -.SH SYNOPSIS -.LP -.nf -\fB#include <elf.h>\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The file name \fBa.out\fR is the default output file name from the link editor, -\fBld\fR(1). The link editor will make an \fBa.out\fR executable if there were -no errors in linking. The output file of the assembler, \fBas\fR(1), also -follows the format of the \fBa.out\fR file although its default file name is -different. -.sp -.LP -Programs that manipulate ELF files may use the library that \fBelf\fR(3ELF) -describes. An overview of the file format follows. For more complete -information, see the references given below. -.sp - -.sp -.TS -box; -c | c -l | l . -Linking View Execution View -_ -ELF header ELF header -_ -Program header table Program header table -\fIoptional\fR -_ -Section 1 Segment 1 -_ -\&... -_ -Section \fIn\fR Segment 2 -_ -\&... -_ -\&... \&... -_ -Section header table Section header table - \fIoptional\fR -.TE - -.sp -.LP -An ELF header resides at the beginning and holds a ``road map'' describing the -file's organization. Sections hold the bulk of object file information for the -linking view: instructions, data, symbol table, relocation information, and so -on. Segments hold the object file information for the program execution view. -As shown, a segment may contain one or more sections. -.sp -.LP -A program header table, if present, tells the system how to create a process -image. Files used to build a process image (execute a program) must have a -program header table; relocatable files do not need one. A section header table -contains information describing the file's sections. Every section has an entry -in the table; each entry gives information such as the section name, the -section size, etc. Files used during linking must have a section header table; -other object files may or may not have one. -.sp -.LP -Although the figure shows the program header table immediately after the ELF -header, and the section header table following the sections, actual files may -differ. Moreover, sections and segments have no specified order. Only the ELF -header has a fixed position in the file. -.sp -.LP -When an \fBa.out\fR file is loaded into memory for execution, three logical -segments are set up: the text segment, the data segment (initialized data -followed by uninitialized, the latter actually being initialized to all 0's), -and a stack. The text segment is not writable by the program; if other -processes are executing the same \fBa.out\fR file, the processes will share a -single text segment. -.sp -.LP -The data segment starts at the next maximal page boundary past the last text -address. If the system supports more than one page size, the ``maximal page'' -is the largest supported size. When the process image is created, the part of -the file holding the end of text and the beginning of data may appear twice. -The duplicated chunk of text that appears at the beginning of data is never -executed; it is duplicated so that the operating system may bring in pieces of -the file in multiples of the actual page size without having to realign the -beginning of the data section to a page boundary. Therefore, the first data -address is the sum of the next maximal page boundary past the end of text plus -the remainder of the last text address divided by the maximal page size. If the -last text address is a multiple of the maximal page size, no duplication is -necessary. The stack is automatically extended as required. The data segment is -extended as requested by the \fBbrk\fR(2) system call. -.SH SEE ALSO -.sp -.LP -\fBas\fR(1), \fBld\fR(1), \fBbrk\fR(2), \fBelf\fR(3ELF) -.sp -.LP -\fIANSI C Programmer's Guide\fR diff --git a/usr/src/man/man4/admin.4 b/usr/src/man/man4/admin.4 deleted file mode 100644 index 9163dfc5fb..0000000000 --- a/usr/src/man/man4/admin.4 +++ /dev/null @@ -1,481 +0,0 @@ -'\" te -.\" Copyright (c) 2017 Peter Tribble. -.\" Copyright 1989 AT&T Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved -.\" 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 ADMIN 4 "May 13, 2017" -.SH NAME -admin \- installation defaults file -.SH DESCRIPTION -.LP -\fBadmin\fR is a generic name for an \fBASCII\fR file that defines default -installation actions by assigning values to installation parameters. For -example, it allows administrators to define how to proceed when the package -being installed already exists on the system. -.sp -.LP -\fB/var/sadm/install/admin/default\fR is the default \fBadmin\fR file delivered -with this release. The default file is not writable, so to assign values -different from this file, create a new \fBadmin\fR file. There are no naming -restrictions for \fBadmin\fR files. Name the file when installing a package -with the \fB-a\fR option of \fBpkgadd\fR(1M). If the \fB-a\fR option is not -used, the default \fBadmin\fR file is used. -.sp -.LP -Each entry in the \fBadmin\fR file is a line that establishes the value of a -parameter in the following form: -.sp -.LP -\fIparam\fR\fB=\fR\fIvalue\fR -.sp -.LP -All of the parameters listed below can be defined in an \fBadmin\fR file, but -it is not required to assign values to all of these. If a value is not -assigned, \fBpkgadd\fR(1M) asks the installer how to proceed. -.sp -.LP -The valid parameters and their possible values are shown below except as noted. -They can be specified in any order. Any of these parameters (except the -\fBmail\fR parameter) can be assigned the value \fBask\fR, -which means that, when the parameter is reached during the installation -sequence, the installer is notified and asked to supply instructions (see -\fBNOTES\fR). -.sp -.ne 2 -.na -\fB\fBbasedir\fR\fR -.ad -.RS 30n -Indicates the base directory where relocatable packages are to be installed. If -there is no \fBbasedir\fR entry in the file, the installer will be prompted for -a path name, as if the file contained the entry \fBbasedir=ask\fR. This -parameter can also be set to \fBdefault\fR (entry is \fBbasedir=default\fR). In -this instance, the package is installed into the base directory specified by -the \fBBASEDIR\fR parameter in the \fBpkginfo\fR(4) file. -.RE - -.sp -.ne 2 -.na -\fB\fBmail\fR\fR -.ad -.RS 30n -Defines a list of users to whom mail should be sent following installation of a -package. If the list is empty, no mail is sent. If the parameter is not present -in the \fBadmin\fR file, the default value of \fBroot\fR is used. The \fBask\fR -value cannot be used with this parameter. -.RE - -.sp -.ne 2 -.na -\fB\fBrunlevel\fR\fR -.ad -.RS 30n -Indicates resolution if the run level is not correct for the installation or -removal of a package. Options are: -.sp -.ne 2 -.na -\fB\fBnocheck\fR\fR -.ad -.RS 11n -Do not check for run level. -.RE - -.sp -.ne 2 -.na -\fB\fBquit\fR\fR -.ad -.RS 11n -Abort installation if run level is not met. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBconflict\fR\fR -.ad -.RS 30n -Specifies what to do if an installation expects to overwrite a previously -installed file, thus creating a conflict between packages. Options are: -.sp -.ne 2 -.na -\fB\fBnocheck\fR\fR -.ad -.RS 12n -Do not check for conflict; files in conflict will be overwritten. -.RE - -.sp -.ne 2 -.na -\fB\fBquit\fR\fR -.ad -.RS 12n -Abort installation if conflict is detected. -.RE - -.sp -.ne 2 -.na -\fB\fBnochange\fR\fR -.ad -.RS 12n -Override installation of conflicting files; they will not be installed. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBsetuid\fR\fR -.ad -.RS 30n -Checks for executables which will have setuid or setgid bits enabled after -installation. Options are: -.sp -.ne 2 -.na -\fB\fBnocheck\fR\fR -.ad -.RS 12n -Do not check for setuid executables. -.RE - -.sp -.ne 2 -.na -\fB\fBquit\fR\fR -.ad -.RS 12n -Abort installation if setuid processes are detected. -.RE - -.sp -.ne 2 -.na -\fB\fBnochange\fR\fR -.ad -.RS 12n -Override installation of setuid processes; processes will be installed without -setuid bits enabled. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBaction\fR\fR -.ad -.RS 30n -Determines if action scripts provided by package developers contain possible -security impact. Options are: -.sp -.ne 2 -.na -\fB\fBnocheck\fR\fR -.ad -.RS 11n -Ignore security impact of action scripts. -.RE - -.sp -.ne 2 -.na -\fB\fBquit\fR\fR -.ad -.RS 11n -Abort installation if action scripts may have a negative security impact. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBpartial\fR\fR -.ad -.RS 30n -Checks to see if a version of the package is already partially installed on the -system. Options are: -.sp -.ne 2 -.na -\fB\fBnocheck\fR\fR -.ad -.RS 11n -Do not check for a partially installed package. -.RE - -.sp -.ne 2 -.na -\fB\fBquit\fR\fR -.ad -.RS 11n -Abort installation if a partially installed package exists. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBinstance\fR\fR -.ad -.RS 30n -Determines how to handle installation if a previous version of the package -(including a partially installed instance) already exists. Options are: -.sp -.ne 2 -.na -\fB\fBquit\fR\fR -.ad -.RS 13n -Exit without installing if an instance of the package already exists (does not -overwrite existing packages). -.RE - -.sp -.ne 2 -.na -\fB\fBoverwrite\fR\fR -.ad -.RS 13n -Overwrite an existing package if only one instance exists. If there is more -than one instance, but only one has the same architecture, it overwrites that -instance. Otherwise, the installer is prompted with existing instances and -asked which to overwrite. -.RE - -.sp -.ne 2 -.na -\fB\fBunique\fR\fR -.ad -.RS 13n -Do not overwrite an existing instance of a package. Instead, a new instance of -the package is created. The new instance will be assigned the next available -instance identifier. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBidepend\fR\fR -.ad -.RS 30n -Controls resolution if the package to be installed depends on other packages -and if other packages depend on the one to be installed. Options are: -.sp -.ne 2 -.na -\fB\fBnocheck\fR\fR -.ad -.RS 11n -Do not check package dependencies. -.RE - -.sp -.ne 2 -.na -\fB\fBquit\fR\fR -.ad -.RS 11n -Abort installation if package dependencies are not met. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBrdepend\fR\fR -.ad -.RS 30n -Controls resolution if other packages depend on the package to be removed. -Options are: -.sp -.ne 2 -.na -\fB\fBnocheck\fR\fR -.ad -.RS 11n -Do not check package or product dependencies. -.RE - -.sp -.ne 2 -.na -\fB\fBquit\fR\fR -.ad -.RS 11n -Abort removal if package or product dependencies are not met. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBspace\fR\fR -.ad -.RS 30n -Controls resolution if disk space requirements for package are not met. Options -are: -.sp -.ne 2 -.na -\fB\fBnocheck\fR\fR -.ad -.RS 11n -Do not check space requirements (installation fails if it runs out of space). -.RE - -.sp -.ne 2 -.na -\fB\fBquit\fR\fR -.ad -.RS 11n -Abort installation if space requirements are not met. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBrscriptalt=root | noaccess\fR\fR -.ad -.RS 30n -Determines the user that will run request scripts. This parameter can have -either of the values described below. See \fBpkgadd\fR(1M) for details on the -conditions under which this parameter is useful. -.sp -.ne 2 -.na -\fB\fBroot\fR\fR -.ad -.RS 12n -Run request script as user \fBinstall\fR, if such a user exists, with the -privileges of that user. Otherwise, run script as user \fBroot\fR, with UID -equal to 0 and with all/zone privileges. (See \fBzones\fR(5).) -.RE - -.sp -.ne 2 -.na -\fB\fBnoaccess\fR\fR -.ad -.RS 12n -Run request script as user \fBinstall\fR, if such a user exists, with the -privileges of that user. Otherwise, run script as user \fBnoaccess\fR, with the -basic privileges of the unprivileged user \fBnoaccess\fR. -.RE - -If this parameter is not present or has a null value, the user \fBnoaccess\fR -is assumed. Likewise, if this parameter is set to anything other than the -values described here, a warning is issued, and \fBnoaccess\fR is assumed. -\fBrscriptalt\fR is not present in the default \fBadmin\fR file, -\fB/var/sadm/install/admin/default\fR. In this case, request scripts are run as -the user \fBnoaccess\fR. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRDefault \fBadmin\fR File -.sp -.LP -The default \fBadmin\fR file, named \fBdefault\fR, is shipped with user-, -group-, and world-read privileges (444). Its contents are as follows: - -.sp -.in +2 -.nf -mail= -instance=unique -partial=ask -runlevel=ask -idepend=ask -rdepend=ask -space=ask -setuid=ask -conflict=ask -action=ask -basedir=default -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRSample \fBadmin\fR file. -.sp -.LP -Below is a sample \fBadmin\fR file. - -.sp -.in +2 -.nf -basedir=default -runlevel=quit -conflict=quit -setuid=quit -action=quit -partial=quit -instance=unique -idepend=quit -rdepend=quit -space=quit -.fi -.in -2 -.sp - -.SH FILES -.LP -The default \fBadmin\fR file is consulted during package installation when no -other \fBadmin\fR file is specified. -.sp -.ne 2 -.na -\fB\fB/var/sadm/install/admin/default\fR\fR -.ad -.sp .6 -.RS 4n -default \fBadmin\fR file -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.LP -\fBpkgadd\fR(1M), \fBpkginfo\fR(4), \fBattributes\fR(5), \fBzones\fR(5) -.SH NOTES -.LP -The value \fBask\fR should not be defined in an \fBadmin\fR file that will be -used for non-interactive installation (because, by definition, there is no -installer interaction). Doing so causes installation to fail at the point when -input is needed. diff --git a/usr/src/man/man4/alias.4 b/usr/src/man/man4/alias.4 deleted file mode 100644 index 047cd84823..0000000000 --- a/usr/src/man/man4/alias.4 +++ /dev/null @@ -1,53 +0,0 @@ -'\" te -.\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved -.\" 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 ALIAS 4 "Oct 2, 2001" -.SH NAME -alias \- alias table file of encoding names -.SH SYNOPSIS -.LP -.nf -\fB/usr/lib/iconv/alias\fR -.fi - -.SH DESCRIPTION -.sp -.LP -This file contains the alias table of encoding names for \fBiconv_open\fR(3C). -.sp -.LP -The format of the alias table is as follows: -.sp -.in +2 -.nf -"%s %s\en", <variant encoding name>, <canonical encoding name> -.fi -.in -2 - -.sp -.LP -The string specified for the variant encoding name is case-insensitive. A line -beginning with '#' is treated as a comment. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBiconv\fR(3C), \fBiconv_close\fR(3C), \fBiconv_open\fR(3C), -\fBattributes\fR(5) diff --git a/usr/src/man/man4/aliases.4 b/usr/src/man/man4/aliases.4 deleted file mode 100644 index 9d1c6705a1..0000000000 --- a/usr/src/man/man4/aliases.4 +++ /dev/null @@ -1,450 +0,0 @@ -'\" te -.\" Copyright (c) 2003 Sun Microsystems, Inc. - All Rights Reserved. -.\" 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 ALIASES 4 "Feb 25, 2017" -.SH NAME -aliases, addresses, forward \- addresses and aliases for sendmail -.SH SYNOPSIS -.LP -.nf -/etc/mail/aliases -.fi - -.LP -.nf -/etc/mail/aliases.db -.fi - -.LP -.nf -/etc/mail/aliases.dir -.fi - -.LP -.nf -/etc/mail/aliases.pag -.fi - -.LP -.nf -~/.forward -.fi - -.SH DESCRIPTION -.LP -These files contain mail addresses or aliases, recognized by \fBsendmail\fR(1M) -for the local host: -.sp -.ne 2 -.na -\fB/etc/passwd\fR -.ad -.sp .6 -.RS 4n -Mail addresses (usernames) of local users. -.RE - -.sp -.ne 2 -.na -\fB/etc/mail/aliases\fR -.ad -.sp .6 -.RS 4n -Aliases for the local host, in \fBASCII\fR format. Root can edit this file to -add, update, or delete local mail aliases. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/mail/aliases.\fR{\fIdir\fR , \fIpag\fR}\fR -.ad -.sp .6 -.RS 4n -The aliasing information from \fB/etc/mail/aliases\fR, in binary \fBndbm\fR(3C) -format for use by \fBsendmail\fR(1M). The program \fBnewaliases\fR(1M) -maintains these files. -.RE - -.sp -.ne 2 -.na -\fB/etc/mail/aliases.db\fR -.ad -.sp .6 -.RS 4n - The aliasing information from \fB/etc/mail/aliases\fR, in binary, Berkeley -DataBase format for use by \fBsendmail\fR(1M). The program maintains these -files. -.sp -Depending on the configuration of the AliasFile option in -\fB/etc/mail/sendmail.cf\fR, either the single file \fBaliases.db\fR or the -pair of files \fBaliases.\fR{dir, pag} is generated by \fBnewaliases\fR(1M). As -shipped with Solaris, \fBsendmail\fR(1M) supports both formats. If neither is -specified, the Berkeley DataBase format which generates the single \fB\&.db\fR -file is used. -.RE - -.sp -.ne 2 -.na -\fB~/.forward\fR -.ad -.sp .6 -.RS 4n -Addresses to which a user's mail is forwarded (see \fBAutomatic Forwarding\fR). -.RE - -.sp -.LP -In addition, the \fBNIS\fR name services aliases map \fImail.aliases\fR -contains addresses and aliases -available for use across the network. -.SS "Addresses" -.LP -As distributed, \fBsendmail\fR(1M) supports the following types of addresses: -.SS "Local Usernames" -.in +2 -.nf -\fIusername\fR -.fi -.in -2 - -.sp -.LP -Each local \fIusername\fR is listed in the local host's \fB/etc/passwd\fR file. -.SS "Local Filenames" -.in +2 -.nf -\fIpathname\fR -.fi -.in -2 - -.sp -.LP -Messages addressed to the absolute \fIpathname\fR of a file are appended to -that file. -.SS "Commands" -.in +2 -.nf -\fB|\fR\fBcommand\fR -.fi -.in -2 - -.sp -.LP -If the first character of the address is a vertical bar (\fB\||\|\fR), -\fBsendmail\fR(1M) pipes the message to the standard input of the \fBcommand\fR -the bar precedes. -.SS "Internet-standard Addresses" -.in +2 -.nf -\fIusername\fR\fB@\fR\fIdomain\fR -.fi -.in -2 - -.sp -.LP -If \fIdomain\fR does not contain any `\fB\&.\fR' (dots), then it is interpreted -as the name of a host in the current domain. Otherwise, the message is passed -to a \fImailhost\fR that determines how to get to the specified domain. Domains -are divided into subdomains separated by dots, with the top-level domain on the -right. -.sp -.LP -For example, the full address of John Smith could be: -.sp -.in +2 -.nf -\fBjs@jsmachine.Podunk-U.EDU\fR -.fi -.in -2 - -.sp -.LP -if he uses the machine named \fBjsmachine\fR at Podunk University. -.SS "\fBuucp\fR Addresses" -.in +2 -.nf -\&.\|.\|. [\fIhost\fR\fB!\fR] \fIhost\fR\fB!\fR\fIusername\fR -.fi -.in -2 - -.sp -.LP -These are sometimes mistakenly referred to as ``Usenet'' addresses. -\fBuucp\fR(1C) provides links to numerous sites throughout the world for the -remote copying of files. -.sp -.LP -Other site-specific forms of addressing can be added by customizing the -\fBsendmail.cf\fR configuration file. See \fBsendmail\fR(1M) for details. -Standard addresses are recommended. -.SS "Aliases" -.SS "Local Aliases" -.LP -\fB/etc/mail/aliases\fR is formatted as a series of lines of the form -.sp -.in +2 -.nf -\fIaliasname\fR\fB:\fR\fIaddress\fR[, \fIaddress\fR] -.fi -.in -2 - -.sp -.LP -\fIaliasname\fR is the name of the alias or alias group, and \fIaddress\fR is -the address of a recipient in the group. Aliases can be nested. That is, an -\fIaddress\fR can be the name of another alias group. Because of the way -\fBsendmail\fR(1M) performs mapping from upper-case to lower-case, an -\fIaddress\fR that is the name of another alias group must not contain any -upper-case letters. -.sp -.LP -Lines beginning with white space are treated as continuation lines for the -preceding alias. Lines beginning with \fB#\fR are comments. -.SS "Special Aliases" -.LP -An alias of the form: -.sp -.in +2 -.nf -\fBowner-aliasname :\fR \fIaddress\fR -.fi -.in -2 - -.sp -.LP -\fBsendmail\fR directs error-messages resulting from mail to \fIaliasname\fR to -\fIaddress\fR, instead of back to the person who sent the message. -\fBsendmail\fR rewrites the \fBSMTP\fR envelope sender to match this, so -\fBowner-aliasname\fR should always point to \fBalias-request\fR, and -\fBalias-request\fR should point to the owner's actual address: -.sp -.in +2 -.nf -owner-aliasname: aliasname-request -aliasname-request \fIaddress\fR -.fi -.in -2 - -.sp -.LP -An alias of the form: -.sp -.in +2 -.nf -\fIaliasname\fR\fB: :include:\fR\fIpathname\fR -.fi -.in -2 - -.sp -.LP -with colons as shown, adds the recipients listed in the file \fIpathname\fR to -the \fIaliasname\fR alias. This allows a private list to be maintained -separately from the aliases file. -.SS "NIS Domain Aliases" -.LP -The aliases file on the master \fBNIS\fR server is used for the -\fImail.aliases\fR \fBNIS\fR map, which can be made available to every -\fBNIS\fR client. Thus, the \fB/etc/mail/aliases*\fR files on the various -hosts in a network will one day be obsolete. Domain-wide aliases should -ultimately be resolved into usernames on specific hosts. For example, if the -following were in the domain-wide alias file: -.sp -.in +2 -.nf -jsmith:js@jsmachine -.fi -.in -2 - -.sp -.LP -then any \fBNIS\fR client could just mail to \fBjsmith\fR and not -have to remember the machine and username for John Smith. -.sp -.LP -If a \fBNIS\fR alias does not resolve to an address with a -specific host, then the name of the \fBNIS\fR domain is used. -There should be an alias of the domain name for a host in this case. -.sp -.LP -For example, the alias: -.sp -.in +2 -.nf -jsmith:root -.fi -.in -2 - -.sp -.LP -sends mail on a \fBNIS\fR client to \fBroot@podunk-u\fR if the -name of the \fBNIS\fR domain is \fBpodunk-u\fR. -.SS "Automatic Forwarding" -.LP -When an alias (or address) is resolved to the name of a user on the local host, -\fBsendmail\fR(1M) checks for a ~/.forward file, owned by the intended -recipient, in that user's home directory, and with universal read access. This -file can contain one or more addresses or aliases as described above, each of -which is sent a copy of the user's mail. -.sp -.LP -Care must be taken to avoid creating addressing loops in the \fB~/.forward\fR -file. When forwarding mail between machines, be sure that the destination -machine does not return the mail to the sender through the operation of any -\fBNIS\fR aliases. Otherwise, copies of the message may "bounce." Usually, the -solution is to change the \fBNIS\fR alias to direct mail to the proper -destination. -.sp -.LP -A backslash before a username inhibits further aliasing. For instance, to -invoke the \fBvacation\fR program, user \fBjs\fR creates a \fB~/.forward\fR -file that contains the line: -.sp -.in +2 -.nf -\ejs, "|/usr/ucb/vacation js" -.fi -.in -2 - -.sp -.LP -so that one copy of the message is sent to the user, and another is piped into -the \fBvacation\fR program. -.sp -.LP -The \fB~/.forward\fR file can be used to specify special "per user" extensions -by creating a \fB\&.forward+extension\fR file in the home directory. For -example, with an address like \fBjsmith+jerry@jsmachine\fR, the -\fBsendmail\fR(1M) utility recognizes everything before the "\fB+\fR" as the -actual username (\fBjsmith\fR) and everything after it, up to the "\fB@\fR" -symbol, as the extension (\fBjerry\fR) which is passed to the mail delivery -agent for local use. -.sp -.LP -The default value of the \fBForwardPath\fR processing option in -\fBsendmail\fR(1M) is: -.sp -.in +2 -.nf -O ForwardPath=$z/.forward.$w+$h:$z/.forward+$h:$z/.forward.$w:$z \e -/.forward -.fi -.in -2 - -.sp -.LP -where \fB$z\fR is the macro for the user's home directory, \fB$w\fR is the -macro for the local machine name and \fB$h\fR is the extension. For example, -for mail using the address, \fBjsmith+jerry@jsmachine\fR, the -\fBsendmail\fR(1M) utility checks each of the four following file names, in the -order given, to see if it exists and if it has "safe" permissions, that is, -that neither the file nor any of its parent directories are group- or -world-writable: -.sp -.in +2 -.nf -~jsmith/.forward.jsmachine+jerry -~jsmith/.forward+jerry -~jsmith/.forward.jsmachine -~jsmith/.forward -.fi -.in -2 - -.sp -.LP -The first file that meets the conditions is used to forward the mail, that is, -all the entries in that file receive a copy of the mail. The search is then -stopped. -.SH FILES -.ne 2 -.na -\fB\fB/etc/passwd\fR\fR -.ad -.RS 25n -Password file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/nsswitch.conf\fR\fR -.ad -.RS 25n -Name service switch configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/mail/aliases\fR\fR -.ad -.RS 25n -Mail aliases file (ascii) -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/mail/aliases.db\fR\fR -.ad -.RS 25n -Database of mail aliases (binary) -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/mail/aliases.dir\fR\fR -.ad -.RS 25n -Database of mail aliases (binary) -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/mail/aliases.pag\fR\fR -.ad -.RS 25n -Database of mail aliases (binary) -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/mail/sendmail.cf\fR\fR -.ad -.RS 25n -sendmail configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB~/.forward\fR\fR -.ad -.RS 25n -Forwarding information file -.RE - -.SH SEE ALSO -.LP -\fBpasswd\fR(1), \fBuucp\fR(1C), \fBvacation\fR(1), \fBnewaliases\fR(1M), -\fBsendmail\fR(1M), \fBndbm\fR(3C), \fBgetusershell\fR(3C), \fBpasswd\fR(4), -\fBshells\fR(4), \fBattributes\fR(5) -.SH NOTES -.LP -Because of restrictions in \fBndbm\fR(3C), a single alias cannot contain more -than about \fB1000\fR characters (if this format is used). The Berkeley -DataBase format does not have any such restriction. Nested aliases can be used -to circumvent this limit. -.sp -.LP -For aliases which result in piping to a program or concatenating a file, the -shell of the controlling user must be allowed. Which shells are and are not -allowed are determined by \fBgetusershell\fR(3C). diff --git a/usr/src/man/man4/au.4 b/usr/src/man/man4/au.4 deleted file mode 100644 index 3d82f314d6..0000000000 --- a/usr/src/man/man4/au.4 +++ /dev/null @@ -1,213 +0,0 @@ -'\" te -.\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 AU 4 "Jan 15, 2001" -.SH NAME -au \- AU audio file format -.SH SYNOPSIS -.LP -.nf -\fB#include <audio/au.h>\fR -.fi - -.SH DESCRIPTION -.sp -.LP -An AU audio file is composed of three parts: a header, an optional description -field, and a contiguous segment of audio data. The header is 24 bytes, and the -description field is at least 4 bytes. Therefore, the offset for most AU files -is 28 bytes. However, some people store additional data in the AU header. -.sp -.LP -The AU audio structure members and audio data are stored big endian. That is, -it starts with the most significant byte, regardless of the native byte order -of the machine architecture on which an application may be running. Therefore, -multi-byte audio data may require byte reversal for proper playback on -different processor architectures. See the macro section for properly reading -and writing the AU audio structure members. -.sp -.LP -The AU header is defined by the following structure: -.sp -.in +2 -.nf -struct au_filehdr { - uint32_t au_magic; /* magic number (.snd) */ - uint32_t au_offset; /* byte offset to start of audio data */ - uint32_t au_data_size; /* data length in bytes */ - uint32_t au_encoding; /* data encoding */ - uint32_t au_sample_rate; /* samples per second */ - uint32_t au_channels; /* number of interleaved channels */ -}; -typedef struct au_filehdr au_filehdr_t; -.fi -.in -2 - -.sp -.LP -The \fBau_magic\fR field always contains the following constant for an AU audio -file: -.sp -.in +2 -.nf -AUDIO_AU_FILE_MAGIC ( 0x2e736e64 ) /* ".snd" */ -.fi -.in -2 - -.sp -.LP -The \fBau_offset\fR field contains the length of the audio file header plus the -variable length info field. Consequently, it can be interpreted as the offset -from the start of the file to the start of the audio data. -.sp -.LP -The \fBau_data_size\fR field contains the length, in bytes, of the audio data -segment. If this length is not known when the header is written, it should be -set to \fBAUDIO_AU_UNKNOWN_SIZE\fR, defined as follows: -.sp -.in +2 -.nf -AUDIO_AU_UNKNOWN_SIZE ( ~0 ) /* (unsigned) -1 */ -.fi -.in -2 - -.sp -.LP -When the \fBau_data_size\fR field contains \fBAUDIO_AU_UNKNOWN_SIZE\fR, the -length of the audio data can be determined by subtracting \fBau_offset\fR from -the total length of the file. -.sp -.LP -The encoding field contains one of the following enumerated keys: -.sp -.in +2 -.nf -AUDIO_AU_ENCODING_ULAW /* 8-bit u-law */ -AUDIO_AU_ENCODING_LINEAR_8 /* 8-bit linear PCM */ -AUDIO_AU_ENCODING_LINEAR_16 /* 16-bit linear PCM */ -AUDIO_AU_ENCODING_LINEAR_24 /* 24-bit linear PCM */ -AUDIO_AU_ENCODING_LINEAR_32 /* 32-bit linear PCM */ -AUDIO_AU_ENCODING_FLOAT /* Floating point */ -AUDIO_AU_ENCODING_DOUBLE /* Double precision float */ -AUDIO_AU_ENCODING_FRAGMENTED /* Fragmented sample data */ -AUDIO_AU_ENCODING_DSP /* DSP program */ -AUDIO_AU_ENCODING_FIXED_8 /* 8-bit fixed point */ -AUDIO_AU_ENCODING_FIXED_16 /* 16-bit fixed point */ -AUDIO_AU_ENCODING_FIXED_24 /* 24-bit fixed point */ -AUDIO_AU_ENCODING_FIXED_32 /* 32-bit fixed point */ -AUDIO_AU_ENCODING_EMPHASIS /* 16-bit linear with emphasis */ -AUDIO_AU_ENCODING_COMPRESSED /* 16-bit linear compressed */ -AUDIO_AU_ENCODING_EMP_COMP /* 16-bit linear with emphasis - and compression */ -AUDIO_AU_ENCODING_MUSIC_KIT /* Music kit DSP commands */ -AUDIO_AU_ENCODING_ADPCM_G721 /* CCITT G.721 ADPCM */ -AUDIO_AU_ENCODING_ADPCM_G722 /* CCITT G.722 ADPCM */ -AUDIO_AU_ENCODING_ADPCM_G723_3 /* CCITT G.723.3 ADPCM */ -AUDIO_AU_ENCODING_ADPCM_G723_5 /* CCITT G.723.5 ADPCM */ -AUDIO_AU_ENCODING_ALAW /* 8-bit A-law G.711 */ -.fi -.in -2 - -.sp -.LP -All of the linear encoding formats are signed integers centered at zero. -.sp -.LP -The \fBau_sample_rate\fR field contains the audio file's sampling rate in -samples per second. Some common sample rates include 8000, 11025, 22050, 44100, -and 48000 samples per second. -.sp -.LP -The \fBau_channels\fR field contains the number of interleaved data channels. -For monaural data, this value is set to one. For stereo data, this value is set -to two. More than two data channels can be interleaved, but such formats are -currently unsupported by the Solaris audio driver architecture. For a stereo -sound file, the first sample is the left track and the second sample is the -right track. -.sp -.LP -The optional info field is a variable length annotation field that can be -either text or data. If it is a text description of the sound, then it should -be NULL terminated. However, some older files might not be terminated properly. -The size of the info field is set when the structure is created and cannot be -enlarged later. -.SS "Macros" -.sp -.LP -Accessing all of the AU audio structure members should be done through the -supplied \fBAUDIO_AU_FILE2HOST\fR and \fBAUDIO_AU_HOST2FILE\fR macros. By -always using these macros, code will be byte-order independent. See the example -below. -.SH EXAMPLES -.LP -\fBExample 1 \fRDisplaying Header Information for a Sound File -.sp -.LP -The following program reads and displays the header information for an AU sound -file. The \fBAUDIO_AU_FILE2HOST\fR macro ensures that this information will -always be in the proper byte order. - -.sp -.in +2 -.nf -void main(void) -{ - au_filehdr_t hdr; - au_filehdr_t local; - int fd; - char *name = "bark.au"; - - if ((fd = open(name, O_RDONLY)) < 0) { - printf("can't open file %s\en", name); - exit(1); - } - - (void) read(fd, &hdr, sizeof (hdr)); - - AUDIO_AU_FILE2HOST(&hdr.au_magic, &local.au_magic); - AUDIO_AU_FILE2HOST(&hdr.au_offset, &local.au_offset); - AUDIO_AU_FILE2HOST(&hdr.au_data_size, &local.au_data_size); - AUDIO_AU_FILE2HOST(&hdr.au_encoding, &local.au_encoding); - AUDIO_AU_FILE2HOST(&hdr.au_sample_rate, &local.au_sample_rate); - AUDIO_AU_FILE2HOST(&hdr.au_channels, &local.au_channels); - - printf("Magic = %x\en", local.au_magic); - printf("Offset = %d\en", local.au_offset); - printf("Number of data bytes = %d\en", local.au_data_size); - printf("Sound format = %d\en", local.au_encoding); - printf("Sample rate = %d\en", local.au_sample_rate); - printf("Number of channels = %d\en", local.au_channels); - - (void) close(fd); -} -.fi -.in -2 - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Stability Level Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) -.SH NOTES -.sp -.LP -Some older AU audio files are incorrectly coded with info strings that are not -properly NULL-terminated. Thus, applications should always use the \fBau_offset -value\fR to find the end of the info data and the beginning of the audio data. diff --git a/usr/src/man/man4/audit.log.4 b/usr/src/man/man4/audit.log.4 deleted file mode 100644 index 44c9b17e9c..0000000000 --- a/usr/src/man/man4/audit.log.4 +++ /dev/null @@ -1,795 +0,0 @@ -'\" te -.\" Copyright (c) 2017 Peter Tribble -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved -.\" 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 AUDIT.LOG 4 "Mar 6, 2017" -.SH NAME -audit.log \- audit trail file -.SH SYNOPSIS -.LP -.nf -\fB#include <bsm/audit.h>\fR -.fi - -.LP -.nf -\fB#include <bsm/audit_record.h>\fR -.fi - -.SH DESCRIPTION -.LP -\fBaudit.log\fR files are the depository for audit records stored locally or on -an NFS-mounted audit server. These files are kept in directories as specified -by the \fBp_dir\fR attribute of the \fBaudit_binfile\fR(5) plugin. They are -named to reflect the time they are created and are, when possible, renamed to -reflect the time they are closed as well. The name takes the form -.sp -.LP -\fIyyyymmddhhmmss\fR\fB\&.not_terminated.\fR\fIhostname\fR -.sp -.LP -when open or if \fBauditd\fR(1M) terminated ungracefully, and the form -.sp -.LP -\fIyyyymmddhhmmss\fR\fB\&.\fR\fIyyyymmddhhmmss\fR\fB\&.\fR\fIhostname\fR -.sp -.LP -when properly closed. \fByyyy\fR is the year, \fBmm\fR the month, \fBdd\fR day -in the month, \fBhh\fR hour in the day, \fBmm\fR minute in the hour, and -\fBss\fR second in the minute. All fields are of fixed width. -.sp -.LP -Audit data is generated in the binary format described below; the default for -audit is binary format. See \fBaudit_syslog\fR(5) for an alternate data -format. -.sp -.LP -The \fBaudit.log\fR file begins with a standalone \fBfile token\fR and -typically ends with one also. The beginning \fBfile token\fR records the -pathname of the previous audit file, while the ending \fBfile token\fR records -the pathname of the next audit file. If the file name is \fBNULL\fR the -appropriate path was unavailable. -.sp -.LP -The \fBaudit.log\fR files contains audit records. Each audit record is made up -of \fIaudit tokens\fR. Each record contains a header token followed by various -data tokens. Depending on the audit policy in place by \fBauditon\fR(2), -optional other tokens such as trailers or sequences may be included. -.sp -.LP -The tokens are defined as follows: -.sp -.LP -The \fBfile\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -seconds of time 4 bytes -microseconds of time 4 bytes -file name length 2 bytes -file pathname N bytes + 1 terminating NULL byte -.fi -.in -2 -.sp - -.sp -.LP -The \fBheader\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -record byte count 4 bytes -version # 1 byte [2] -event type 2 bytes -event modifier 2 bytes -seconds of time 4 bytes/8 bytes (32-bit/64-bit value) -nanoseconds of time 4 bytes/8 bytes (32-bit/64-bit value) -.fi -.in -2 -.sp - -.sp -.LP -The expanded \fBheader\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -record byte count 4 bytes -version # 1 byte [2] -event type 2 bytes -event modifier 2 bytes -address type/length 1 byte -machine address 4 bytes/16 bytes (IPv4/IPv6 address) -seconds of time 4 bytes/8 bytes (32/64-bits) -nanoseconds of time 4 bytes/8 bytes (32/64-bits) -.fi -.in -2 -.sp - -.sp -.LP -The \fBtrailer\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -trailer magic number 2 bytes -record byte count 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The \fBarbitrary\fR \fBdata\fR token is defined: -.sp -.in +2 -.nf -token ID 1 byte -how to print 1 byte -basic unit 1 byte -unit count 1 byte -data items (depends on basic unit) -.fi -.in -2 -.sp - -.sp -.LP -The \fBin_addr\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -IP address type/length 1 byte -IP address 4 bytes/16 bytes (IPv4/IPv6 address) -.fi -.in -2 -.sp - -.sp -.LP -The expanded \fBin_addr\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -IP address type/length 4 bytes/16 bytes (IPv4/IPv6 address) -IP address 16 bytes -.fi -.in -2 -.sp - -.sp -.LP -The \fBip\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -version and ihl 1 byte -type of service 1 byte -length 2 bytes -id 2 bytes -offset 2 bytes -ttl 1 byte -protocol 1 byte -checksum 2 bytes -source address 4 bytes -destination address 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The expanded \fBip\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -version and ihl 1 byte -type of service 1 byte -length 2 bytes -id 2 bytes -offset 2 bytes -ttl 1 byte -protocol 1 byte -checksum 2 bytes -address type/type 1 byte -source address 4 bytes/16 bytes (IPv4/IPv6 address) -address type/length 1 byte -destination address 4 bytes/16 bytes (IPv4/IPv6 address) -.fi -.in -2 -.sp - -.sp -.LP -The \fBiport\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -port IP address 2 bytes -.fi -.in -2 -.sp - -.sp -.LP -The \fBpath\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -path length 2 bytes -path N bytes + 1 terminating NULL byte -.fi -.in -2 -.sp - -.sp -.LP -The \fBpath_attr\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -count 4 bytes -path \fIcount\fR null-terminated string(s) -.fi -.in -2 -.sp - -.sp -.LP -The \fBprocess\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -audit ID 4 bytes -effective user ID 4 bytes -effective group ID 4 bytes -real user ID 4 bytes -real group ID 4 bytes -process ID 4 bytes -session ID 4 bytes -terminal ID - port ID 4 bytes/8 bytes (32-bit/64-bit value) - machine address 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The expanded \fBprocess\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -audit ID 4 bytes -effective user ID 4 bytes -effective group ID 4 bytes -real user ID 4 bytes -real group ID 4 bytes -process ID 4 bytes -session ID 4 bytes -terminal ID - port ID 4 bytes/8 bytes (32-bit/64-bit value) - address type/length 1 byte - machine address 4 bytes/16 bytes (IPv4/IPv6 address) -.fi -.in -2 -.sp - -.sp -.LP -The \fBreturn\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -error number 1 byte -return value 4 bytes/8 bytes (32-bit/64-bit value) -.fi -.in -2 -.sp - -.sp -.LP -The \fBsubject\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -audit ID 4 bytes -effective user ID 4 bytes -effective group ID 4 bytes -real user ID 4 bytes -real group ID 4 bytes -process ID 4 bytes -session ID 4 bytes -terminal ID - port ID 4 bytes/8 bytes (32-bit/64-bit value) - machine address 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The expanded \fBsubject\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -audit ID 4 bytes -effective user ID 4 bytes -effective group ID 4 bytes -real user ID 4 bytes -real group ID 4 bytes -process ID 4 bytes -session ID 4 bytes -terminal ID - port ID 4 bytes/8 bytes (32-bit/64-bit value) - address type/length 1 byte - machine address 4 bytes/16 bytes (IPv4/IPv6 address) -.fi -.in -2 -.sp - -.sp -.LP -The \fBSystem V IPC\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -object ID type 1 byte -object ID 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The \fBtext\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -text length 2 bytes -text N bytes + 1 terminating NULL byte -.fi -.in -2 -.sp - -.sp -.LP -The \fBattribute\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -file access mode 4 bytes -owner user ID 4 bytes -owner group ID 4 bytes -file system ID 4 bytes -node ID 8 bytes -device 4 bytes/8 bytes (32-bit/64-bit) -.fi -.in -2 -.sp - -.sp -.LP -The \fBgroups\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -number groups 2 bytes -group list N * 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The \fBSystem V IPC permission\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -owner user ID 4 bytes -owner group ID 4 bytes -creator user ID 4 bytes -creator group ID 4 bytes -access mode 4 bytes -slot sequence # 4 bytes -key 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The \fBarg\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -argument # 1 byte -argument value 4 bytes/8 bytes (32-bit/64-bit value) -text length 2 bytes -text N bytes + 1 terminating NULL byte -.fi -.in -2 -.sp - -.sp -.LP -The \fBexec_args\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -count 4 bytes -text \fIcount\fR null-terminated string(s) -.fi -.in -2 -.sp - -.sp -.LP -The \fBexec_env\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -count 4 bytes -text \fIcount\fR null-terminated string(s) -.fi -.in -2 -.sp - -.sp -.LP -The \fBexit\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -status 4 bytes -return value 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The \fBsocket\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -socket type 2 bytes -remote port 2 bytes -remote Internet address 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The expanded \fBsocket\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -socket domain 2 bytes -socket type 2 bytes -local port 2 bytes -address type/length 2 bytes -local port 2 bytes -local Internet address 4 bytes/16 bytes (IPv4/IPv6 address) -remote port 2 bytes -remote Internet address 4 bytes/16 bytes (IPv4/IPv6 address) -.fi -.in -2 -.sp - -.sp -.LP -The \fBseq\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -sequence number 4 bytes -.fi -.in -2 -.sp - -.sp -.LP -The \fBprivilege\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -text length 2 bytes -privilege set name N bytes + 1 terminating NULL byte -text length 2 bytes -list of privileges N bytes + 1 terminating NULL byte -.fi -.in -2 - -.sp -.LP -The \fBuse-of-auth\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -text length 2 bytes -authorization(s) N bytes + 1 terminating NULL byte -.fi -.in -2 - -.sp -.LP -The \fBuse-of-privilege\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -succ/fail 1 byte -text length 2 bytes -privilege used N bytes + 1 terminating NULL byte -.fi -.in -2 - -.sp -.LP -The \fBcommand\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -count of args 2 bytes -argument list (count times) -text length 2 bytes -argument text N bytes + 1 terminating NULL byte -count of env strings 2 bytes -environment list (count times) -text length 2 bytes -env. text N bytes + 1 terminating NULL byte -.fi -.in -2 - -.sp -.LP -The \fBACL\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -type 4 bytes -value 4 bytes -file mode 4 bytes -.fi -.in -2 - -.sp -.LP -The ACE token consists of: -.sp -.in +2 -.nf -token ID 1 byte -who 4 bytes -access_mask 4 bytes -flags 2 bytes -type 2 bytes -.fi -.in -2 - -.sp -.LP -The \fBzonename\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -name length 2 bytes -name \fI<name length>\fR including terminating NULL byte -.fi -.in -2 - -.sp -.LP -The \fBfmri\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -fmri length 2 bytes -fmri \fI<fmri length>\fR including terminating NULL byte -.fi -.in -2 - -.sp -.LP -The \fBlabel\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -label ID 1 byte -compartment length 1 byte -classification 2 bytes -compartment words \fI<compartment length>\fR * 4 bytes -.fi -.in -2 - -.sp -.LP -The \fBxatom\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -string length 2 bytes -atom string \fIstring length\fR bytes -.fi -.in -2 - -.sp -.LP -The \fBxclient\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -client ID 4 bytes -.fi -.in -2 - -.sp -.LP -The \fBxcolormap\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -XID 4 bytes -creator UID 4 bytes -.fi -.in -2 - -.sp -.LP -The \fBxcursor\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -XID 4 bytes -creator UID 4 bytes -.fi -.in -2 - -.sp -.LP -The \fBxfont\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -XID 4 bytes -creator UID 4 bytes -.fi -.in -2 - -.sp -.LP -The \fBxgc\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -XID 4 bytes -creator UID 4 bytes -.fi -.in -2 - -.sp -.LP -The \fBxpixmap\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -XID 4 bytes -creator UID 4 bytes -.fi -.in -2 - -.sp -.LP -The \fBxproperty\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -XID 4 bytes -creator UID 4 bytes -string length 2 bytes -string \fIstring length\fR bytes -.fi -.in -2 - -.sp -.LP -The \fBxselect\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -property length 2 bytes -property string \fIproperty length\fR bytes -prop. type len. 2 bytes -prop type \fIprop. type len.\fR bytes -data length 2 bytes -window data \fIdata length\fR bytes -.fi -.in -2 - -.sp -.LP -The \fBxwindow\fR token consists of: -.sp -.in +2 -.nf -token ID 1 byte -XID 4 bytes -creator UID 4 bytes -.fi -.in -2 - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability See below. -.TE - -.sp -.LP -The binary file format is Committed. The binary file contents is Uncommitted. -.SH SEE ALSO -.LP -\fBaudit\fR(1M), \fBauditd\fR(1M), \fBaudit\fR(2), -\fBauditon\fR(2), \fBau_to\fR(3BSM), -\fBaudit_binfile\fR(5), \fBaudit_remote\fR(5), \fBaudit_syslog\fR(5) -.SH NOTES -.LP -Each token is generally written using the \fBau_to\fR(3BSM) family of function -calls. diff --git a/usr/src/man/man4/audit_class.4 b/usr/src/man/man4/audit_class.4 deleted file mode 100644 index 141c1d5996..0000000000 --- a/usr/src/man/man4/audit_class.4 +++ /dev/null @@ -1,173 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. -.\" 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 AUDIT_CLASS 4 "Mar 6, 2017" -.SH NAME -audit_class \- audit class definitions -.SH SYNOPSIS -.LP -.nf -\fB/etc/security/audit_class\fR -.fi - -.SH DESCRIPTION -.LP -\fB/etc/security/audit_class\fR is a user-configurable ASCII system file that -stores class definitions used in the audit system. Audit events in -\fBaudit_event\fR(4) are mapped to one or more of the defined audit classes. -\fBaudit_event\fR can be updated in conjunction with changes to -\fBaudit_class\fR. -Programs can use the \fBgetauclassent\fR(3BSM) routines to access audit -class information. -.sp -.LP -The fields for each class entry are separated by colons. Each class entry is a -bitmap and is separated from each other by a newline. -.sp -.LP -Each entry in the \fBaudit_class\fR file has the form: -.sp -.in +2 -.nf -\fImask\fR:\fIname\fR:\fIdescription\fR -.fi -.in -2 - -.sp -.LP -The fields are defined as follows: -.sp -.ne 2 -.na -\fB\fImask\fR\fR -.ad -.RS 15n -class mask -.RE - -.sp -.ne 2 -.na -\fB\fIname\fR\fR -.ad -.RS 15n -class name -.RE - -.sp -.ne 2 -.na -\fB\fIdescription\fR\fR -.ad -.RS 15n -class description -.RE - -.sp -.LP -Each class is represented as a bit in the class mask which is an unsigned -integer. Thus, there are 32 different classes available. Meta-classes can also -be defined. These are supersets composed of multiple base classes, and thus -will have more than 1 bit in its mask. See Examples. Two special meta-classes -are also pre-defined: \fBall\fR, and \fBno\fR. -.sp -.ne 2 -.na -\fB\fBall\fR\fR -.ad -.RS 7n -Represents a conjunction of all allowed classes, and is provided as a shorthand -method of specifying all classes. -.RE - -.sp -.ne 2 -.na -\fB\fBno\fR\fR -.ad -.RS 7n -Is the invalid class, and any event mapped solely to this class will not be -audited. Turning auditing on to the \fBall\fR meta class will not cause events -mapped solely to the \fBno\fR class to be written to the audit trail. This -class is also used to map obsolete events which are no longer generated. -Obsolete events are retained to process old audit trails files. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRUsing an \fBaudit_class\fR File -.sp -.LP -The following is an example of an \fBaudit_class\fR file: - -.sp -.in +2 -.nf -0x00000000:no:invalid class -0x00000001:fr:file read -0x00000002:fw:file write -0x00000004:fa:file attribute access -0x00000008:fm:file attribute modify -0x00000010:fc:file create -0x00000020:fd:file delete -0x00000040:cl:file close -0x00000100:nt:network -0x00000200:ip:ipc -0x00000400:na:non-attribute -0x00001000:lo:login or logout -0x00004000:ap:application -0x000f0000:ad:old administrative (meta-class) -0x00070000:am:administrative (meta-class) -0x00010000:ss:change system state -0x00020000:as:system-wide administration -0x00040000:ua:user administration -0x00080000:aa:audit utilization -0x00300000:pc:process (meta-class) -0x00100000:ps:process start/stop -0x00200000:pm:process modify -0x20000000:io:ioctl -0x40000000:ex:exec -0x80000000:ot:other -0xffffffff:all:all classes (meta-class) -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/etc/security/audit_class\fR\fR -.ad -.RS 29n - -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability See below. -.TE - -.sp -.LP -The file format stability is Committed. The file content is Uncommitted. -.SH SEE ALSO -.LP -\fBau_preselect\fR(3BSM), \fBgetauclassent\fR(3BSM), -\fBaudit_event\fR(4), \fBattributes\fR(5) -.SH NOTES -.LP -It is possible to deliberately turn on the \fBno\fR class in the kernel, in -which case the audit trail will be flooded with records for the audit event -\fBAUE_NULL\fR. diff --git a/usr/src/man/man4/audit_event.4 b/usr/src/man/man4/audit_event.4 deleted file mode 100644 index b1b0935138..0000000000 --- a/usr/src/man/man4/audit_event.4 +++ /dev/null @@ -1,171 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. -.\" 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 AUDIT_EVENT 4 "Mar 6, 2017" -.SH NAME -audit_event \- audit event definition and class mapping -.SH SYNOPSIS -.LP -.nf -\fB/etc/security/audit_event\fR -.fi - -.SH DESCRIPTION -.LP -\fB/etc/security/audit_event\fR is a user-configurable ASCII system file that -stores event definitions used in the audit system. As part of this definition, -each event is mapped to one or more of the audit classes defined in -\fBaudit_class\fR(4). -Programs can use the \fBgetauevent\fR(3BSM) routines to access audit -event information. -.sp -.LP -The fields for each event entry are separated by colons. Each event is -separated from the next by a NEWLINE.Each entry in the audit_event file has the -form: -.sp -.in +2 -.nf -\fInumber\fR:\fIname\fR:\fIdescription\fR:\fIflags\fR -.fi -.in -2 - -.sp -.LP -The fields are defined as follows: -.sp -.ne 2 -.na -\fB\fInumber\fR\fR -.ad -.RS 15n -Event number. -.sp -Event number ranges are assigned as follows: -.sp -.ne 2 -.na -\fB\fB0\fR\fR -.ad -.RS 15n -Reserved as an invalid event number. -.RE - -.sp -.ne 2 -.na -\fB\fB1-2047\fR\fR -.ad -.RS 15n -Reserved for the Solaris Kernel events. -.RE - -.sp -.ne 2 -.na -\fB\fB2048-32767\fR\fR -.ad -.RS 15n -Reserved for the Solaris TCB programs. -.RE - -.sp -.ne 2 -.na -\fB\fB32768-65535\fR\fR -.ad -.RS 15n -Available for third party TCB applications. -.sp -System administrators must \fBnot\fR add, delete, or modify (except to change -the class mapping), events with an event number less than \fB32768\fR. These -events are reserved by the system. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIname\fR\fR -.ad -.RS 15n -Event name. -.RE - -.sp -.ne 2 -.na -\fB\fIdescription\fR\fR -.ad -.RS 15n -Event description. -.RE - -.sp -.ne 2 -.na -\fB\fIflags\fR\fR -.ad -.RS 15n -Flags specifying classes to which the event is mapped. Classes are comma -separated, without spaces. -.sp -Obsolete events are commonly assigned to the special class \fBno\fR (invalid) -to indicate they are no longer generated. Obsolete events are retained to -process old audit trail files. Other events which are not obsolete may also be -assigned to the \fBno\fR class. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRUsing the \fBaudit_event\fR File -.sp -.LP -The following is an example of some \fBaudit_event\fR file entries: - -.sp -.in +2 -.nf -7:AUE_EXEC:exec(2):ps,ex -79:AUE_OPEN_WTC:open(2) - write,creat,trunc:fc,fd,fw -6152:AUE_login:login - local:lo -6153:AUE_logout:logout:lo -6154:AUE_telnet:login - telnet:lo -6155:AUE_rlogin:login - rlogin:lo -.fi -.in -2 -.sp - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability See below. -.TE - -.sp -.LP -The file format stability is Committed. The file content is Uncommitted. -.SH FILES -.ne 2 -.na -\fB\fB/etc/security/audit_event\fR\fR -.ad -.RS 29n - -.RE - -.SH SEE ALSO -.LP -\fBgetauevent\fR(3BSM), \fBaudit_class\fR(4) diff --git a/usr/src/man/man4/auth_attr.4 b/usr/src/man/man4/auth_attr.4 deleted file mode 100644 index eeac62e684..0000000000 --- a/usr/src/man/man4/auth_attr.4 +++ /dev/null @@ -1,275 +0,0 @@ -'\" te -.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 AUTH_ATTR 4 "Feb 25, 2017" -.SH NAME -auth_attr \- authorization description database -.SH SYNOPSIS -.LP -.nf -\fB/etc/security/auth_attr\fR -.fi - -.SH DESCRIPTION -.LP -\fB/etc/security/auth_attr\fR is a local source for authorization names and -descriptions. The \fBauth_attr\fR file can be used with other authorization -sources, including the \fBauth_attr\fR \fBNIS\fR map. -Programs use the \fBgetauthattr\fR(3SECDB) routines to access this information. -.sp -.LP -The search order for multiple authorization sources is specified in the -\fB/etc/nsswitch.conf\fR file, as described in the \fBnsswitch.conf\fR(4) man -page. -.sp -.LP -An authorization is a right assigned to users that is checked by certain -privileged programs to determine whether users can execute restricted -functionality. Each entry in the \fBauth_attr\fR database consists of one line -of text containing six fields separated by colons (\fB:\fR). Line continuations -using the backslash (\fB\e\fR) character are permitted. The format of each -entry is: -.sp -.in +2 -.nf -\fIname\fR:\fIres1\fR:\fIres2\fR:\fIshort_desc\fR:\fIlong_desc\fR:\fIattr\fR -.fi -.in -2 - -.sp -.ne 2 -.na -\fB\fIname\fR\fR -.ad -.RS 14n -The name of the authorization. Authorization names are unique strings. -Construct authorization names using the following convention: -.sp -\fIprefix.\fR or \fIprefix.suffix\fR -.sp -.ne 2 -.na -\fB\fIprefix\fR\fR -.ad -.RS 10n -Everything in the name field up to the final dot (\fB\&.\fR). Authorizations -from Sun Microsystems, Inc. use \fBsolaris\fR as a prefix. To avoid name -conflicts, all other authorizations should use a prefix that begins with the -reverse-order Internet domain name of the organization that creates the -authorization (for example, \fBcom.xyzcompany\fR). Prefixes can have additional -arbitrary components chosen by the authorization's developer, with components -separated by dots. -.RE - -.sp -.ne 2 -.na -\fB\fIsuffix\fR\fR -.ad -.RS 10n -The final component in the name field. Specifies what is being authorized. -.sp -When there is no suffix, the name is defined as a heading. Headings are not -assigned to users but are constructed for use by applications in their -\fBGUI\fRs. -.RE - -When a name ends with the word \fBgrant\fR, the entry defines a grant -authorization. Grant authorizations are used to support fine-grained -delegation. Users with appropriate grant authorizations can delegate some of -their authorizations to others. To assign an authorization, the user needs to -have both the authorization itself and the appropriate grant authorization. -.RE - -.sp -.ne 2 -.na -\fB\fIres1\fR\fR -.ad -.RS 14n -Reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIres2\fR\fR -.ad -.RS 14n -Reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIshort_desc\fR\fR -.ad -.RS 14n -A short description or terse name for the authorization. This name should be -suitable for displaying in user interfaces, such as in a scrolling list in a -\fBGUI\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIlong_desc\fR\fR -.ad -.RS 14n -A long description. This field can explain the precise purpose of the -authorization, the applications in which it is used, and the type of user that -would be interested in using it. The long description can be displayed in the -help text of an application. -.RE - -.sp -.ne 2 -.na -\fB\fIattr\fR\fR -.ad -.RS 14n -An optional list of semicolon-separated (\fB;\fR) key-value pairs that describe -the attributes of an authorization. Zero or more keys may be specified. The -keyword \fBhelp\fR identifies a help file in HTML. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRConstructing a Name -.sp -.LP -In the following example, the name has a prefix (\fBsolaris.admin.usermgr\fR) -followed by a suffix (\fBread\fR): - -.sp -.in +2 -.nf -solaris.admin.usermgr.read -.fi -.in -2 - -.LP -\fBExample 2 \fRDefining a Heading -.sp -.LP -Because the name field ends with a dot, the following entry defines a heading: - -.sp -.in +2 -.nf -solaris.admin.usermgr.:::User Accounts::help=AuthUsermgrHeader.html -.fi -.in -2 - -.LP -\fBExample 3 \fRAssigning Separate Authorizations to Set User Attributes -.sp -.LP -In this example, a heading entry is followed by other associated authorization -entries. The entries below the heading provide separate authorizations for -setting user attributes. The \fIattr\fR field for each entry, including the -heading entry, assigns a help file. The application that uses the \fBhelp\fR -key requires the value to equal the name of a file ending in \fB\&.htm\fR or -\fB\&.html\fR: - -.sp -.in +2 -.nf -solaris.admin.usermgr.:::User Accounts::help=AuthUsermgrHeader.html -solaris.admin.usermgr.pswd:::Change Password::help=AuthUserMgrPswd.html -solaris.admin.usermgr.write:::Manage Users::help=AuthUsermgrWrite.html -.fi -.in -2 - -.LP -\fBExample 4 \fRAssigning a Grant Authorization -.sp -.LP -This example assigns to an administrator the following authorizations: - -.sp -.in +2 -.nf -solaris.admin.printer.grant -solaris.admin.printer.delete -solaris.admin.printer.modify -solaris.admin.printer.read -solaris.login.enable -.fi -.in -2 - -.sp -.LP -With the above authorizations, the administrator can assign to others the -\fBsolaris.admin.printer.delete\fR, \fBsolaris.admin.printer.modify\fR, and -\fBsolaris.admin.printer.read\fR authorizations, but not the -\fBsolaris.login.enable\fR authorization. If the administrator has both the -grant authorization, \fBsolaris.admin.printmgr.grant\fR, and the wildcard -authorization, \fBsolaris.admin.printmgr.*\fR, the administrator can grant to -others any of the printer authorizations. See \fBuser_attr\fR(4) for more -information about how wildcards can be used to assign multiple authorizations -whose names begin with the same components. - -.LP -\fBExample 5 \fRAuthorizing the Ability to Assign Other Authorizations -.sp -.LP -The following entry defines an authorization that grants the ability to assign -any authorization created with a \fBsolaris\fR prefix, when the administrator -also has either the specific authorization being granted or a matching wildcard -entry: - -.sp -.in +2 -.nf -solaris.grant:::Grant All Solaris Authorizations::help=PriAdmin.html -.fi -.in -2 - -.LP -\fBExample 6 \fRConsulting the Local Authorization File Ahead of the NIS Table -.sp -.LP -With the following entry from \fB/etc/nsswitch.conf\fR, the local -\fBauth_attr\fR file is consulted before the \fBNIS\fR table: - -.sp -.in +2 -.nf -auth_attr:files nis -.fi -.in -2 - -.SH FILES -.LP -\fB/etc/nsswitch.conf\fR -.sp -.LP -\fB/etc/user_attr\fR -.sp -.LP -\fB/etc/security/auth_attr\fR -.SH SEE ALSO -.LP -\fBgetauthattr\fR(3SECDB), \fBgetexecattr\fR(3SECDB), -\fBgetprofattr\fR(3SECDB), \fBgetuserattr\fR(3SECDB), \fBexec_attr\fR(4), -\fBnsswitch.conf\fR(4), \fBuser_attr\fR(4) -.SH NOTES -.LP -Because the list of legal keys is likely to expand, any code that parses this -database must be written to ignore unknown key-value pairs without error. When -any new keywords are created, the names should be prefixed with a unique -string, such as the company's stock symbol, to avoid potential naming -conflicts. -.sp -.LP -Each application has its own requirements for whether the help value must be a -relative pathname ending with a filename or the name of a file. The only known -requirement is for the name of a file. -.sp -.LP -The following characters are used in describing the database format and must be -escaped with a backslash if used as data: colon (\fB:\fR), semicolon (\fB;\fR), -equals (\fB=\fR), and backslash (\fB\e\fR). diff --git a/usr/src/man/man4/autofs.4 b/usr/src/man/man4/autofs.4 deleted file mode 100644 index 1bc8567869..0000000000 --- a/usr/src/man/man4/autofs.4 +++ /dev/null @@ -1,113 +0,0 @@ -.\" -.\" 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] -.\" -.\" -.\" Copyright (c) 2002 Sun Microsystems, Inc. All rights reserved. -.\" Copyright 2016 Nexenta Systems, Inc. -.\" -.Dd March 1, 2016 -.Dt AUTOFS 4 -.Os -.Sh NAME -.Nm autofs -.Nd automount configuration properties -.Sh DESCRIPTION -The behavior of the -.Xr automount 1M -command and the -.Xr automountd 1M -daemon is controlled by property values that are stored in the Service -Management Facility, -.Xr smf 5 . -The -.Xr sharectl 1M -command should be used to query or change values for these properties. -.Pp -Changes made to -.Nm -property values on an -.Nm automount -or -.Nm automountd -command line override the values set using -.Xr sharectl 1M . -.Pp -The following list describes the properties: -.Bl -tag -width Ds -.It Sy timeout Ns = Ns Ar num -Specifies a duration, in seconds, that a file system is to remain mounted when -not in use. -The default value is 600 -.Pq 10 minutes . -Equivalent to the -.Fl t -option in -.Nm automount . -.It Sy automount_verbose Ns = Ns Sy true Ns | Ns Sy false -Verbose mode. -Causes you to be notified of non-critical events, such as -.Nm -mounts and unmounts. -The default value is -.Sy false . -Equivalent to the -.Fl v -option in -.Nm automount . -.It Sy automountd_verbose Ns = Ns Sy true Ns | Ns Sy false -Verbose mode. -Causes status messages to be logged to the svc:/system/filesystem/autofs:default -log file. -The default value is -.Sy false . -Equivalent to the -.Fl v -option in -.Nm automountd . -.It Sy nobrowse Ns = Ns Sy true Ns | Ns Sy false -Turn on or off browsing for all -.Nm -mount points. -The default value is -.Sy false . -Equivalent to the -.Fl n -option in -.Nm automountd . -.It Sy trace Ns = Ns Ar num -Expands each RPC call and logs it to svc:/system/filesystem/autofs:default -log file. -The default value, 0, turns off such tracing. -Starting with 1, with each higher value, the verbosity of trace output -increases. -.It Xo -.Sy environment Ns = Ns Ar name Ns = Ns Ar value Ns -.Oo , Ns Ar name Ns = Ns Ar value Oc Ns ... -.Xc -Specifies a comma separated list of environment variables. -If an environment variable has more than one value, those values should be -separated with a comma, preceded by a backslash as an escape character -.Pq Qq Sy \e, . -For example: -.Bd -literal -offset indent -VAR1=val1,VAR2=val2\e,val3 -.Ed -.El -.Sh SEE ALSO -.Xr automount 1M , -.Xr automountd 1M , -.Xr sharectl 1M , -.Xr smf 5 diff --git a/usr/src/man/man4/bart_manifest.4 b/usr/src/man/man4/bart_manifest.4 deleted file mode 100644 index dd2950a25f..0000000000 --- a/usr/src/man/man4/bart_manifest.4 +++ /dev/null @@ -1,306 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved -.\" 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 BART_MANIFEST 4 "December 28, 2020" -.SH NAME -bart_manifest \- system audit manifest file -.SH DESCRIPTION -The \fBbart\fR(1M) command generates a manifest that describes the contents of -a managed host. A manifest consists of a header and entries. Each entry -represents a single file. Entries are sorted in ascending order by file name. -Any nonstandard file names, such as those that contain embedded newline or tab -characters, have the special characters quoted prior to being sorted. See -\fBQuoting Syntax\fR. -.sp -.LP -Lines that begin with \fB!\fR supply metadata about the manifest. The manifest -version line indicates the manifest specification version. The date line shows -the date on which the manifest was created, in \fBdate\fR(1) form. -.sp -.LP -Some lines are ignored by the manifest comparison tool. Ignored lines include -blank lines, lines that consist only of white space, and comments that begin -with \fB#\fR. -.sp -.LP -In addition to metadata lines, the header contains the format comment block. -This comment block lists the attributes reported for each file type. -.sp -.LP -To see the format of a manifest file, see \fBEXAMPLES\fR. -.SS "Manifest File Entries" -Each manifest file entry is a single line of one of the following forms, -depending on the file type: -.sp -.in +2 -.nf -\fIfname\fR D \fIsize mode acl dirmtime uid gid\fR -\fIfname\fR P \fIsize mode acl mtime uid gid\fR -\fIfname\fR S \fIsize mode acl mtime uid gid\fR -\fIfname\fR F \fIsize mode acl mtime uid gid contents\fR -\fIfname\fR L \fIsize mode acl lnmtime uid gid dest\fR -\fIfname\fR B \fIsize mode acl mtime uid gid devnode\fR -\fIfname\fR C \fIsize mode acl mtime uid gid devnode\fR -.fi -.in -2 - -.sp -.LP -The fields of the manifest file entries are described as follows: -.sp -.ne 2 -.na -\fB\fIfname\fR\fR -.ad -.RS 12n -Name of the file. To prevent parsing problems that are caused by special -characters embedded in file names, file names are encoded as described in -Quoting Syntax. -.RE - -.sp -.ne 2 -.na -\fB\fItype\fR\fR -.ad -.RS 12n -Type of file. -.sp -Possible values for \fItype\fR are as follows: -.sp -.ne 2 -.na -\fBB\fR -.ad -.RS 5n -Block device node -.RE - -.sp -.ne 2 -.na -\fBC\fR -.ad -.RS 5n -Character device node -.RE - -.sp -.ne 2 -.na -\fBD\fR -.ad -.RS 5n -Directory -.RE - -.sp -.ne 2 -.na -\fBF\fR -.ad -.RS 5n -File -.RE - -.sp -.ne 2 -.na -\fBL\fR -.ad -.RS 5n -Symbolic link -.RE - -.sp -.ne 2 -.na -\fBP\fR -.ad -.RS 5n -Pipe -.RE - -.sp -.ne 2 -.na -\fBS\fR -.ad -.RS 5n -Socket -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIsize\fR\fR -.ad -.RS 12n -File size in bytes. -.RE - -.sp -.ne 2 -.na -\fB\fImode\fR\fR -.ad -.RS 12n -Octal number that represents the permissions of the file. -.RE - -.sp -.ne 2 -.na -\fB\fIacl\fR\fR -.ad -.RS 12n -ACL attributes for the file. For a file with ACL attributes, this field -contains the output from \fBacltotext()\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIuid\fR\fR -.ad -.RS 12n -Numerical user ID of the owner of this entry. -.RE - -.sp -.ne 2 -.na -\fB\fIgid\fR\fR -.ad -.RS 12n -Numerical group ID of the owner of this entry. -.RE - -.sp -.ne 2 -.na -\fB\fIdirmtime\fR\fR -.ad -.RS 12n -Modification time in seconds since 00:00:00 UTC, January 1, 1970 for -directories. -.RE - -.sp -.ne 2 -.na -\fB\fIlnmtime\fR\fR -.ad -.RS 12n -Creation time for links. -.RE - -.sp -.ne 2 -.na -\fB\fImtime\fR\fR -.ad -.RS 12n -Modification time in seconds since 00:00:00 UTC, January 1, 1970 for files. -.RE - -.sp -.ne 2 -.na -\fB\fIcontents\fR\fR -.ad -.RS 12n -Checksum value of the file. This attribute is only specified for regular files. -If you turn off context checking or if checksums cannot be computed, the value -of this field is \fB-\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIdest\fR\fR -.ad -.RS 12n -Destination of a symbolic link. -.RE - -.sp -.ne 2 -.na -\fB\fIdevnode\fR\fR -.ad -.RS 12n -Value of the device node. This attribute is for character device files and -block device files only. -.RE - -.SS "Quoting Syntax" -The rules file supports a quoting syntax for representing nonstandard file -names. -.sp -.LP -When generating a manifest for file names that contain embedded TAB, SPACE, or -NEWLINE characters, the special characters are encoded in their octal forms. -.sp - -.sp -.TS -box; -c | c -l | l . -Input Character Quoted Character -_ -SPACE \eSPACE -_ -TAB \eTAB -_ -NEWLINE \eNEWLINE -_ -? \e? -_ -[ \e[ -_ -* \e* -.TE - -.SH EXAMPLES -\fBExample 1 \fRSample Manifest File -.sp -.LP -The following is a sample system manifest file. The file entries are sorted by -the encoded versions of the file names to correctly handle special characters. - -.sp -.in +2 -.nf -! Version 1.0 -! Mon Feb 11 10:55:30 2002 -# Format: -# fname D size mode acl dirmtime uid gid -# fname P size mode acl mtime uid gid -# fname S size mode acl mtime uid gid -# fname F size mode acl mtime uid gid contents -# fname L size mode acl lnmtime uid gid dest -# fname B size mode acl mtime uid gid devnode -# fname C size mode acl mtime uid gid devnode -/etc D 3584 40755 user::rwx,group::r-x,mask::r-x,other::r-x, - 3c6803d7 0 3 -/etc/.login F 524 100644 user::rw-,group::r--,mask::r--,other::r--, - 3c165878 0 3 27b53d5c3e844af3306f1f12b330b318 -/etc/.pwd.lock F 0 100600 user::rw-,group::---,mask::---,other::---, - 3c166121 0 0 d41d8cd98f00b204e9800998ecf8427e -/etc/.syslog_door L 20 120777 user::rw-,group::r--,mask:: - rwx,other::r--,3c6803d5 0 0 /var/run/syslog_door -/etc/autopush L 16 120777 user::r-x,group::r-x,mask::r-x,other::r-x, - 3c165863 0 0 ../sbin/autopush -/etc/cron.d/FIFO P 0 10600 user::rw-,group::---,mask::---,other::---, - 3c6803d5 0 0 -.fi -.in -2 - -.SH SEE ALSO -\fBdate\fR(1), \fBbart\fR(1M), \fBbart_rules\fR(4), \fBattributes\fR(5) diff --git a/usr/src/man/man4/bart_rules.4 b/usr/src/man/man4/bart_rules.4 deleted file mode 100644 index e3a73623ed..0000000000 --- a/usr/src/man/man4/bart_rules.4 +++ /dev/null @@ -1,426 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved -.\" 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 BART_RULES 4 "Sep 9, 2003" -.SH NAME -bart_rules \- bart rules file -.SH DESCRIPTION -.sp -.LP -The \fBbart_rules\fR file is a text file that is used by the \fBbart\fR(1M) -command. The rules file determines which files to validate and which file -attributes of those files to ignore. -.sp -.LP -Some lines are ignored by the manifest comparison tool. Ignored lines include -blank lines, lines that consist only of white space, and comments that begin -with \fB#\fR. -.sp -.LP -The rules file supports three directives: \fBCHECK\fR, \fBIGNORE\fR, and a -\fIsubtree\fR directive, which is an absolute path name and optional pattern -matching modifiers. Each \fBCHECK\fR, \fBIGNORE\fR, and \fIsubtree\fR directive -must be on a separate line. Bart supports continuation of long lines using a -backslash (\fB\e\fR). The rules file uses the directives to create logical -blocks. -.SS "Syntax" -.sp -.LP -The syntax for the rules file is as follows: -.sp -.in +2 -.nf -[IGNORE \fIattribute\fR...]* -[CHECK] [\fIattribute\fR...]* - -\fIsubtree1\fR [\fIpattern\fR...]* -[IGNORE \fIattribute\fR...]* -[CHECK] [\fIattribute\fR...]* - -\fIsubtree2\fR [\fIpattern\fR...]* -\fIsubtree3\fR [\fIpattern\fR...]* -\fIsubtree4\fR [\fIpattern\fR...]* -[IGNORE \fIattribute\fR...]* -[CHECK] [\fIattribute\fR...]* -\&... -.fi -.in -2 - -.SS "Rule Blocks" -.sp -.LP -Rule blocks are composed of statements that are created by using directives and -arguments. -.sp -.LP -There are three types of blocks: -.sp -.ne 2 -.na -\fBGlobal Block\fR -.ad -.RS 16n -The first block in the file. The block is considered ``global'' if it specifies -\fBCHECK\fR and \fBIGNORE\fR statements, but no previous subtree statement. A -global block pertains to all subsequent blocks. -.RE - -.sp -.ne 2 -.na -\fBLocal block\fR -.ad -.RS 16n -A block that specifies \fBCHECK\fR and \fBIGNORE\fR statements as well as a -subtree directive. The rules in this block pertain to files and directories -found in the specified subtree. -.RE - -.sp -.ne 2 -.na -\fBHeir block\fR -.ad -.RS 16n -A block that contains a null \fBCHECK\fR statement, no arguments. This block -inherits the global \fBCHECK\fR statements and \fBIGNORE\fR statements. -.RE - -.sp -.LP -The order in which \fBCHECK\fR and \fBIGNORE\fR statements appear in blocks is -important. The \fBbart\fR command processes \fBCHECK\fR and \fBIGNORE\fR -statements in the order in which they are read, with later statements -overriding earlier statements. -.sp -.LP -Subtree specifications must appear one per line. Each specification must begin -with an absolute path name. Optionally, each specification can be followed by -pattern-matching arguments. -.sp -.LP -When a file system being tracked belongs to more than one subtree directive, -\fBbart\fR performs the following resolution steps: -.RS +4 -.TP -.ie t \(bu -.el o -Applies the \fBCHECK\fR and \fBIGNORE\fR statements set in the global block. -Note that all \fBCHECK\fR and \fBIGNORE\fR statements are processed in order. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Finds the last subtree directive that matches the file. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Processes the \fBCHECK\fR and \fBIGNORE\fR statements that belong to the last -matching subtree directive. These statements are processed in the order in -which they are read, overriding global settings. -.RE -.SS "Pattern Matching Statements" -.sp -.LP -There are two types of pattern matching statements -.sp -.ne 2 -.na -\fBAND\fR -.ad -.RS 7n -For a given subtree directive, all pattern matching statements are logically -ANDed with the subtree. Patterns have the following syntax: -.RS +4 -.TP -.ie t \(bu -.el o -Wildcards are permitted for both the subtree and pattern matching statements. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The exclamation point (\fB!\fR) character represents logical NOT. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A pattern that terminates with a slash is a subtree. The absence of a slash -indicates that the pattern is not a directory. The subtree itself does not -require an end slash. -.RE -For example, the following subtree example includes the contents of -\fB/home/nickiso/src\fR except for object files, core files, and all of the -SCCS subtrees. Note that directory names that terminate with \fB\&.o\fR and -directories named \fBcore\fR are \fBnot\fR excluded because the patterns -specified do not terminate with \fB/\fR. -.sp -.in +2 -.nf -/home/nickiso/src !*.o !core !SCCS/ -CHECK all -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fBOR\fR -.ad -.RS 7n -Group multiple subtree directives together. Such subtree directives are -logically ORed together. -.sp -.in +2 -.nf -/home/nickiso/src !*.o !core -/home/nickiso/Mail -/home/nickiso/docs *.sdw -CHECK all -IGNORE mtime lnmtime dirmtime -.fi -.in -2 - -The files included in the previous example are as follows: -.RS +4 -.TP -.ie t \(bu -.el o -Everything under \fB/home/nickiso/src\fR except for \fB*.o\fR and \fBcore\fR -files -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Everything under \fB/home/nickiso/Mail\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -All files under \fB/home/nickiso/docs\fR that end in \fB*.sdw\fR -.RE -For these files, all attributes are checked except for modification times. -.RE - -.SS "File Attributes" -.sp -.LP -The \fBbart\fR command uses \fBCHECK\fR and \fBIGNORE\fR statements to define -which attributes to track or ignore. Each attribute has an associated keyword. -.sp -.LP -The attribute keywords are as follows: -.sp -.ne 2 -.na -\fBacl\fR -.ad -.RS 12n -ACL attributes for the file. For a file with ACL attributes, this field -contains the output from \fBacltotext()\fR. -.RE - -.sp -.ne 2 -.na -\fBall\fR -.ad -.RS 12n -All attributes. -.RE - -.sp -.ne 2 -.na -\fBcontents\fR -.ad -.RS 12n -Checksum value of the file. This attribute is only specified for regular files. -If you turn off context checking or if checksums cannot be computed, the value -of this field is \fB-\fR. -.RE - -.sp -.ne 2 -.na -\fBdest\fR -.ad -.RS 12n -Destination of a symbolic link. -.RE - -.sp -.ne 2 -.na -\fBdevnode\fR -.ad -.RS 12n -Value of the device node. This attribute is for character device files and -block device files only. -.RE - -.sp -.ne 2 -.na -\fBdirmtime\fR -.ad -.RS 12n -Modification time in seconds since 00:00:00 UTC, January 1, 1970 for -directories. -.RE - -.sp -.ne 2 -.na -\fBgid\fR -.ad -.RS 12n -Numerical group ID of the owner of this entry. -.RE - -.sp -.ne 2 -.na -\fBlnmtime\fR -.ad -.RS 12n -Creation time for links. -.RE - -.sp -.ne 2 -.na -\fBmode\fR -.ad -.RS 12n -Octal number that represents the permissions of the file. -.RE - -.sp -.ne 2 -.na -\fBmtime\fR -.ad -.RS 12n -Modification time in seconds since 00:00:00 UTC, January 1, 1970 for files. -.RE - -.sp -.ne 2 -.na -\fBsize\fR -.ad -.RS 12n -File size in bytes. -.RE - -.sp -.ne 2 -.na -\fBtype\fR -.ad -.RS 12n -Type of file. -.RE - -.sp -.ne 2 -.na -\fBuid\fR -.ad -.RS 12n -Numerical user ID of the owner of this entry. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRSample Rules File -.sp -.LP -The following is a sample rules file: - -.sp -.in +2 -.nf -# Global rules, track everything except dirmtime. -CHECK all -IGNORE dirmtime - -# The files in /data* are expected to change, so don't bother -# tracking the attributes expected to change. -# Furthermore, by specifying ``IGNORE contents,'' you save -# time and resources. -/data* -IGNORE contents mtime size - -/home/nickiso f* bar/ -IGNORE acl - -# For /usr, apply the global rules. -/usr -CHECK - -# Note: Since /usr/tmp follows the /usr block, the /usr/tmp -# subtree is subjected to the ``IGNORE all.'' -/usr/tmp -/home/nickiso *.o -/home/nickiso core -/home/nickiso/proto -IGNORE all -.fi -.in -2 - -.sp -.LP -The following files are cataloged based on the sample rules file: - -.RS +4 -.TP -.ie t \(bu -.el o -All attributes, except for \fBdirmtime\fR, \fBmtime\fR, \fBsize\fR, and -\fBcontents\fR, are tracked for files under the \fB/data*\fR subtrees. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Files under the \fB/usr\fR subtree, except for \fB/usr/tmp\fR, are cataloged by -using the global rules. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -If the \fB/home/nickiso/foo.c\fR file exists, its attributes, except for -\fBacl\fR and \fBdirmtime\fR, are cataloged. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -All \fB\&.o\fR and \fBcore\fR files under \fB/home/nickiso\fR, as well as the -\fB/home/nickiso/proto\fR and \fB/usr/tmp\fR subtrees, are ignored. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -If the \fB/home/nickiso/bar/foo.o\fR file exists, it is ignored because it is -subject to the last block. -.RE -.SH SEE ALSO -.sp -.LP -\fBbart\fR(1M), \fBbart_manifest\fR(4), \fBattributes\fR(5) diff --git a/usr/src/man/man4/bhyve_config.4 b/usr/src/man/man4/bhyve_config.4 deleted file mode 100644 index 94572b7ace..0000000000 --- a/usr/src/man/man4/bhyve_config.4 +++ /dev/null @@ -1,524 +0,0 @@ -.\" SPDX-License-Identifier: BSD-2-Clause -.\" -.\" Copyright (c) 2021 John H. Baldwin <jhb@FreeBSD.org> -.\" -.\" 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 AUTHOR 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 AUTHOR 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. -.\" -.\" Portions Copyright 2022 OmniOS Community Edition (OmniOSce) Association. -.\" -.Dd February 26, 2022 -.Dt BHYVE_CONFIG 4 -.Os -.Sh NAME -.Nm bhyve_config -.Nd "bhyve configuration variables" -.Sh DESCRIPTION -.Xr bhyve 1M -uses a hierarchical tree of configuration variables to describe global and -per-device settings. -Internal nodes in this tree do not have a value, -only leaf nodes have values. -This manual describes the configuration variables understood by -.Xr bhyve 1M . -If additional variables are defined, -.Xr bhyve 1M -will ignore them and will not emit errors for unknown variables. -However, these additional variables can be referenced by other -variables as described below. -.Sh VARIABLE VALUES -Configuration variable values are stored as strings. -A configuration variable value may refer to one or more other -configuration values by name. -Instances of the pattern -.Sq % Ns Pq Ar var -are replaced by the value of the configuration variable -.Va var . -To avoid unwanted expansion, -.Sq % -characters can be escaped by a leading -.Sq % . -For example, -if a configuration variable -.Va disk -uses the value -.Pa /dev/zvol/bhyve/%(name) , -then the final value of the -.Va disk -variable will be set to the path of a ZFS volume whose name matches -the name of the virtual machine on the pool -.Pa bhyve . -.Pp -Some configuration variables may be interpreted as a boolean value. -For those variables the following case-insensitive values may be used to -indicate true: -.Pp -.Bl -bullet -offset indent -compact -.It -true -.It -on -.It -yes -.It -1 -.El -.Pp -The following values may be used to indicate false: -.Pp -.Bl -bullet -offset indent -compact -.It -false -.It -off -.It -no -.It -0 -.El -.Pp -Some configuration variables may be interpreted as an integer. -For those variables, -any syntax supported by -.Xr strtoul 3C -may be used. -.Sh GLOBAL SETTINGS -.Ss Architecture Neutral Settings -.Bl -column "memory.guest_in_core" "integer" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va name Ta string Ta Ta -The name of the VM. -.It Va cpus Ta integer Ta 1 Ta -The total number of virtual CPUs. -.It Va cores Ta integer Ta 1 Ta -The number of virtual cores in each virtual socket. -.It Va threads Ta integer Ta 1 Ta -The number of virtual CPUs in each virtual core. -.It Va sockets Ta integer Ta 1 Ta -The number of virtual sockets. -.It Va memory.size Ta string Ta 256M Ta -Guest physical memory size. -The size argument may be suffixed with one of K, M, G or T (either upper -or lower case) to indicate a multiple of kibibytes, mebibytes, gibibytes, -or tebibytes. -If no suffix is given, the value is assumed to be in mebibytes. -.It Va memory.wired Ta bool Ta false Ta -Wire guest memory. -.It Va acpi_tables Ta bool Ta false Ta -Generate ACPI tables; these tables are -.Em not -used on illumos. -.It Va destroy_on_poweroff Ta bool Ta false Ta -Destroy the VM on guest-initiated power-off. -.It Va gdb.address Ta string Ta localhost Ta -Hostname, IP address, or IPv6 address for the debug server. -.It Va gdb.port Ta integer Ta 0 Ta -TCP port number for the debug server. -If this is set to a non-zero value, a debug server -will listen for connections on this port. -.It Va gdb.wait Ta bool Ta false Ta -If the debug server is enabled, wait for a debugger to connect -before starting the guest. -.It Va rtc.use_localtime Ta bool Ta true Ta -The real time clock uses the local time of the host. -If this is set to false, the real time clock uses UTC. -.It Va uuid Ta string Ta Ta -The universally unique identifier (UUID) to use in the guest's -System Management BIOS System Information structure. -If an explicit value is not set, a valid UUID is generated from -the host's hostname and the VM name. -.It Va virtio_msix Ta bool Ta true Ta -Use MSI-X interrupts for PCI VirtIO devices. -If set to false, MSI interrupts are used instead. -.It Va config.dump Ta bool Ta false Ta -If this value is set to true then, after parsing command line options, -.Xr bhyve 1M -will write all of its configuration variables to -.Dv stdout -and exit. -No VM will be started. -.It Va privileges.debug Ta bool Ta false Ta -Enable debug messages relating to privilege management. -These messages are sent to -.Dv stdout . -.El -.Ss x86-Specific Settings -.Bl -column "x86.vmexit_on_pause" "integer" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va x86.mptable Ta bool Ta true Ta -Generate an MPTable. -.It Va x86.x2apic Ta bool Ta false Ta -Configure guest's local APICs in x2APIC mode. -.It Va x86.strictio Ta bool Ta false Ta -Exit if a guest accesses an I/O port that is not emulated. -By default, writes are ignored and reads return all bits set. -.It Va x86.strictmsr Ta bool Ta true Ta -Inject a general protection fault if a guest accesses a Model Specific -Register (MSR) that is not emulated. -If this is false, writes are ignored and reads return zero. -.It Va x86.vmexit_on_hlt Ta bool Ta false Ta -Force a VM exit when a guest CPU executes the -.Dv HLT -instruction. -This allows idle guest CPUs to yield the host CPU. -.It Va x86.vmexit_on_pause Ta bool Ta false Ta -Force a VM exit when a guest CPU executes the -.Dv PAUSE -instruction. -.El -.Sh DEVICE SETTINGS -Device settings are stored under a device node. -The device node's name is set by the parent bus of the device. -.Ss PCI Device Settings -PCI devices are described by a device node named -.Dq pci . Ns Ar bus . Ns Ar slot . Ns Ar function -where each of -.Ar bus , -.Ar slot , -and -.Ar function -are formatted as decimal values with no padding. -All PCI device nodes must contain a configuration variable named -.Dq device -which specifies the device model to use. -The following PCI device models are supported: -.Bl -tag -width indent -.It Li hostbridge -Provide a simple PCI-Host bridge device. -This is usually configured at pci0:0:0 and is required by most guest -operating systems. -.It Li ahci -AHCI storage controller. -.It Li e1000 -Intel e82545 network interface. -.It Li fbuf -VGA framebuffer device attached to VNC server. -.It Li lpc -LPC PCI-ISA bridge with COM1-COM4 16550 serial ports, -a boot ROM, -and an optional debug/test device. -This device must be configured on bus 0. -.It Li nvme -NVM Express (NVMe) controller. -.It Li passthru -PCI pass-through device. -.It Li uart -PCI 16550 serial device. -.It Li virtio-9p -VirtIO 9p (VirtFS) interface. -.It Li virtio-blk -VirtIO block storage interface. -.It Li virtio-console -VirtIO console interface. -.It Li virtio-net-viona -Accelerated VirtIO network interface. -.It Li net-viona -Legacy VirtIO network interface. -.It Li virtio-rnd -VirtIO random number generator interface. -.It Li xhci -Extensible Host Controller Interface (XHCI) USB controller. -.El -.Ss USB Device Settings -USB controller devices contain zero or more child USB devices -attached to slots. -Each USB device stores its settings in a node named -.Dq slot. Ns Va N -under the controller's device node. -.Va N -is the number of the slot to which the USB device is attached. -Note that USB slot numbers begin at 1. -All USB device nodes must contain a configuration variable named -.Dq device -which specifies the device model to use. -The following USB device models are supported: -.Bl -tag -width indent -.It Li tablet -A USB tablet device which provides precise cursor synchronization -when using VNC. -.El -.Ss Block Device Settings -Block devices use the following settings to configure their backing store. -These settings are stored in the configuration node of the respective device. -.Bl -column "sectorsize" "logical[/physical]" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It path Ta string Ta Ta -The path of the file or disk device to use as the backing store. -.It nocache Ta bool Ta false Ta -Disable caching on the backing file by opening the backing file with -.Dv O_DIRECT . -.It nodelete Ta bool Ta false Ta -Disable emulation of guest trim requests via -.Dv DIOCGDELETE -requests. -.It sync Ta bool Ta false Ta -Write changes to the backing file with synchronous writes. -.It direct Ta bool Ta false Ta -An alias for -.Va sync . -.It ro Ta bool Ta false Ta -Disable writes to the backing file. -.It sectorsize Ta Va logical Ns Op / Ns Va physical Ta Ta -Specify the logical and physical sector size of the emulated disk. -If the physical size is not specified, it is set to be equal to the logical -size. -.El -.Ss virtio-net-viona Network Backend Settings -Viona network devices use the following settings to configure their backend. -.Bl -column "feature_flags" "string" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It vnic Ta string Ta Ta -The VNIC to use for the network connection. -.It feature_mask Ta integer Ta 0 Ta -Specify a mask to apply to the virtio features advertised to the guest. -.El -.Ss Other Network Backend Settings -Other network devices use the following settings to configure their backend. -.Bl -column "feature_flags" "string" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It vnic Ta string Ta Ta -The VNIC to use for the network connection. -.It promiscphys Ta bool Ta false Ta -Enable promiscuous mode at the physical level. -.It promiscsap Ta bool Ta true Ta -Enable promiscuous mode at the SAP level. -.It promiscmulti Ta bool Ta true Ta -Enable promiscuous mode for all multicast addresses. -.It promiscrxonly Ta bool Ta true Ta -The selected promiscuous modes are only enabled for received traffic. -.El -.Ss UART Device Settings -.Bl -column "Name" "Format" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va path Ta path Ta Ta -Backend device for the serial port. -Either the pathname of a character device or -.Dq stdio -to use standard input and output of the -.Xr bhyve 1M -process. -.El -.Ss Host Bridge Settings -Host Bridge devices use the following settings. -When configuring parameters, either the -.Va model -by itself, or both of -.Va vendor -and -.Va devid -must be specified. -.Bl -column "vendor" "integer" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va model Ta string Ta netapp Ta -Specify a hostbridge model to emulate. -Valid model strings, and their associated vendor and device IDs are: -.Sy amd Pq 0x1022/0x7432 , -.Sy netapp Pq 0x1275/0x1275 , -.Sy i440fx Pq 0x8086/0x1237 -and -.Sy q35 Pq 0x8086/0x29b0 . -.It Va vendor Ta integer Ta 0x1275 Ta -PCI vendor ID. -.It Va devid Ta integer Ta 0x1275 Ta -PCI device ID. -.El -.Ss AHCI Controller Settings -AHCI controller devices contain zero or more ports each of which -provides a storage device. -Each port stores its settings in a node named -.Dq port. Ns Va N -under the controller's device node. -The -.Va N -values are formatted as successive decimal values starting with 0. -In addition to the block device settings described above, each -port supports the following settings: -.Bl -column "model" "integer" "generated" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va type Ta string Ta Ta -The type of storage device to emulate. -Must be set to either -.Dq cd -or -.Dq hd . -.It Va nmrr Ta integer Ta 0 Ta -Nominal Media Rotation Rate, also known as RPM. -A value 1 of indicates a device with no rate such as a Solid State Disk. -.It Va ser Ta string Ta generated Ta -Serial number of up to twenty characters. -A default serial number is generated using a hash of the backing -store's pathname. -.It Va rev Ta string Ta 001 Ta -Revision number of up to eight characters. -.It Va model Ta string Ta Ta -Model number of up to forty characters. -Separate default model strings are used for -.Dq cd -and -.Dq hd -device types. -.El -.Ss Frame Buffer Settings -.Bl -column "password" "[IP:]port" "127.0.0.1:5900" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va wait Ta bool Ta false Ta -Wait for a remote connection before starting the VM. -.It Va rfb Ta Oo Ar IP Ns \&: Oc Ns Ar port Ta 127.0.0.1:5900 Ta -TCP address to listen on for remote connections. -The IP address must be given as a numeric address. -IPv6 addresses must be enclosed in square brackets and -support scoped identifiers as described in -.Xr getaddrinfo 3SOCKET . -A bare port number may be given in which case the IPv4 -localhost address is used. -.It Va unix Ta string Ta Ta -UNIX socket to listen on for VNC connections. -.It Va vga Ta string Ta io Ta -VGA configuration. -More details are provided in -.Xr bhyve 1M . -.It Va w Ta integer Ta 1024 Ta -Frame buffer width in pixels. -.It Va h Ta integer Ta 768 Ta -Frame buffer height in pixels. -.It Va password Ta string Ta Ta -Password to use for VNC authentication. -This type of authentication is known to be cryptographically weak and is not -intended for use on untrusted networks. -.El -.Ss LPC Device Settings -The LPC bridge stores its configuration under a top-level -.Va lpc -node rather than under the PCI LPC device's node. -The following nodes are available under -.Va lpc : -.Bl -column "pc-testdev" "Format" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va bootrom Ta path Ta Ta -Path to a boot ROM. -The contents of this file are copied into the guest's -memory ending just before the 4GB physical address. -If a boot ROM is present, a firmware interface device is -also enabled for use by the boot ROM. -.It Va com1 Ta node Ta Ta -Settings for the COM1 serial port device. -.It Va com2 Ta node Ta Ta -Settings for the COM2 serial port device. -.It Va com3 Ta node Ta Ta -Settings for the COM3 serial port device. -.It Va com4 Ta node Ta Ta -Settings for the COM4 serial port device. -.It Va pc-testdev Ta bool Ta false Ta -Enable the PC debug/test device. -.El -.Ss NVMe Controller Settings -Each NVMe controller supports a single storage device. -The device can be backed either by a memory disk described by the -.Va ram -variable, or a block device using the block device settings described above. -In addition, each controller supports the following settings: -.Bl -column "ioslots" "Format" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va maxq Ta integer Ta 16 Ta -Maximum number of I/O submission and completion queue pairs. -.It Va qsz Ta integer Ta 2058 Ta -Number of elements in each I/O queue. -.It Va ioslots Ta integer Ta 8 Ta -Maximum number of concurrent I/O requests. -.It Va sectsz Ta integer Ta Ta -Sector size. -Can be one of 512, 4096, or 8192. -Devices backed by a memory disk use 4096 as the default. -Devices backed by a block device use the block device's sector size -as the default. -.It Va ser Ta string Ta Ta -Serial number of up to twenty characters. -A default serial number is generated using a hash of the device's PCI address. -.It Va eui64 Ta integer Ta Ta -IEEE Extended Unique Identifier. -If an EUI is not provided, a default is generated using a checksum of the -device's PCI address. -.It Va dsm Ta string Ta auto Ta -Whether or not to advertise Dataset Management (DSM) support. -One of -.Dq auto , -.Dq enable , -or -.Dq disable . -The -.Dq auto -setting only advertises support if the backing store supports -resource freeing, for example via TRIM. -.It Va ram Ta integer Ta Ta -If set, allocate a memory disk as the backing store. -The value of this variable is the size of the memory disk in megabytes. -.El -.Ss PCI Passthrough Settings -.Bl -column "Name" "integer" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va path Ta string Ta Ta -Path to a PCI passthrough device in the form -.Pa /dev/ppt Ns Ar N -where -.Ar N -is the device number. -.El -.Ss VirtIO 9p Settings -Each VirtIO 9p device exposes a single filesystem from a host path. -.Bl -column "sharename" "Format" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va sharename Ta string Ta Ta -The share name exposed to the guest. -.It Va path Ta path Ta Ta -The path of a directory on the host to export to the guest. -.It Va ro Ta bool Ta false Ta -If true, the guest filesystem is read-only. -.El -.Ss VirtIO Block Device Settings -In addition to the block device settings described above, each -VirtIO block device supports the following settings: -.Bl -column "model" "integer" "generated" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va ser Ta string Ta generated Ta -Serial number of up to twenty characters. -A default serial number is generated using a hash of the backing -store's pathname. -.El -.Ss VirtIO Console Device Settings -Each VirtIO Console device contains one or more console ports. -Each port stores its settings in a node named -.Dq port. Ns Va N -under the controller's device node. -The -.Va N -values are formatted as successive decimal values starting with 0. -Each port supports the following settings: -.Bl -column "Name" "Format" "Default" -.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description -.It Va name Ta string Ta Ta -The name of the port exposed to the guest. -.It Va path Ta path Ta Ta -The path of a UNIX domain socket providing the host connection for the port. -.El -.Sh SEE ALSO -.Xr bhyve 1M , -.Xr strtoul 3C , -.Xr getaddrinfo 3SOCKET diff --git a/usr/src/man/man4/bootparams.4 b/usr/src/man/man4/bootparams.4 deleted file mode 100644 index 50c582efff..0000000000 --- a/usr/src/man/man4/bootparams.4 +++ /dev/null @@ -1,227 +0,0 @@ -'\" te -.\" Copyright 2021 Peter Tribble -.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 BOOTPARAMS 4 "November 22, 2021" -.SH NAME -bootparams \- boot parameter data base -.SH SYNOPSIS -.nf -\fB/etc/bootparams\fR -.fi - -.SH DESCRIPTION -The \fBbootparams\fR file contains a list of client entries that diskless -clients use for booting. Diskless booting clients retrieve this information by -issuing requests to a server running the \fBrpc.bootparamd\fR(1M) program. The -\fBbootparams\fR file may be used in conjunction with or in place of other -sources for the \fBbootparams\fR information. See \fBnsswitch.conf\fR(4). -.sp -.LP -For each client the file contains an entry with the client's name and a list of -boot parameter values for that client. Each entry has the form: -.sp -.in +2 -.nf -\fIclientname keyword=value\fR... -.fi -.in -2 -.sp - -.sp -.LP -The first item of each entry is the host name of the diskless client. You can -use the asterisk ('*') character as a "wildcard" in place of the client name in -a single entry. A wildcard entry applies to all clients for which there is not -an entry that specifically names them. -.sp -.LP -In a given entry, the host name or asterisk is followed by one or more -whitespace characters and a series of keyword\(emvalue pairs separated by -whitespace characters. There must not be any whitespace within a -keyword\(emvalue pair. -.sp -.LP -Each keyword\(emvalue pair has the syntax: -.sp -.in +2 -.nf -\fIkeyword\fR\fB=\fR\fIvalue\fR -.fi -.in -2 -.sp - -.sp -.LP -The preceding form breaks out further as: -.sp -.in +2 -.nf -\fIkeyword\fR\fB=\fR\fIserver\fR\fB:\fR\fIvalue\fR -.fi -.in -2 -.sp - -.sp -.LP -Where \fIserver\fR can be null and \fIvalue\fR can be a pathname. -.sp -.LP -An example that includes a server is: -.sp -.in +2 -.nf -client1 root=server1:/export/client1/root -.fi -.in -2 -.sp - -.sp -.LP -An example where \fIserver\fR is null is: -.sp -.in +2 -.nf -client1 rootopts=:vers2 -.fi -.in -2 -.sp - -.sp -.LP -A minor variation of the \fIkeyword=value\fR syntax is used for the -\fBdomain\fR keyword. Unlike the forms shown above, this syntax does not use a -colon. For example: -.sp -.in +2 -.nf -client1 domain=bldg1.example.com -.fi -.in -2 -.sp - -.sp -.LP -Entries can span multiple lines. Use the backslash ('\e') character as the last -character of a line to continue the entry to the following line. For -multiple-line entries, you can split a line only in places where whitespace is -allowed. For example, you can use a backslash to split the following entry -between the end of the path (\fBroot\fR) and the keyword \fBdomain\fR: -.sp -.in +2 -.nf -client1 root=server1:/export/client1/root domain=bldg1.example.com -.fi -.in -2 -.sp - -.sp -.LP -In entries that specify a server, \fIserver\fR is the name of the server that -will provide the file or filesystem to the diskless client and \fIvalue\fR is -the pathname of the exported file or filesystem on that server. -.sp -.LP -In entries that use the \fBdomain\fR keyword, the domain name specified must be -the client's domain name. The algorithm for determining a client's domain name -is to first check for a \fBdomain\fR keyword in the client-specific entry and -then in "wildcard" entry. If none is found, the server's domain name is used. -.sp -.LP -For the JumpStart installation of machines that do not have video displays, use -the \fBterm\fR keyword to identify the terminal type of the boot server. -Terminal types are listed in \fB/usr/share/lib/terminfo\fR (see -\fBterminfo\fR(4)). -.sp -.LP -An entry with the \fBns\fR keyword associates a server (a name server) with, -instead of a pathname, a specific name service (\fBNIS+\fR, \fBNIS\fR, -\fBLDAP\fR, or \fBnone\fR) and, if that server is not on a local subnet, the -netmask needed to reach it. For example: -.sp -.in +2 -.nf -ns=hoot:nisplus(255.255.255.0) -.fi -.in -2 -.sp - -.sp -.LP -An \fBns\fR entry forces \fBsysidtool\fR to use the specified name service. -By default, \fBsysidtool\fR uses \fBNIS+\fR in preference to \fBNIS\fR or -\fBLDAP\fR if it can find an \fBNIS+\fR server for the system's domain on the -subnet. An \fBns\fR entry might be necessary if you are trying to set up a -hands-off installation, or if the name server is on a different subnet, which -is common with \fBNIS+\fR. -.sp -.LP -If an \fBns\fR keyword is not used, \fBsysidtool\fR uses broadcast to attempt -to bind to either a \fBNIS+\fR, \fBNIS\fR, or \fBLDAP\fR server. If a name -server is not on the local subnet, which is possible for \fBNIS+\fR or -\fBLDAP\fR, the bind will fail, automatic configuration of the name service -will fail, and an interactive screen is displayed, prompting the user to -specify the name service. -.sp -.LP -The \fBns\fR keyword can be set in \fBadd_install_client\fR or by Host Manager. -.SH EXAMPLES -\fBExample 1 \fRSample \fBbootparams\fR Entry -.sp -.LP -Here is an example of an entry in the \fBbootparams\fR file: - -.sp -.in +2 -.nf - client1 root=server1:/export/client1/root rootopts=:vers=2 \e - domain=bldg1.example.com - client2 root=server2:/export/client2/root ns=:nis - client3 root=server2:/export/client3/root ns=watson: - client4 root=server2:/export/client4/root \e - ns=mach:nisplus(255.255.255.0) -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRSample Entry for JumpStart -.sp -.LP -The following is an example of an entry that might be used for the JumpStart -installation of diskless clients that do not have displays. - -.sp -.in +2 -.nf -mozart root=haydn:/export/install/sparc/os/latest/Solaris_9/boot \e -install=haydn:/export/install/sparc/os/8.1/latest boottype=:in \e -install_config=haydn:/usr/local/share/lib/jump-net \e -ns=otis:nisplus(255.255.255.0) term=:xterms domain=eu.cte.example.com -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/etc/bootparams\fR\fR -.ad -.RS 19n - -.RE - -.SH SEE ALSO -\fBrpc.bootparamd\fR(1M), \fBnsswitch.conf\fR(4) -.SH NOTES -The \fBNIS+\fR, \fBsysidtool\fR, and jumpstart facilities are not present in -illumos. They are documented here solely for users who wish to use illumos as -a jumpstart server for older Solaris releases. -.sp -.LP -Solaris diskless clients use the keywords \fBroot\fR and \fBrootopts\fR to look -up the pathname for the root filesystem and the mount options for the root -filesystem, respectively. These are the only keywords meaningful for diskless -booting clients. See \fBmount_ufs\fR(1M). diff --git a/usr/src/man/man4/cardbus.4 b/usr/src/man/man4/cardbus.4 deleted file mode 100644 index a2bdfab88e..0000000000 --- a/usr/src/man/man4/cardbus.4 +++ /dev/null @@ -1,237 +0,0 @@ -'\" te -.\" Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved -.\" 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 CARDBUS 4 "Jul 11, 2006" -.SH NAME -cardbus \- configuration files for cardbus device drivers -.SH DESCRIPTION -.sp -.LP -The CardBus bus share the same configuration parameters with the PCI bus. -CardBus devices are self-identifying, which means that these devices provide -configuration parameters to the system that allow the system to identify the -device and its driver. The configuration parameters are represented in the form -of name-value pairs that can be retrieved using the \fBDDI\fR property -interfaces. See \fBddi_prop_lookup\fR(9F) for details. -.sp -.LP -The CardBus bus properties of CardBus devices are derived from PCI -configuration space. Therefore, driver configuration files are not necessary -for these devices. -.sp -.LP -On some occasions, drivers for CardBus devices can use driver configuration -files to provide driver private properties through the global property -mechanism. See \fBdriver.conf\fR(4) for further details. Driver configuration -files can also be used to augment or override properties for a specific -instance of a driver. -.sp -.LP -The CardBus nexus driver recognizes the following properties: -.sp -.ne 2 -.na -\fB\fBreg\fR\fR -.ad -.RS 14n -An arbitrary length array where each element of the array consists of a 5-tuple -of 32-bit values. Each array element describes a logically contiguous mappable -resource on the \fBPCI\fR bus. -.sp -The first three values in the 5-tuple describe the \fBPCI\fR address of the -mappable resource. The first tuple contains the following information: -.sp - -.sp -.TS -l l l -l l l . -Bits 0 - 7 8-bit register number -Bits 8 - 10 3-bit function number -Bits 11 - 15 5-bit device number -Bits 16 - 23 8-bit bus number -Bits 24 - 25 2-bit address space type identifier -Bits 31 - 28 T{ -Register number extended bits 8:11 for extended config space. Zero for conventional configuration space. -T} -.TE - -The address space type identifier can be interpreted as follows: -.sp - -.sp -.TS -l l l -l l l . -0x0 configuration space -0x1 I/O space -0x2 32-bit memory space address -.TE - -The bus number is a unique identifying number assigned to each bus within the -\fBPCI\fR or PCIe domain. -.sp -The device number is a unique identifying number assigned to each device on a -\fBPCI\fR bus, PCIe logical bus, or CardBus bus. A device number is unique only -within the set of device numbers for a particular bus or logical bus. -.sp -Each CardBus device can have one to eight logically independent functions, each -with its own independent set of configuration registers. Each function on a -device is assigned a function number. For a device with only one function, the -function number must be \fB0\fR. -.sp -The register number fields select a particular register within the set of -configuration registers corresponding to the selected function. When the -address space type identifier indicates configuration space, non-zero register -number extended bits select registers in extended configuration space. -.sp -The second and third values in the \fBreg\fR property 5-tuple specify the -64-bit address of the mappable resource within the \fBPCI\fR or PCIe address -domain. Since the CardBus is a 32-bit bus, the second 32-bit tuple is not used. -The third 32-bit tuple corresponds to the 32-bit address. -.sp -The fourth and fifth 32-bit values in the 5-tuple \fBreg\fR property specify -the size of the mappable resource. The size is a 64-bit value. Since it's a -32-bit bus, only the fifth tuple is used. -.sp -The driver can refer to the elements of this array by index, and construct -kernel mappings to these addresses using \fBddi_regs_map_setup\fR(9F). The -index into the array is passed as the \fIrnumber\fR argument of -\fBddi_regs_map_setup\fR(9F). -.sp -At a high-level interrupt context, you can use the \fBddi_get*\fR and -\fBddi_put*\fR family of functions to access I/O and memory space. However, -access to configuration space is not allowed when running at a high-interrupt -level. -.RE - -.sp -.ne 2 -.na -\fB\fBinterrupts\fR\fR -.ad -.RS 14n -This property consists of a single-integer element array. Valid interrupt -property values are \fB1\fR, \fB2\fR, \fB3\fR, and \fB4\fR. This value is -derived directly from the contents of the device's configuration-interrupt-pin -register. -.sp -A driver should use an index value of \fB0\fR when registering its interrupt -handler with the DDI interrupt interfaces. -.RE - -.sp -.LP -All CardBus devices support the \fBreg\fR property. The device number and -function number as derived from the \fBreg\fR property are used to construct -the address part of the device name under \fB/devices\fR. -.sp -.LP -Only devices that generate interrupts support an \fBinterrupts\fR property. -.sp -.LP -Occasionally it might be necessary to override or augment the configuration -information supplied by a CardBus device. This change can be achieved by -writing a driver configuration file that describes a prototype device node -specification containing the additional properties required. -.sp -.LP -For the system to merge the prototype node specification into an actual device -node, certain conditions must be met. -.RS +4 -.TP -.ie t \(bu -.el o -First, the \fBname\fR property must be identical. The value of the \fBname\fR -property needs to match the binding name of the device. The binding name is the -name chosen by the system to bind a driver to a device and is either an alias -associated with the driver or the hardware node name of the device. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Second, the parent property must identify the PCI bus or PCIe logical bus. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Third, the unit-address property must identify the card. The format of the -unit-address property is: -.RE -.sp -.LP -\fBDD[,F]\fR -.sp -.LP -where \fBDD\fR is the device number and \fBF\fR is the function number. If the -function number is 0, only \fBDD\fR is specified. -.SH EXAMPLES -.LP -\fBExample 1 \fRSample Configuration File -.sp -.LP -An example configuration file called \fBACME,scsi-hba.conf\fR for a CardBus -device driver called \fBACME,scsi-hba\fR follows: - -.sp -.in +2 -.nf -# -# Copyright (c) 1995, ACME SCSI Host Bus Adaptor -# ident "@(#)ACME,scsi-hba.conf 1.1 96/02/04" -name="ACME,scsi-hba" parent="/pci@1,0/pci@1f,4000" - unit-address="3" scsi-initiator-id=6; -hba-advanced-mode="on"; -hba-dma-speed=10; -.fi -.in -2 -.sp - -.sp -.LP -In this example, a property \fBscsi-initiator-id\fR specifies the \fBSCSI\fR -bus initiator id that the adapter should use, for just one particular instance -of adapter installed in the machine. The \fBname\fR property identifies the -driver and the parent property to identify the particular bus the card is -plugged into. This example uses the parent's full path name to identify the -bus. The unit-address property identifies the card itself, with device number -of 3 and function number of 0. - -.sp -.LP -Two global driver properties are also created: \fBhba-advanced-mode\fR (which -has the string value \fBon\fR) and \fBhba-dma-speed\fR (which has the value -\fB10\fR M bit/s). These properties apply to all device nodes of the -\fBACME,scsi-hba\fR. - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdriver.conf\fR(4), \fBattributes\fR(5), \fBddi_intr_add_handler\fR(9F), -\fBddi_prop_lookup\fR(9F), \fBddi_regs_map_setup\fR(9F) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIIEEE 1275 PCI Bus Binding\fR diff --git a/usr/src/man/man4/compver.4 b/usr/src/man/man4/compver.4 deleted file mode 100644 index 7d515af71c..0000000000 --- a/usr/src/man/man4/compver.4 +++ /dev/null @@ -1,60 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved -.\" 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 COMPVER 4 "Oct 4, 1996" -.SH NAME -compver \- compatible versions file -.SH DESCRIPTION -.sp -.LP -\fBcompver\fR is an \fBASCII\fR file used to specify previous versions of the -associated package which are upward compatible. It is created by a package -developer. -.sp -.LP -Each line of the file specifies a previous version of the associated package -with which the current version is backward compatible. -.sp -.LP -Since some packages may require installation of a specific version of another -software package, compatibility information is extremely crucial. Consider, for -example, a package called "A" which requires version "1.0" of application "B" -as a prerequisite for installation. If the customer installing "A" has a newer -version of "B" (version 1.3), the \fBcompver\fR file for "B" must indicate that -"1.3" is compatible with version "1.0" in order for the customer to install -package "A". -.SH EXAMPLES -.LP -\fBExample 1 \fRSample \fBcompver\fR file. -.sp -.LP -A sample \fBcompver\fR file is shown below: - -.sp -.in +2 -.nf -\fBVersion 1.3 -Version 1.0\fR -.fi -.in -2 -.sp - -.SH SEE ALSO -.sp -.LP -\fBpkginfo\fR(4) -.sp -.LP -\fIApplication Packaging Developer\&'s Guide\fR -.SH NOTES -.sp -.LP -The comparison of the version string disregards white space and tabs. It is -performed on a word-by-word basis. Thus, "Version 1.3" and "Version 1.3" would -be considered the same. -.sp -.LP -The entries in the \fBcompver\fR file must match the values assigned to the -\fBVERSION\fR parameter in the \fBpkginfo\fR(4) files. diff --git a/usr/src/man/man4/contents.4 b/usr/src/man/man4/contents.4 deleted file mode 100644 index e8c81ec5c4..0000000000 --- a/usr/src/man/man4/contents.4 +++ /dev/null @@ -1,245 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 CONTENTS 4 "Dec 20, 2007" -.SH NAME -contents \- list of files and associated packages -.SH SYNOPSIS -.LP -.nf -\fB/var/sadm/install/contents\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The file \fB/var/sadm/install/contents\fR is a source of information about the -packages installed on the system. This file must never be edited directly. -Always use the package commands (see SEE ALSO) to make changes to the -\fBcontents\fR file. -.sp -.LP -Each entry in the \fBcontents\fR file is a single line. Fields in each entry -are separated by a single space character. -.sp -.LP -Two major styles of entries exist, old style and new style. The following is -the format of an old-style entry: -.sp -.in +2 -.nf -\fIftype\fR \fIclass\fR \fIpath\fR \fIpackage(s)\fR -.fi -.in -2 - -.sp -.LP -The following is the general format of a new-style entry: -.sp -.in +2 -.nf -\fIpath\fR[=\fIrpath\fR] \fIftype\fR \fIclass\fR [\fIftype-optional-fields\fR] \fIpackage(s)\fR -.fi -.in -2 - -.sp -.LP -New-style entries differ for each \fBftype\fR. The \fBftype\fR designates the -entry type, as specified in \fBpkgmap\fR(4). The format for new-style entries, -for each \fBftype\fR, is as follows: -.sp -.in +2 -.nf -ftype s: \fIpath\fR=\fIrpath\fR s \fIclass\fR \fIpackage\fR -ftype l: \fIpath\fR l \fIclass\fR \fIpackage\fR -ftype d: \fIpath\fR d \fIclass\fR \fImode\fR \fIowner\fR \fIgroup\fR \fIpackage(s)\fR -ftype b: \fIpath\fR b \fIclass\fR \fImajor\fR \fIminor\fR \fImode\fR \fIowner\fR \fIgroup\fR \fIpackage\fR -ftype c: \fIpath\fR c \fIclass\fR \fImajor\fR \fIminor\fR \fImode\fR \fIowner\fR \fIgroup\fR \fIpackage\fR -ftype f: \fIpath\fR f \fIclass\fR \fImode\fR \fIowner\fR \fIgroup\fR \fIsize\fR \fIcksum\fR \fImodtime\fR \fIpackage\fR -ftype x: \fIpath\fR x \fIclass\fR \fImode\fR \fIowner\fR \fIgroup\fR \fIpackage\fR -ftype v: \fIpath\fR v \fIclass\fR \fImode\fR \fIowner\fR \fIgroup\fR \fIsize\fR \fIcksum\fR \fImodtime\fR \fIpackage\fR -ftype e: \fIpath\fR e \fIclass\fR \fImode\fR \fIowner\fR \fIgroup\fR \fIsize\fR \fIcksum\fR \fImodtime\fR \fIpackage\fR -.fi -.in -2 - -.sp -.LP -A significant distinction between old- and new-style entries is that the former -do not begin with a slash (/) character, while the latter (new-style) always -do. For example, the following are old-style entries: -.sp -.in +2 -.nf -d none /dev SUNWcsd -e passwd /etc/passwd SUNWcsr -.fi -.in -2 - -.sp -.LP -The following are new-style entries: -.sp -.in +2 -.nf -/dev d none 0755 root sys SUNWcsr SUNWcsd -/etc/passwd e passwd 0644 root sys 580 48299 1077177419 SUNWcsr -.fi -.in -2 - -.sp -.LP -The following are the descriptions of the fields in both old- and new-style -entries. -.sp -.ne 2 -.na -\fB\fIpath\fR\fR -.ad -.RS 11n -The absolute path of the node being described. For \fBftype\fR \fBs\fR -(indicating a symbolic link) this is the indirect pointer (link) name. -.RE - -.sp -.ne 2 -.na -\fB\fIrpath\fR\fR -.ad -.RS 11n -The relative path to the real file or linked-to directory name. -.RE - -.sp -.ne 2 -.na -\fB\fIftype\fR\fR -.ad -.RS 11n -A one-character field that indicates the entry type (see \fBpkgmap\fR(4)). -.RE - -.sp -.ne 2 -.na -\fB\fIclass\fR\fR -.ad -.RS 11n -The installation class to which the file belongs (see \fBpkgmap\fR(4)). -.RE - -.sp -.ne 2 -.na -\fB\fIpackage\fR\fR -.ad -.RS 11n -The package associated with this entry. For \fBftype\fR \fBd\fR (directory) -more than one package can be present. -.RE - -.sp -.ne 2 -.na -\fB\fImode\fR\fR -.ad -.RS 11n -The octal mode of the file (see \fBpkgmap\fR(4)). -.RE - -.sp -.ne 2 -.na -\fB\fIowner\fR\fR -.ad -.RS 11n -The owner of the file (see \fBpkgmap\fR(4)). -.RE - -.sp -.ne 2 -.na -\fB\fIgroup\fR\fR -.ad -.RS 11n -The group to which the file belongs (see \fBpkgmap\fR(4)). -.RE - -.sp -.ne 2 -.na -\fB\fImajor\fR\fR -.ad -.RS 11n -The major device number (see \fBpkgmap\fR(4)). -.RE - -.sp -.ne 2 -.na -\fB\fIminor\fR\fR -.ad -.RS 11n -The minor device number (see \fBpkgmap\fR(4)). -.RE - -.sp -.ne 2 -.na -\fB\fIsize\fR\fR -.ad -.RS 11n -The actual size of the file in bytes as reported by sum (see \fBpkgmap\fR(4)). -.RE - -.sp -.ne 2 -.na -\fB\fIcksum\fR\fR -.ad -.RS 11n -The checksum of the file contents (see \fBpkgmap\fR(4)). -.RE - -.sp -.ne 2 -.na -\fB\fImodtime\fR\fR -.ad -.RS 11n -The time of last modification (see \fBpkgmap\fR(4)). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Unstable -.TE - -.SH SEE ALSO -.sp -.LP -\fBpkgadd\fR(1M), \fBpkgadm\fR(1M), \fBpkgchk\fR(1M), \fBpkgmap\fR(4), -\fBattributes\fR(5) -.SH NOTES -.sp -.LP -As shown above, the interface stability of \fB/var/sadm/install/contents\fR is -Unstable (see \fBattributes\fR(5)). It is common practice to use this file in a -read-only manner to determine which files belong to which packages installed on -a system. While this file has been present for many releases of the Solaris -operating system, it might not be present in future releases. The fully -supported way to obtain information from the installed package database is -through \fBpkgchk\fR(1M). It is highly recommended that you use \fBpkgchk\fR -rather than relying on the \fBcontents\fR file. diff --git a/usr/src/man/man4/contract.4 b/usr/src/man/man4/contract.4 deleted file mode 100644 index 8c261b5711..0000000000 --- a/usr/src/man/man4/contract.4 +++ /dev/null @@ -1,616 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 CONTRACT 4 "Nov 26, 2017" -.SH NAME -contract \- the contract file system -.SH SYNOPSIS -.LP -.nf -\fB/system/contract\fR -.fi - -.SH DESCRIPTION -.LP -The \fB/system/contract\fR file system acts as the primary interface to the -contract subsystem. There is a subdirectory of \fB/system/contract\fR for each -available contract type. -.sp -.LP -\fB/system/contract\fR can be mounted on any mount point, in addition to the -standard \fB/system/contract\fR mount point, and can be mounted several places -at once. Such additional mounts are allowed in order to facilitate the -confinement of processes to subtrees of the file system using \fBchroot\fR(1M) -and yet allow such processes to continue to use contract commands and -interfaces. -.sp -.LP -A combination of standard system calls (for example, \fBopen\fR(2), -\fBclose\fR(2), and \fBpoll\fR(2)) and calls to \fBlibcontract\fR(3LIB) access -\fB/system/contract\fR files. -.sp -.LP -Consumers of the contract file system must be large file aware. See -\fBlargefile\fR(5) and \fBlfcompile64\fR(5). -.SS "DIRECTORY STRUCTURE" -.LP -At the top level, the \fB/system/contract\fR directory contains subdirectories -named with each available contract type, and one special directory, \fBall\fR. -Each of these directories is world-readable and world-searchable. -.SS "STRUCTURE OF \fB/system/contract/\fItype\fR\fR" -.LP -Each \fB/system/contract/\fItype\fR\fR directory contains a fixed number of -files. It also contains a variable number of subdirectories corresponding to -existing contracts of type \fItype\fR and named with the decimal representation -of the contracts' IDs. -.sp -.LP -The following files are in a \fB/system/contract/\fItype\fR\fR directory: -.sp -.ne 2 -.na -\fB\fBtemplate\fR\fR -.ad -.RS 12n -Opening this file returns a file descriptor for a new \fItype\fR contract -template. -.sp -You can use the following \fBlibcontract\fR(3LIB) calls on a template file -descriptor: -.sp -.in +2 -.nf -> - - ct_tmpl_activate(3contract) - ct_tmpl_clear(3contract) - ct_tmpl_create(3contract) -.fi -.in -2 -.sp - -See TERMS for additional template functions. -.RE - -.sp -.ne 2 -.na -\fBlatest\fR -.ad -.RS 12n -Opening this file returns a file descriptor for the status file of the last -\fItype\fR contract written by the opening LWP. See \fBSTRUCTURE OF -/system/contract/\fItype\fR/\fIid\fR\fR. If the opening LWP has not created a -\fItype\fR contract, opening latest fails with \fBESRCH\fR. -.RE - -.sp -.ne 2 -.na -\fBbundle\fR -.ad -.RS 12n -Opening this file returns a file descriptor for an event endpoint which -receives events from all \fItype\fR contracts on the system. No privileges are -required to open a type bundle event endpoint. Events sent by contracts owned -and written by users other than the reader's effective user id are invisible, -that is, they are silently skipped, unless the reader has -\fB{PRIV_CONTRACT_OBSERVER}\fR in its effective set. See \fBEVENTS\fR. -.RE - -.sp -.ne 2 -.na -\fBpbundle\fR -.ad -.RS 12n -Opening this file returns a file descriptor for an event endpoint which -receives events from all \fItype\fR contracts held by the opening process. See -\fBEVENTS\fR. -.RE - -.SS "STRUCTURE OF /system/contract/all" -.LP -The \fB/system/contract/all\fR directory contains a numerically named file for -each contract in the system. Each file is a symbolic link to the type-specific -directory for that contract, that is \fB/system/contract/all/\fIid\fR\fR points -to \fB/system/contract/\fItype\fR/\fIid\fR\fR. -.SS "STRUCTURE OF /system/contract/\fItype\fR/\fIid\fR" -.LP -Each \fB/system/contract/\fItype\fR/\fIid\fR\fR directory contains the -following files: -.sp -.ne 2 -.na -\fBctl\fR -.ad -.RS 10n -Opening this file returns a file descriptor for contract \fIid\fR's control -file. The open fails if the opening process does not hold contract \fIid\fR and -the contract has not been inherited by the process contract of which the -opening process is a member. See \fBprocess\fR(4). -.sp -The following \fBlibcontract\fR(3LIB) calls can be made on a \fBctl\fR file -descriptor if the contract is owned by the caller: -.sp -.in +2 -.nf -ct_ctl_abandon(3contract) -ct_ctl_newct(3contract) -ct_ctl_ack(3contract) -ct_ctl_qack(3contract) -.fi -.in -2 -.sp - -The following \fBlibcontract\fR(3LIB) call can be made on a ctl file descriptor -if the contract doesn't have an owner: -.sp -.in +2 -.nf -ct_ctl_adopt(3contract) -.fi -.in -2 -.sp - -.RE - -.sp -.ne 2 -.na -\fBstatus\fR -.ad -.RS 10n -Opening this file returns a file descriptor for contract \fIid\fR's status -file. The following \fBlibcontract\fR(3LIB) calls can be made on a status file -descriptor: -.LP -.nf -ct_status_read(3contract) -.fi - - See STATUS. -.RE - -.sp -.ne 2 -.na -\fBevents\fR -.ad -.RS 10n -Opening this file returns a file descriptor for an event endpoint which -receives events from contract \fIid\fR. See \fBEVENTS\fR. -.sp -Only a process which has the same effective user ID as the process owning the -contract, the same effective user ID as the contract's author, or has -\fB{PRIV_CONTRACT_OBSERVER}\fR in its effective set can open the event endpoint -for a contract. -.RE - -.SS "TERMS" -.LP -The following terms are defined for all contracts: -.sp -.ne 2 -.na -\fBcookie\fR -.ad -.RS 25n -Specifies a 64-bit quantity that the contract author can use to identify the -contract. Use \fBct_tmpl_set_cookie\fR(3CONTRACT) to set this term. -.RE - -.sp -.ne 2 -.na -\fBinformative event set\fR -.ad -.RS 25n -Selects which events are delivered as informative events. Use -\fBct_tmpl_set_informative\fR(3CONTRACT) to set this term. -.RE - -.sp -.ne 2 -.na -\fBcritical event set\fR -.ad -.RS 25n -Selects which events are delivered as critical events. Use -\fBct_tmpl_set_critical\fR(3CONTRACT) to set this term. -.RE - -.SS "STATUS" -.LP -A status object returned by \fBct_status_read\fR(3CONTRACT) contains the -following pieces of information: -.sp -.ne 2 -.na -\fBcontract ID\fR -.ad -.sp .6 -.RS 4n -The numeric ID of the contract. Use \fBct_status_get_id\fR(3CONTRACT) to obtain -this information. -.RE - -.sp -.ne 2 -.na -\fBcontract type\fR -.ad -.sp .6 -.RS 4n -The type of the contract, specified as a string. Obtained using -\fBct_status_get_type\fR(3CONTRACT). The contract type is the same as its -subdirectory name under \fB/system/contract\fR. -.RE - -.sp -.ne 2 -.na -\fBcreator's zone ID\fR -.ad -.sp .6 -.RS 4n -The zone ID of the process which created the contract. Obtained using -\fBct_status_get_zoneid\fR(3CONTRACT). -.RE - -.sp -.ne 2 -.na -\fBownership state\fR -.ad -.sp .6 -.RS 4n -The state of the contract, specified as \fBCTS_OWNED\fR, \fBCTS_INHERITED\fR, -\fBCTS_ORPHAN\fR, or \fBCTS_DEAD\fR. Use \fBct_status_get_state\fR(3CONTRACT) -to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBcontract holder\fR -.ad -.sp .6 -.RS 4n -If the contract's state is \fBCTS_OWNED\fR, the ID of the process which owns -the contract. If the contract's state is \fBCTS_INHERITED\fR, the ID of the -contract which is acting as regent. If the contract's state is \fBCTS_ORPHAN\fR -or \fBCTS_DEAD\fR, this is undefined. Use \fBct_status_get_holder\fR(3CONTRACT) -to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBnumber of critical events\fR -.ad -.sp .6 -.RS 4n -The number of unacknowledged critical events pending on the contract's event -queue. Use \fBct_status_get_nevents\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBnegotiation time\fR -.ad -.sp .6 -.RS 4n -The time remaining before the current synchronous negotiation times out. Use -\fBct_status_get_ntime\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBnegotiation quantum time\fR -.ad -.sp .6 -.RS 4n -The time remaining before the current negotiation quantum runs out. Use -\fBct_status_get_qtime\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBnegotiation event ID\fR -.ad -.sp .6 -.RS 4n -The ID of the event which initiated the negotiation timeout. Use -\fBct_status_get_nevid\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBcookie (term)\fR -.ad -.sp .6 -.RS 4n -The contract's cookie term. Use \fBct_status_get_cookie\fR(3CONTRACT) to obtain -this information. -.RE - -.sp -.ne 2 -.na -\fBInformative event set (term)\fR -.ad -.sp .6 -.RS 4n -The contract's informative event set. Use -\fBct_status_get_informative\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBCritical event set (term)\fR -.ad -.sp .6 -.RS 4n -The contract's critical event set. Use \fBct_status_get_critical\fR(3CONTRACT) -to obtain this information. -.RE - -.SS "EVENTS" -.LP -All three event endpoints, \fB/system/contract/\fItype\fR/bundle\fR, -\fB/system/contract/\fItype\fR/pbundle\fR, and -\fB/system/contract/\fItype\fR/\fIid\fR/events\fR, are accessed in the same -manner. -.sp -.LP -The following \fBlibcontract\fR(3LIB) interfaces are used with an event -endpoint file descriptor: -.sp -.in +2 -.nf -ct_event_read(3contract) -ct_event_read_critical(3contract) -ct_event_reset(3contract) -.fi -.in -2 -.sp - -.sp -.LP -To facilitate processes watching multiple event endpoints, it is possible to -poll(2) on event endpoints. When it is possible to receive on an endpoint file -descriptor, POLLIN is set for that descriptor. -.sp -.LP -An event object returned by \fBct_event_read\fR(3CONTRACT) contains the -following information: -.sp -.ne 2 -.na -\fBcontract ID\fR -.ad -.RS 28n -The ID of the contract that generated the event. Use -\fBct_event_read\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBevent ID\fR -.ad -.RS 28n -The ID of the contract event.Use \fBct_event_get_evid\fR(3CONTRACT). -.RE - -.sp -.ne 2 -.na -\fBflags\fR -.ad -.RS 28n -A bit vector possibly including \fBCT_ACK\fR and \fBCTE_INFO\fR. Use -\fBct_event_get_flags\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBevent type\fR -.ad -.RS 28n -The type of event, equal to one of the constants specified in the contract -type's manual page or \fBCT_EV_NEGEND\fR. Use -\fBct_event_get_type\fR(3CONTRACT) to obtain this information. -.RE - -.SS "EVENT TYPES" -.LP -The following event types are defined: -.sp -.ne 2 -.na -\fB\fBCT_EV_NEGEND\fR\fR -.ad -.RS 16n -Some time after an exit negotiation is initiated, the \fBCT_EV_NEGEND\fR event -is sent. This indicates that the negotiation ended. This might be because the -operation was cancelled, or because the operation was successful. If -successful, and the owner requested that a new contract be written, this -contains the ID of that contract. -.sp -\fBCT_EV_NEGEND\fR cannot be included in a contract's informative or critical -event set. It is always delivered and always critical. If \fBCT_EV_NEGEND\fR -indicates that the operation was successful, no further events are sent. The -contract's owner should use \fBct_ctl_abandon\fR(3CONTRACT) to abandon the -contract. -.sp -A \fBCT_EV_NEGEND\fR event contains: -.sp -.ne 2 -.na -\fBnegotiation ID\fR -.ad -.RS 19n -The ID of the negotiation which ended. Use \fBct_event_get_nevid\fR(3CONTRACT) -to obain this information. -.RE - -.sp -.ne 2 -.na -\fBnew contract ID\fR -.ad -.RS 19n -The ID of the newly created contract. This value is 0 if no contract was -created, or the ID of the existing contract if the operation was not completed. -Use \fBct_event_get_newct\fR(3CONTRACT) to obtain this information. -.RE - -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/system/contract\fR\fR -.ad -.sp .6 -.RS 4n -List of all contract types -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/all\fR\fR -.ad -.sp .6 -.RS 4n -Directory of all contract IDs -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/all/\fIid\fR\fR\fR -.ad -.sp .6 -.RS 4n -Symbolic link to the type-specific directory of contract \fIid\fR -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/\fItype\fR\fR\fR -.ad -.sp .6 -.RS 4n -Specific type directory -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/\fItype\fR/template\fR\fR -.ad -.sp .6 -.RS 4n -Template for the contract type -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/\fItype\fR/bundle\fR\fR -.ad -.sp .6 -.RS 4n -Listening point for all contracts of that type -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/\fItype\fR/pbundle\fR\fR -.ad -.sp .6 -.RS 4n -Listening point for all contracts of that type for the opening process -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/\fItype\fR /latest\fR\fR -.ad -.sp .6 -.RS 4n -Status of most recent \fItype\fR contract created by the opening LWP -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/\fItype\fR/\fIID\fR\fR\fR -.ad -.sp .6 -.RS 4n -Directory for contract id -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/\fItype\fR/\fIID\fR/events\fR\fR -.ad -.sp .6 -.RS 4n -Listening point for contract id's events -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/\fItype\fR/\fIID\fR/ctl\fR\fR -.ad -.sp .6 -.RS 4n -Control file for contract ID -.RE - -.sp -.ne 2 -.na -\fB\fB/system/contract/\fItype\fR/\fIID\fR/status\fR\fR -.ad -.sp .6 -.RS 4n -Status info for contract ID -.RE - -.SH SEE ALSO -.LP -\fBctrun\fR(1), \fBctstat\fR(1), \fBctwatch\fR(1), \fBchroot\fR(1M), -\fBclose\fR(2), \fBioctl\fR(2), \fBopen\fR(2), \fBpoll\fR(2), -\fBct_ctl_abandon\fR(3CONTRACT), \fBct_event_read\fR(3CONTRACT), -\fBct_event_get_evid\fR(3CONTRACT), \fBct_event_get_flags\fR(3CONTRACT), -\fBct_event_get_nevid\fR(3CONTRACT), \fBct_event_get_newct\fR(3CONTRACT), -\fBct_event_get_type\fR(3CONTRACT), -\fBct_status_read\fR(3CONTRACT), \fBct_status_get_cookie\fR(3CONTRACT), -\fBct_status_get_critical\fR(3CONTRACT), \fBct_status_get_holder\fR(3CONTRACT), -\fBct_status_get_id\fR(3CONTRACT), \fBct_status_get_informative\fR(3CONTRACT), -\fBct_status_get_nevid\fR(3CONTRACT), \fBct_status_get_nevents\fR(3CONTRACT), -\fBct_status_get_ntime\fR(3CONTRACT), \fBct_status_get_qtime\fR(3CONTRACT), -\fBct_status_get_state\fR(3CONTRACT), \fBct_status_get_type\fR(3CONTRACT), -\fBct_tmpl_set_cookie\fR(3CONTRACT), \fBct_tmpl_set_critical\fR(3CONTRACT), -\fBct_tmpl_set_informative\fR(3CONTRACT), \fBlibcontract\fR(3LIB), -\fBprocess\fR(4), \fBlargefile\fR(5), \fBlfcompile\fR(5), \fBprivileges\fR(5) diff --git a/usr/src/man/man4/copyright.4 b/usr/src/man/man4/copyright.4 deleted file mode 100644 index 55c3764dd1..0000000000 --- a/usr/src/man/man4/copyright.4 +++ /dev/null @@ -1,19 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved -.\" 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 COPYRIGHT 4 "Feb 7, 1997" -.SH NAME -copyright \- copyright information file -.SH DESCRIPTION -.sp -.LP -\fBcopyright\fR is an \fBASCII\fR file used to provide a copyright notice for a -package. The text may be in any format. The full file contents (including -comment lines) are displayed on the terminal at the time of package -installation. -.SH SEE ALSO -.sp -.LP -\fIApplication Packaging Developer\&'s Guide\fR diff --git a/usr/src/man/man4/core.4 b/usr/src/man/man4/core.4 deleted file mode 100644 index be63925f9f..0000000000 --- a/usr/src/man/man4/core.4 +++ /dev/null @@ -1,583 +0,0 @@ -'\" -.\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2012 DEY Storage Systems, Inc. All rights reserved. -.\" Copyright (c) 2013, Joyent, Inc. All rights reserved. -.\" Copyright 2020 OmniOS Community Edition (OmniOSce) Association. -.\" Copyright 2021 Oxide Computer Company -.\" Copyright 1989 AT&T -.\" -.\" 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] -.\" -.Dd August 3, 2021 -.Dt CORE 4 -.Os -.Sh NAME -.Nm core -.Nd process core file -.Sh DESCRIPTION -The operating system writes out a core file for a process when the process is -terminated due to receiving certain signals. -A core file is a disk copy of the contents of the process address space at the -time the process received the signal, along with additional information about -the state of the process. -This information can be consumed by a debugger. -Core files can also be generated by applying the -.Xr gcore 1 -utility to a running process. -.Pp -Typically, core files are produced following abnormal termination of a process -resulting from a bug in the corresponding application. -Whatever the cause, the core file itself provides invaluable information to the -programmer or support engineer to aid in diagnosing the problem. -The core file can be inspected using a debugger such as -.Xr mdb 1 , -gdb, dbx, or or by applying one of the -.Xr proc 1 -tools. -.Pp -The operating system attempts to create up to two core files for each -abnormally terminating process, using a global core file name pattern and a -per-process core file name pattern. -These patterns are expanded to determine the pathname of the resulting core -files, and can be configured by -.Xr coreadm 1M . -By default, the global core file pattern is disabled and not used, and the -per-process core file pattern is set to -.Sy core . -Therefore, by default, the operating system attempts to create a core file named -.Pa core -in the process's current working directory. -.Pp -A process terminates and produces a core file whenever it receives one of the -signals whose default disposition is to cause a core dump or the -.Xr upanic 2 -system call is used. -The list of signals that result in generating a core file is shown in -.Xr signal.h 3HEAD . -Therefore, a process might not produce a core file if it has blocked or -modified the behavior of the corresponding signal. -Additionally, no core dump can be created under the following conditions: -.Bl -bullet -.It -If normal file and directory access permissions prevent the creation or -modification of the per-process core file pathname by the current process user -and group ID. -This test does not apply to the global core file pathname because, regardless of -the UID of the process dumping core, the attempt to write the global core file -is made as the superuser. -.It -Core files owned by the user -.Sy nobody -will not be produced. -For example, core files generated for the superuser on an NFS directory are -owned by -.Sy nobody -and are, therefore, not written. -.It -If the core file pattern expands to a pathname that contains intermediate -directory components that do not exist. -For example, if the global pattern is set to -.Pa /var/core/%n/core.%p , -and no directory -.Pa /var/core/`uname -n` -has been created, no global core files are produced. -.It -If the destination directory is part of a filesystem that is mounted read-only. -.It -If the resource limit -.Dv RLIMIT_CORE -has been set to -.Sy 0 -for the -process, no per-process core file is produced. -Refer to -.Xr setrlimit 2 -and -.Xr ulimit 1 -for more information on resource limits. -.It -If the core file name already exists in the destination directory and is not a -regular file -.Pq that is, is a symlink, block or character special-file, and so forth . -.It -If the kernel cannot open the destination file -.Dv O_EXCL , -which can occur if same file is being created by another process simultaneously. -.It -If the process's effective user ID is different from its real user ID or if its -effective group ID is different from its real group ID. -Similarly, set-user-ID and set-group-ID programs do not produce core files as -this could potentially compromise system security. -These processes can be explicitly granted permission to produce core files using -.Xr coreadm 1M , -at the risk of exposing secure information. -.El -.Pp -The core file contains all the process information pertinent to debugging: -contents of hardware registers, process status, and process data. -The format of a core file is object file specific. -.Pp -For ELF executable programs -.Po -see -.Xr a.out 4 -.Pc , -the core file generated is also an ELF file, containing ELF program and file -headers. -The -.Fa e_type -field in the file header has type -.Dv ET_CORE . -The program header contains an entry for every segment that was part of the -process address space, including shared library segments. -The contents of the mappings specified by -.Xr coreadm 1M -are also part of the core image. -Each program header has its -.Fa p_memsz -field set to the size of the mapping. -The program headers that represent mappings whose data is included in the core -file have their -.Fa p_filesz -field set the same as -.Fa p_memsz , -otherwise -.Fa p_filesz -is -.Sy zero . -.Pp -A mapping's data can be excluded due to the core file content settings -.Po -see -.Xr coreadm 1M -.Pc , -due to a failure, or due to a signal received after core dump initiation but -before its completion. -If the data is excluded because of a failure, the program header entry will -have the -.Dv PF_SUNW_FAILURE -flag set in its -.Fa p_flags -field; if the data is excluded because of a signal, the segment's -.Fa p_flags -field will have the -.Dv PF_SUNW_KILLED -flag set. -.Pp -The program headers of an -.Sy ELF -core file also contain entries for two -.Sy NOTE -segments, each containing several note entries as described below. -The note entry header and core file note type -.Pq Fa n_type -definitions are contained in -.In sys/elf.h . -The first -.Sy NOTE -segment exists for binary compatibility with old programs that deal with core -files. -It contains structures defined in -.In sys/old_procfs.h . -New programs should recognize and skip this -.Sy BNOTE -segment, advancing instead to the new -.Sy NOTE -segment. -The old -.Sy NOTE -segment is deleted from core files in a future release. -.Pp -The old -.Sy NOTE -segment contains the following entries. -Each has entry name -.Sy "CORE" -and presents the contents of a system structure: -.Bl -tag -width prpsinfo_t -.It Vt prpsinfo_t -.Fa n_type : -.Dv NT_PRPSINFO . -This entry contains information of interest to the -.Xr ps 1 -command, such as process status, CPU usage, nice value, controlling terminal, -user-ID, process-ID, the name of the executable, and so forth. -The -.Vt prpsinfo_t -structure is defined in -.In sys/old_procfs.h . -.It Vt char[] -.Fa n_type : -.Dv NT_PLATFORM . -This entry contains a string describing the specific model of the hardware -platform on which this core file was created. -This information is the same as provided by -.Xr sysinfo 2 -when invoked with the command -.Dv SI_PLATFORM . -.It Vt auxv_t[] -.Fa n_type : -.Dv NT_AUXV . -This entry contains the array of -.Vt Bauxv_t -structures that was passed by the operating system as startup information to -the dynamic linker. -Auxiliary vector information is defined in -.In sys/auxv.h . -.El -.Pp -Following these entries, for each active (non-zombie) light-weight process -.Pq LWP -in the process, the old -.Sy NOTE -segment contains an entry with a -.Vt prstatus_t -structure, plus other optionally-present entries describing the LWP, as follows: -.Bl -tag -width "prfpregset_t" -.It Vt prstatus_t -.Fa n_type : -.Dv NT_PRSTATUS . -This structure contains things of interest to a debugger from the operating -system, such as the general registers, signal dispositions, state, reason for -stopping, process-ID, and so forth. -The -.Vt prstatus_t -structure is defined in -.In sys/old_procfs.h . -.It Vt prfpregset_t -.Fa n_type : -.Dv NT_PRFPREG . -This entry is present only if the -.Sy BLWP -used the floating-point hardware. -It contains the floating-point registers. -The -.Vt prfpregset_t -structure is defined in -.In sys/procfs_isa.h . -.It Vt gwindows_t -.Fa n_type : -.Dv NT_GWINDOWS . -This entry is present only on a SPARC machine and only if the system was unable -to flush all of the register windows to the stack. -It contains all of the unspilled register windows. -The -.Vt gwindows_t -structure is defined in -.In sys/regset.h . -.It Vt prxregset_t -.Fa n_type : -.Dv NT_PRXREG . -This entry is present only if the machine has extra register state associated -with it. -It contains the extra register state. -The -.Vt prxregset_t -structure is defined in -.Vt sys/procfs_isa.h . -.El -.Pp -The new -.Sy NOTE -segment contains the following entries. -Each has entry name -.Sy "CORE" -and presents the contents of a system structure: -.Bl -tag -width prxregset_t -.It Vt psinfo_t -.Fa n_type : -.Dv NT_PSINFO . -This structure contains information of interest to the -.Xr ps 1 -command, such as process status, CPU usage, nice value, controlling terminal, -user-ID, process-ID, the name of the executable, and so forth. -The -.Vt psinfo_t -structure is defined in -.In sys/procfs.h -.It Vt pstatus_t -.Fa n_type : -.Dv NT_PSTATUS . -This structure contains things of interest to a debugger from the operating -system, such as pending signals, state, process-ID, and so forth. -The -.Vt pstatus_t -structure is defined in -.In sys/procfs.h . -.It Vt char[] -.Fa n_type : -.Dv NT_PLATFORM . -This entry contains a string describing the specific model of the hardware -platform on which this core file was created. -This information is the same as provided by -.Xr sysinfo 2 -when invoked with the command -.Dv SI_PLATFORM . -.It auxv_t[] -.Fa n_type : -.Dv NT_AUXV . -This entry contains the array of -.Vt auxv_t -structures that was passed by the operating system as startup information to -the dynamic linker. -Auxiliary vector information is defined in -.In sys/auxv.h . -.It Vt struct utsname -.Fa n_type : -.Dv NT_UTSNAME . -This structure contains the system information that would have been returned -to the process if it had performed a -.Xr uname 2 -system call prior to dumping core. -The -.Vt utsname -structure is defined in -.In sys/utsname.h . -.It pcred_t -.Fa n_type : -.Dv NT_PRCRED . -This structure contains the process credentials, including the real, saved, -and effective user and group IDs. -The -.Vt pcred_t -structure is defined in -.In sys/procfs.h . -Following the structure is an optional array of supplementary group IDs. -The total number of supplementary group IDs is given by the -.Fa pr_ngroups -member of the -.Vt pcred_t -structure, and the structure includes space for one supplementary group. -If -.Fa pr_ngroups -is greater than 1, there is -.So -.Fa pr_ngroups -- 1 -.Sc -.Fa gid_t -items following the structure; otherwise, there is no additional data. -.It Vt char[] -.Fa n_type : -.Dv NT_ZONENAME . -This entry contains a string which describes the name of the zone in -which the process was running. -See -.Xr zones 5 . -The information is the same as provided by -.Xr getzonenamebyid 3C -when invoked with the numerical ID returned by -.Xr getzoneid 3C . -.It Vt prfdinfo_core_t -.Fa n_type : -.Dv NT_FDINFO . -This structure contains information about any open file descriptors, including -the path, flags, and -.Xr stat 2 -information. -The -.Vt prfdinfo_core_t -structure is defined in -.In sys/procfs.h . -.It Vt struct ssd[] -.Fa n_type : -.Dv NT_LDT . -This entry is present only on an 32-bit x86 machine and only if the process has -set up a Local Descriptor Table -.Pq LDT . -It contains an array of structures of type -.Vt struct ssd , -each of which was typically used to set up the -.Sy %gs -segment register to be used to fetch the address of the current thread -information structure in a multithreaded process. -The -.Vt ssd -structure is defined in -.In sys/sysi86.h . -.It Vt core_content_t -.Fa n_type : -.Dv NT_CONTENT . -This optional entry indicates which parts of the process image are specified -to be included in the core file. -See -.Xr coreadm 1M . -.It Vt prsecflags_t -.Fa n_type : -.Dv NT_SECFLAGS . -This entry contains the process security-flags, see -.Xr security-flags 5 , -.Xr proc 4 , -and -.Xr psecflags 1 -for more information. -.It Vt prupanic_t -.Fa n_type : -.Dv NT_UPANIC . -This entry is included if a process terminated through the -.Xr upanic 2 -system call. -It is defined in -.In sys/procfs.h . -.Pp -The -.Fa pru_version -member indicates the current revision of the structure, which is expected to be -.Dv PRUPANIC_VERSION_1 -.Pq 1 . -The -.Fa pru_flags -member will be set to the bitwise-inclusive-OR of the following fields: -.Bl -tag -offset indent -width PRUPANIC_FLAG_MSG_TRUNC -.It Dv PRUPANIC_FLAG_MSG_VALID -Indicates that -.Fa pru_data -member has valid contents and that the process provided a message in the -.Xr upanic 2 -call . -.It Dv PRUPANIC_FLAG_MSG_ERROR -Indicates that the calling process attempted to include a message; however, the -provided address of the message did not point to valid memory. -.It Dv PRUPANIC_FLAG_MSG_TRUNC -Indicates that the calling process included a message; however, the message it -wanted to provide was larger than the current message length. -.El -The -.Fa pru_data -array contains binary data that the terminating process used to indicate that -the reason why it panicked. -This member should be ignored if the -.Dv PRUPANIC_FLAG_MSG_VALID -flag is not set in -.Fa pru_flags . -While it is recommended that processes terminate with an ASCII string, consumers -of this should not assume that the binary data is made of of printable -characters. -.El -.Pp -For each active and zombie -.Sy LWP -in the process, -the new -.Sy NOTE -segment contains an entry with an -.Vt lwpsinfo_t -structure plus, for a non-zombie LWP, an entry with an -.Vt lwpstatus_t -structure, plus other optionally-present entries describing the LWP, as follows. -A zombie LWP is a non-detached LWP that has terminated but has not yet been -reaped by another LWP in the same process. -.Bl -tag -width "prxregset_t" -.It Vt lwpsinfo_t -.Fa n_type : -.Dv NT_LWPSINFO . -This structure contains information of interest to the -.Xr ps 1 -command, such as LWP status, CPU usage, nice value, LWP-ID, and so forth. -The -.Vt lwpsinfo_t -structure is defined in -.In sys/procfs.h . -This is the only entry present for a zombie LWP. -.It lwpstatus_t -.Fa n_type : -.Dv NT_LWPSTATUS . -This structure contains things of interest to a debugger from the operating -system, such as the general registers, the floating point registers, state, -reason for stopping, LWP-ID, and so forth. -The -.Vt lwpstatus_t -structure is defined in -.In sys/procfs.h . -.Vt gwindows_t -.Fa n_type : -.Dv NT_GWINDOWS . -This entry is present only on a SPARC machine and only if the system was unable -to flush all of the register windows to the stack. -It contains all of the unspilled register windows. -The -.Vt gwindows_t -structure is defined in -.In sys/regset.h . -.It Vt prxregset_t -.Fa n_type : -.Dv NT_PRXREG . -This entry is present only if the machine has extra register state associated -with it. -It contains the extra register state. -The -.Vt prxregset_t -structure is defined in -.In sys/procfs_isa.h . -.It Vt asrset_t -\fB\fBasrset_t\fR\fR -.Fa n_type : -.Dv NT_ASRS . -This entry is present only on a SPARC V9 machine and only if the process is a -64-bit process. -It contains the ancillary state registers for the LWP. -The -.Vt asrset_t asrset_t -structure is defined in -.In sys/regset.h . -.It Vt psinfo_t -.Fa n_type : -.Dv NT_SPYMASTER . -This entry is present only for an agent LWP and contains the -.Vt psinfo_t -of the process that created the agent LWP. -See the -.Xr proc 4 description of the -.Sy spymaster -entry for more details. -.El -.Pp -Depending on the -.Xr coreadm 1M -settings, the section header of an ELF core file can contain entries for CTF, -DWARF debug information, symbol table, and string table sections. -The -.Fa sh_addr -fields are set to the base address of the first mapping of the load object that -they came from to. -This can be used to match those sections with the corresponding load object. -.Pp -The size of the core file created by a process can be controlled by the user -.Po -see -.Xr getrlimit 2 -.Pc -.Sh SEE ALSO -.Xr elfdump 1 , -.Xr gcore 1 , -.Xr mdb 1 , -.Xr proc 1 , -.Xr ps 1 , -.Xr coreadm 1M , -.Xr getrlimit 2 , -.Xr setrlimit 2 , -.Xr setuid 2 , -.Xr sysinfo 2 , -.Xr uname 2 , -.Xr upanic 2 , -.Xr getzoneid 3C , -.Xr getzonenamebyid 3C , -.Xr elf 3ELF , -.Xr signal.h 3HEAD , -.Xr a.out 4 , -.Xr proc 4 , -.Xr security-flags 5 , -.Xr zones 5 diff --git a/usr/src/man/man4/cpr.4 b/usr/src/man/man4/cpr.4 new file mode 100644 index 0000000000..574b21f233 --- /dev/null +++ b/usr/src/man/man4/cpr.4 @@ -0,0 +1,114 @@ +.\" Copyright (c) 2001, Sun Microsystems, Inc. +.\" All Rights Reserved +.\" +.\" Copyright 2020 Joyent, Inc. +.\" +.\" 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] +.\" +.Dd January 12, 2020 +.Dt CPR 4 +.Os +.Sh NAME +.Nm cpr +.Nd Suspend and resume module +.Sh SYNOPSIS +.Pa /platform/i86pc/kernel/misc/amd64/cpr +.Pa /platform/sun4u/kernel/misc/sparcv9/cpr +.Sh DESCRIPTION +The +.Nm +module is a loadable module used to suspend and resume the entire system. +You may wish to suspend a system to save power or to power off +temporarily for transport. +The +.Nm +module should not be used in place of +a normal shutdown when performing any hardware reconfiguration or replacement. +In order for the resume operation to succeed, it is important that the hardware +configuration remain the same. +When the system is suspended, the entire system +state is preserved in non-volatile storage until a resume operation is +conducted. +.Pp +.Xr pmconfig 8 +and +.Xr power.conf 5 +are used to configure the suspend-resume feature. +.Pp +The speed of suspend and resume operations can range from 15 seconds to +several minutes, depending on the system speed, memory size, and load. +.Pp +During resume operation, the +.Dv SIGTHAW +signal is sent to all processes to +allow them to do any special processing in response to suspend-resume +operation. +Normally applications are not required to do any special processing +because of suspend-resume, but some specialized processes can use +.Dv SIGTHAW +to restore the state prior to suspend. +For example, +.Sy X +can refresh the screen in response to +.Dv SIGTHAW . +.Pp +In some cases the +.Nm +module may be unable to perform the suspend operation. +If a system contains additional devices outside the standard shipped +configuration, it is possible that device drivers for these additional devices +might not support suspend-resume operations. +In this case, the suspend fails and an error message is displayed. +These devices must be removed or their +device drivers unloaded for the suspend operation to succeed. +Contact the +device manufacturer to obtain a new version of device driver that supports +suspend-resume. +.Pp +A suspend may also fail when devices or processes are performing critical or +time-sensitive operations (such as realtime operations). +The system will remain in its current running state. +Messages reporting the failure will be displayed +on the console and status returned to the caller. +Once the system is +successfully suspended the resume operation will succeed, barring external +influences such as a hardware reconfiguration. +.Pp +Some network-based applications may fail across a suspend and resume cycle. +This largely depends on the underlying network protocol and the applications +involved. +In general, applications that retry and automatically reestablish +connections will continue to operate transparently on a resume operation; +those applications that do not will likely fail. +.Sh INTERFACE STABILITY +Unstable +.Sh SEE ALSO +.Xr uadmin 2 , +.Xr power.conf 5 , +.Xr attributes 7 , +.Xr pmconfig 8 , +.Xr uadmin 8 +.Pp +.%T Writing Device Drivers +.Sh NOTES +Certain device operations such as tape and floppy disk activities are not +resumable due to the nature of removable media. +These activities are detected +at suspend time, and must be stopped before the suspend operation will +complete successfully. +.Pp +Suspend-resume is currently supported only on a limited set of hardware +platforms. diff --git a/usr/src/man/man4/crypt.conf.4 b/usr/src/man/man4/crypt.conf.4 deleted file mode 100644 index f86fdf8d2c..0000000000 --- a/usr/src/man/man4/crypt.conf.4 +++ /dev/null @@ -1,101 +0,0 @@ -'\" te -.\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 CRYPT.CONF 4 "December 28, 2020" -.SH NAME -crypt.conf \- configuration file for pluggable crypt modules -.SH SYNOPSIS -.nf -/etc/security/crypt.conf -.fi - -.SH DESCRIPTION -\fBcrypt.conf\fR is the configuration file for the pluggable crypt -architecture. Each crypt module must provide a function to generate a password -hash, \fBcrypt_genhash_impl\fR(3C), and a function to generate the salt, -\fBcrypt_gensalt_impl\fR(3C). -.sp -.LP -There must be at least one entry in \fBcrypt.conf\fR with the same name as is -stored in the \fBcrypt_algorithm_magic\fR symbol of the module. The -documentation provided with the module should list this name. -.sp -.LP -The \fBmodule_path\fR field specifies the path name to a shared library object -that implements \fBcrypt_genhash_impl()\fR, \fBcrypt_gensalt_impl()\fR, and -\fBcrypt_algorithm_magic\fR. If the path name is not absolute, it is assumed -to be relative to \fB/usr/lib/security/$ISA\fR. If the path name contains the -\fB$ISA\fR token, the token is replaced by an implementation-defined directory -name that defines the path relative to the calling program's instruction set -architecture. -.sp -.LP -The \fBparams\fR field is used to pass module-specific options to the shared -objects. See \fBcrypt_genhash_impl\fR(3C) and \fBcrypt_gensalt_impl\fR(3C). It -is the responsibility of the module to parse and interpret the options. The -\fBparams\fR field can be used by the modules to turn on debugging or to pass -any module-specific parameters that control the output of the hashing -algorithm. -.SH EXAMPLES -\fBExample 1 \fRProvide compatibility for md5crypt-generated passwords. -.sp -.LP -The default configuration preserves previous Solaris behavior while adding -compatibility for md5crypt-generated passwords as provided on some BSD and -Linux systems. - -.sp -.in +2 -.nf -# -# crypt.conf -# -1 /usr/lib/security/$ISA/crypt_bsdmd5.so -.fi -.in -2 - -.LP -\fBExample 2 \fRUse md5crypt to demonstrate compatibility with BSD- and -Linux-based systems. -.sp -.LP -The following example lists 4 algorithms and demonstrates how compatibility -with BSD- and Linux-based systems using md5crypt is made available, using the -algorithm names 1 and 2. - -.sp -.in +2 -.nf -# -# crypt.conf -# -md5 /usr/lib/security/$ISA/crypt_md5.so -rot13 /usr/lib/security/$ISA/crypt_rot13.so - -# For *BSD/Linux compatibility -# 1 is md5, 2 is Blowfish -1 /usr/lib/security/$ISA/crypt_bsdmd5.so -2 /usr/lib/security/$ISA/crypt_bsdbf.so -.fi -.in -2 - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -\fBpasswd\fR(1), \fBcrypt\fR(3C), \fBcrypt_genhash_impl\fR(3C), -\fBcrypt_gensalt\fR(3C), \fBcrypt_gensalt_impl\fR(3C), \fBgetpassphrase\fR(3C), -\fBpasswd\fR(4), \fBattributes\fR(5), \fBcrypt_unix\fR(5) diff --git a/usr/src/man/man4/crypto_certs.4 b/usr/src/man/man4/crypto_certs.4 deleted file mode 100644 index d700f62798..0000000000 --- a/usr/src/man/man4/crypto_certs.4 +++ /dev/null @@ -1,69 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 CRYPTO_CERTS 4 "Feb 23, 2007" -.SH NAME -crypto_certs \- directory for certificate files for Solaris Cryptographic -Framework -.SH SYNOPSIS -.LP -.nf -\fB/etc/crypto/certs/CA\fR -.fi - -.LP -.nf -\fB/etc/crypto/certs/SUNWobjectCA\fR -.fi - -.LP -.nf -\fB/etc/crypto/certs/*\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/etc/crypto/certs\fR directory contains ASN.1 BER or PEM encoded -certificate files for use by the Solaris Cryptographic Framework. -.sp -.LP -A default installation contains root anchors and signing certificates. The -\fBCA\fR and \fBSUNWobjectCA\fR certificates are the trust anchors for all -other certificates. Other certificates contain the certificates used to sign -and verify the Solaris user and kernel cryptographic plug-ins -.sp -.LP -Additional signing certificates may be installed by third-party cryptographic -providers. They should either be copied to \fB/etc/crypto/certs\fR or included -in the package that delivers the provider. -.sp -.LP -Only certificates that are issued by the \fBCA\fR or \fBSUNWobjectCA\fR -certificates and include the organization unit "Solaris Cryptographic -Framework" in their subject distinguished names are accepted by the Solaris -Cryptographic Framework. This restriction is in place due to US Export Law on -the export of open cryptographic interfaces at the time of shipping this -revision of the product. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBelfsign\fR(1), \fBlibpkcs11\fR(3LIB), \fBattributes\fR(5) diff --git a/usr/src/man/man4/ctf.4 b/usr/src/man/man4/ctf.4 deleted file mode 100644 index 7e00f8d99a..0000000000 --- a/usr/src/man/man4/ctf.4 +++ /dev/null @@ -1,1215 +0,0 @@ -.\" -.\" 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 (c) 2014 Joyent, Inc. -.\" -.Dd Sep 26, 2014 -.Dt CTF 4 -.Os -.Sh NAME -.Nm ctf -.Nd Compact C Type Format -.Sh SYNOPSIS -.In sys/ctf.h -.Sh DESCRIPTION -.Nm -is designed to be a compact representation of the C programming -language's type information focused on serving the needs of dynamic -tracing, debuggers, and other in-situ and post-mortem introspection -tools. -.Nm -data is generally included in -.Sy ELF -objects and is tagged as -.Sy SHT_PROGBITS -to ensure that the data is accessible in a running process and in subsequent -core dumps, if generated. -.Lp -The -.Nm -data contained in each file has information about the layout and -sizes of C types, including intrinsic types, enumerations, structures, -typedefs, and unions, that are used by the corresponding -.Sy ELF -object. -The -.Nm -data may also include information about the types of global objects and -the return type and arguments of functions in the symbol table. -.Lp -Because a -.Nm -file is often embedded inside a file, rather than being a standalone -file itself, it may also be referred to as a -.Nm -.Sy container . -.Lp -On illumos systems, -.Nm -data is consumed by multiple programs. -It can be used by the modular debugger, -.Xr mdb 1 , -as well as by -.Xr dtrace 1M . -Programmatic access to -.Nm -data can be obtained through -.Xr libctf 3LIB . -.Lp -The -.Nm -file format is broken down into seven different sections. -The first section is the -.Sy preamble -and -.Sy header , -which describes the version of the -.Nm -file, links it has to other -.Nm -files, and the sizes of the other sections. -The next section is the -.Sy label -section, -which provides a way of identifying similar groups of -.Nm -data across multiple files. -This is followed by the -.Sy object -information section, which describes the type of global -symbols. -The subsequent section is the -.Sy function -information section, which describes the return -types and arguments of functions. -The next section is the -.Sy type -information section, which describes -the format and layout of the C types themselves, and finally the last -section is the -.Sy string -section, which contains the names of types, enumerations, members, and -labels. -.Lp -While strictly speaking, only the -.Sy preamble -and -.Sy header -are required, to be actually useful, both the type and string -sections are necessary. -.Lp -A -.Nm -file may contain all of the type information that it requires, or it -may optionally refer to another -.Nm -file which holds the remaining types. -When a -.Nm -file refers to another file, it is called the -.Sy child -and the file it refers to is called the -.Sy parent . -A given file may only refer to one parent. -This process is called -.Em uniquification -because it ensures each child only has type information that is -unique to it. -A common example of this is that most kernel modules in illumos are uniquified -against the kernel module -.Sy genunix -and the type information that comes from the -.Sy IP -module. -This means that a module only has types that are unique to itself and the most -common types in the kernel are not duplicated. -.Sh FILE FORMAT -This documents version -.Em two -of the -.Nm -file format. -All applications and tools currently produce and operate on this version. -.Lp -The file format can be summarized with the following image, the -following sections will cover this in more detail. -.Bd -literal - - +-------------+ 0t0 -+--------| Preamble | -| +-------------+ 0t4 -|+-------| Header | -|| +-------------+ 0t36 + cth_lbloff -||+------| Labels | -||| +-------------+ 0t36 + cth_objtoff -|||+-----| Objects | -|||| +-------------+ 0t36 + cth_funcoff -||||+----| Functions | -||||| +-------------+ 0t36 + cth_typeoff -|||||+---| Types | -|||||| +-------------+ 0t36 + cth_stroff -||||||+--| Strings | -||||||| +-------------+ 0t36 + cth_stroff + cth_strlen -||||||| -||||||| -||||||| -||||||| +-- magic - vers flags -||||||| | | | | -||||||| +------+------+------+------+ -+---------| 0xcf | 0xf1 | 0x02 | 0x00 | - |||||| +------+------+------+------+ - |||||| 0 1 2 3 4 - |||||| - |||||| + parent label + objects - |||||| | + parent name | + functions + strings - |||||| | | + label | | + types | + strlen - |||||| | | | | | | | | - |||||| +------+------+------+------+------+-------+-------+-------+ - +--------| 0x00 | 0x00 | 0x00 | 0x08 | 0x36 | 0x110 | 0x5f4 | 0x611 | - ||||| +------+------+------+------+------+-------+-------+-------+ - ||||| 0x04 0x08 0x0c 0x10 0x14 0x18 0x1c 0x20 0x24 - ||||| - ||||| + Label name - ||||| | + Label type - ||||| | | + Next label - ||||| | | | - ||||| +-------+------+-----+ - +-----------| 0x01 | 0x42 | ... | - |||| +-------+------+-----+ - |||| cth_lbloff +0x4 +0x8 cth_objtoff - |||| - |||| - |||| Symidx 0t15 0t43 0t44 - |||| +------+------+------+-----+ - +----------| 0x00 | 0x42 | 0x36 | ... | - ||| +------+------+------+-----+ - ||| cth_objtoff +0x2 +0x4 +0x6 cth_funcoff - ||| - ||| + CTF_TYPE_INFO + CTF_TYPE_INFO - ||| | + Return type | - ||| | | + arg0 | - ||| +--------+------+------+-----+ - +---------| 0x2c10 | 0x08 | 0x0c | ... | - || +--------+------+------+-----+ - || cth_funcff +0x2 +0x4 +0x6 cth_typeoff - || - || + ctf_stype_t for type 1 - || | integer + integer encoding - || | | + ctf_stype_t for type 2 - || | | | - || +--------------------+-----------+-----+ - +--------| 0x19 * 0xc01 * 0x0 | 0x1000000 | ... | - | +--------------------+-----------+-----+ - | cth_typeoff +0x08 +0x0c cth_stroff - | - | +--- str 0 - | | +--- str 1 + str 2 - | | | | - | v v v - | +----+---+---+---+----+---+---+---+---+---+----+ - +---| \\0 | i | n | t | \\0 | f | o | o | _ | t | \\0 | - +----+---+---+---+----+---+---+---+---+---+----+ - 0 1 2 3 4 5 6 7 8 9 10 11 -.Ed -.Lp -Every -.Nm -file begins with a -.Sy preamble , -followed by a -.Sy header . -The -.Sy preamble -is defined as follows: -.Bd -literal -typedef struct ctf_preamble { - ushort_t ctp_magic; /* magic number (CTF_MAGIC) */ - uchar_t ctp_version; /* data format version number (CTF_VERSION) */ - uchar_t ctp_flags; /* flags (see below) */ -} ctf_preamble_t; -.Ed -.Pp -The -.Sy preamble -is four bytes long and must be four byte aligned. -This -.Sy preamble -defines the version of the -.Nm -file which defines the format of the rest of the header. -While the header may change in subsequent versions, the preamble will not change -across versions, though the interpretation of its flags may change from -version to version. -The -.Em ctp_magic -member defines the magic number for the -.Nm -file format. -This must always be -.Li 0xcff1 . -If another value is encountered, then the file should not be treated as -a -.Nm -file. -The -.Em ctp_version -member defines the version of the -.Nm -file. -The current version is -.Li 2 . -It is possible to encounter an unsupported version. -In that case, software should not try to parse the format, as it may have -changed. -Finally, the -.Em ctp_flags -member describes aspects of the file which modify its interpretation. -The following flags are currently defined: -.Bd -literal -#define CTF_F_COMPRESS 0x01 -.Ed -.Pp -The flag -.Sy CTF_F_COMPRESS -indicates that the body of the -.Nm -file, all the data following the -.Sy header , -has been compressed through the -.Sy zlib -library and its -.Sy deflate -algorithm. -If this flag is not present, then the body has not been compressed and no -special action is needed to interpret it. -All offsets into the data as described by -.Sy header , -always refer to the -.Sy uncompressed -data. -.Lp -In version two of the -.Nm -file format, the -.Sy header -denotes whether whether or not this -.Nm -file is the child of another -.Nm -file and also indicates the size of the remaining sections. -The structure for the -.Sy header , -logically contains a copy of the -.Sy preamble -and the two have a combined size of 36 bytes. -.Bd -literal -typedef struct ctf_header { - ctf_preamble_t cth_preamble; - uint_t cth_parlabel; /* ref to name of parent lbl uniq'd against */ - uint_t cth_parname; /* ref to basename of parent */ - uint_t cth_lbloff; /* offset of label section */ - uint_t cth_objtoff; /* offset of object section */ - uint_t cth_funcoff; /* offset of function section */ - uint_t cth_typeoff; /* offset of type section */ - uint_t cth_stroff; /* offset of string section */ - uint_t cth_strlen; /* length of string section in bytes */ -} ctf_header_t; -.Ed -.Pp -After the -.Sy preamble , -the next two members -.Em cth_parlablel -and -.Em cth_parname , -are used to identify the parent. -The value of both members are offsets into the -.Sy string -section which point to the start of a null-terminated string. -For more information on the encoding of strings, see the subsection on -.Sx String Identifiers . -If the value of either is zero, then there is no entry for that -member. -If the member -.Em cth_parlabel -is set, then the -.Em ctf_parname -member must be set, otherwise it will not be possible to find the -parent. -If -.Em ctf_parname -is set, it is not necessary to define -.Em cth_parlabel , -as the parent may not have a label. -For more information on labels and their interpretation, see -.Sx The Label Section . -.Lp -The remaining members (excepting -.Em cth_strlen ) -describe the beginning of the corresponding sections. -These offsets are relative to the end of the -.Sy header . -Therefore, something with an offset of 0 is at an offset of thirty-six -bytes relative to the start of the -.Nm -file. -The difference between members indicates the size of the section itself. -Different offsets have different alignment requirements. -The start of the -.Em cth_objotoff -and -.Em cth_funcoff -must be two byte aligned, while the sections -.Em cth_lbloff -and -.Em cth_typeoff -must be four-byte aligned. -The section -.Em cth_stroff -has no alignment requirements. -To calculate the size of a given section, excepting the -.Sy string -section, one should subtract the offset of the section from the following one. -For example, the size of the -.Sy types -section can be calculated by subtracting -.Em cth_stroff -from -.Em cth_typeoff . -.Lp -Finally, the member -.Em cth_strlen -describes the length of the string section itself. -From it, you can also calculate the size of the entire -.Nm -file by adding together the size of the -.Sy ctf_header_t , -the offset of the string section in -.Em cth_stroff , -and the size of the string section in -.Em cth_srlen . -.Ss Type Identifiers -Through the -.Nm ctf -data, types are referred to by identifiers. -A given -.Nm -file supports up to 32767 (0x7fff) types. -The first valid type identifier is 0x1. -When a given -.Nm -file is a child, indicated by a non-zero entry for the -.Sy header Ns 's -.Em cth_parname , -then the first valid type identifier is 0x8000 and the last is 0xffff. -In this case, type identifiers 0x1 through 0x7fff are references to the -parent. -.Lp -The type identifier zero is a sentinel value used to indicate that there -is no type information available or it is an unknown type. -.Lp -Throughout the file format, the identifier is stored in different sized -values; however, the minimum size to represent a given identifier is a -.Sy uint16_t . -Other consumers of -.Nm -information may use larger or opaque identifiers. -.Ss String Identifiers -String identifiers are always encoded as four byte unsigned integers -which are an offset into a string table. -The -.Nm -format supports two different string tables which have an identifier of -zero or one. -This identifier is stored in the high-order bit of the unsigned four byte -offset. -Therefore, the maximum supported offset into one of these tables is 0x7ffffffff. -.Lp -Table identifier zero, always refers to the -.Sy string -section in the CTF file itself. -String table identifier one refers to an external string table which is the ELF -string table for the ELF symbol table associated with the -.Nm -container. -.Ss Type Encoding -Every -.Nm -type begins with metadata encoded into a -.Sy uint16_t . -This encoded information tells us three different pieces of information: -.Bl -bullet -offset indent -compact -.It -The kind of the type -.It -Whether this type is a root type or not -.It -The length of the variable data -.El -.Lp -The 16 bits that make up the encoding are broken down such that you have -five bits for the kind, one bit for indicating whether or not it is a -root type, and 10 bits for the variable length. -This is laid out as follows: -.Bd -literal -offset indent -+--------------------+ -| kind | root | vlen | -+--------------------+ -15 11 10 9 0 -.Ed -.Lp -The current version of the file format defines 14 different kinds. -The interpretation of these different kinds will be discussed in the section -.Sx The Type Section . -If a kind is encountered that is not listed below, then it is not a valid -.Nm -file. -The kinds are defined as follows: -.Bd -literal -offset indent -#define CTF_K_UNKNOWN 0 -#define CTF_K_INTEGER 1 -#define CTF_K_FLOAT 2 -#define CTF_K_POINTER 3 -#define CTF_K_ARRAY 4 -#define CTF_K_FUNCTION 5 -#define CTF_K_STRUCT 6 -#define CTF_K_UNION 7 -#define CTF_K_ENUM 8 -#define CTF_K_FORWARD 9 -#define CTF_K_TYPEDEF 10 -#define CTF_K_VOLATILE 11 -#define CTF_K_CONST 12 -#define CTF_K_RESTRICT 13 -.Ed -.Lp -Programs directly reference many types; however, other types are referenced -indirectly because they are part of some other structure. -These types that are referenced directly and used are called -.Sy root -types. -Other types may be used indirectly, for example, a program may reference -a structure directly, but not one of its members which has a type. -That type is not considered a -.Sy root -type. -If a type is a -.Sy root -type, then it will have bit 10 set. -.Lp -The variable length section is specific to each kind and is discussed in the -section -.Sx The Type Section . -.Lp -The following macros are useful for constructing and deconstructing the encoded -type information: -.Bd -literal -offset indent - -#define CTF_MAX_VLEN 0x3ff -#define CTF_INFO_KIND(info) (((info) & 0xf800) >> 11) -#define CTF_INFO_ISROOT(info) (((info) & 0x0400) >> 10) -#define CTF_INFO_VLEN(info) (((info) & CTF_MAX_VLEN)) - -#define CTF_TYPE_INFO(kind, isroot, vlen) \\ - (((kind) << 11) | (((isroot) ? 1 : 0) << 10) | ((vlen) & CTF_MAX_VLEN)) -.Ed -.Ss The Label Section -When consuming -.Nm -data, it is often useful to know whether two different -.Nm -containers come from the same source base and version. -For example, when building illumos, there are many kernel modules that are built -against a single collection of source code. -A label is encoded into the -.Nm -files that corresponds with the particular build. -This ensures that if files on the system were to become mixed up from multiple -releases, that they are not used together by tools, particularly when a child -needs to refer to a type in the parent. -Because they are linked used the type identifiers, if the wrong parent is used -then the wrong type will be encountered. -.Lp -Each label is encoded in the file format using the following eight byte -structure: -.Bd -literal -typedef struct ctf_lblent { - uint_t ctl_label; /* ref to name of label */ - uint_t ctl_typeidx; /* last type associated with this label */ -} ctf_lblent_t; -.Ed -.Lp -Each label has two different components, a name and a type identifier. -The name is encoded in the -.Em ctl_label -member which is in the format defined in the section -.Sx String Identifiers . -Generally, the names of all labels are found in the internal string -section. -.Lp -The type identifier encoded in the member -.Em ctl_typeidx -refers to the last type identifier that a label refers to in the current -file. -Labels only refer to types in the current file, if the -.Nm -file is a child, then it will have the same label as its parent; -however, its label will only refer to its types, not its parents. -.Lp -It is also possible, though rather uncommon, for a -.Nm -file to have multiple labels. -Labels are placed one after another, every eight bytes. -When multiple labels are present, types may only belong to a single label. -.Ss The Object Section -The object section provides a mapping from ELF symbols of type -.Sy STT_OBJECT -in the symbol table to a type identifier. -Every entry in this section is a -.Sy uint16_t -which contains a type identifier as described in the section -.Sx Type Identifiers . -If there is no information for an object, then the type identifier 0x0 -is stored for that entry. -.Lp -To walk the object section, you need to have a corresponding -.Sy symbol table -in the ELF object that contains the -.Nm -data. -Not every object is included in this section. -Specifically, when walking the symbol table. -An entry is skipped if it matches any of the following conditions: -.Lp -.Bl -bullet -offset indent -compact -.It -The symbol type is not -.Sy STT_OBJECT -.It -The symbol's section index is -.Sy SHN_UNDEF -.It -The symbol's name offset is zero -.It -The symbol's section index is -.Sy SHN_ABS -and the value of the symbol is zero. -.It -The symbol's name is -.Li _START_ -or -.Li _END_ . -These are skipped because they are used for scoping local symbols in -ELF. -.El -.Lp -The following sample code shows an example of iterating the object -section and skipping the correct symbols: -.Bd -literal -#include <gelf.h> -#include <stdio.h> - -/* - * Given the start of the object section in the CTF file, the number of symbols, - * and the ELF Data sections for the symbol table and the string table, this - * prints the type identifiers that correspond to objects. Note, a more robust - * implementation should ensure that they don't walk beyond the end of the CTF - * object section. - */ -static int -walk_symbols(uint16_t *objtoff, Elf_Data *symdata, Elf_Data *strdata, - long nsyms) -{ - long i; - uintptr_t strbase = strdata->d_buf; - - for (i = 1; i < nsyms; i++, objftoff++) { - const char *name; - GElf_Sym sym; - - if (gelf_getsym(symdata, i, &sym) == NULL) - return (1); - - if (GELF_ST_TYPE(sym.st_info) != STT_OBJECT) - continue; - if (sym.st_shndx == SHN_UNDEF || sym.st_name == 0) - continue; - if (sym.st_shndx == SHN_ABS && sym.st_value == 0) - continue; - name = (const char *)(strbase + sym.st_name); - if (strcmp(name, "_START_") == 0 || strcmp(name, "_END_") == 0) - continue; - - (void) printf("Symbol %d has type %d\n", i, *objtoff); - } - - return (0); -} -.Ed -.Ss The Function Section -The function section of the -.Nm -file encodes the types of both the function's arguments and the function's -return type. -Similar to -.Sx The Object Section , -the function section encodes information for all symbols of type -.Sy STT_FUNCTION , -excepting those that fit specific criteria. -Unlike with objects, because functions have a variable number of arguments, they -start with a type encoding as defined in -.Sx Type Encoding , -which is the size of a -.Sy uint16_t . -For functions which have no type information available, they are encoded as -.Li CTF_TYPE_INFO(CTF_K_UNKNOWN, 0, 0) . -Functions with arguments are encoded differently. -Here, the variable length is turned into the number of arguments in the -function. -If a function is a -.Sy varargs -type function, then the number of arguments is increased by one. -Functions with type information are encoded as: -.Li CTF_TYPE_INFO(CTF_K_FUNCTION, 0, nargs) . -.Lp -For functions that have no type information, nothing else is encoded, and the -next function is encoded. -For functions with type information, the next -.Sy uint16_t -is encoded with the type identifier of the return type of the function. -It is followed by each of the type identifiers of the arguments, if any exist, -in the order that they appear in the function. -Therefore, argument 0 is the first type identifier and so on. -When a function has a final varargs argument, that is encoded with the type -identifier of zero. -.Lp -Like -.Sx The Object Section , -the function section is encoded in the order of the symbol table. -It has similar, but slightly different considerations from objects. -While iterating the symbol table, if any of the following conditions are true, -then the entry is skipped and no corresponding entry is written: -.Lp -.Bl -bullet -offset indent -compact -.It -The symbol type is not -.Sy STT_FUNCTION -.It -The symbol's section index is -.Sy SHN_UNDEF -.It -The symbol's name offset is zero -.It -The symbol's name is -.Li _START_ -or -.Li _END_ . -These are skipped because they are used for scoping local symbols in -ELF. -.El -.Ss The Type Section -The type section is the heart of the -.Nm -data. -It encodes all of the information about the types themselves. -The base of the type information comes in two forms, a short form and a long -form, each of which may be followed by a variable number of arguments. -The following definitions describe the short and long forms: -.Bd -literal -#define CTF_MAX_SIZE 0xfffe /* max size of a type in bytes */ -#define CTF_LSIZE_SENT 0xffff /* sentinel for ctt_size */ -#define CTF_MAX_LSIZE UINT64_MAX - -typedef struct ctf_stype { - uint_t ctt_name; /* reference to name in string table */ - ushort_t ctt_info; /* encoded kind, variant length */ - union { - ushort_t _size; /* size of entire type in bytes */ - ushort_t _type; /* reference to another type */ - } _u; -} ctf_stype_t; - -typedef struct ctf_type { - uint_t ctt_name; /* reference to name in string table */ - ushort_t ctt_info; /* encoded kind, variant length */ - union { - ushort_t _size; /* always CTF_LSIZE_SENT */ - ushort_t _type; /* do not use */ - } _u; - uint_t ctt_lsizehi; /* high 32 bits of type size in bytes */ - uint_t ctt_lsizelo; /* low 32 bits of type size in bytes */ -} ctf_type_t; - -#define ctt_size _u._size /* for fundamental types that have a size */ -#define ctt_type _u._type /* for types that reference another type */ -.Ed -.Pp -Type sizes are stored in -.Sy bytes . -The basic small form uses a -.Sy ushort_t -to store the number of bytes. -If the number of bytes in a structure would exceed 0xfffe, then the alternate -form, the -.Sy ctf_type_t , -is used instead. -To indicate that the larger form is being used, the member -.Em ctt_size -is set to value of -.Sy CTF_LSIZE_SENT -(0xffff). -In general, when going through the type section, consumers use the -.Sy ctf_type_t -structure, but pay attention to the value of the member -.Em ctt_size -to determine whether they should increment their scan by the size of the -.Sy ctf_stype_t -or -.Sy ctf_type_t . -Not all kinds of types use -.Sy ctt_size . -Those which do not, will always use the -.Sy ctf_stype_t -structure. -The individual sections for each kind have more information. -.Lp -Types are written out in order. -Therefore the first entry encountered has a type id of 0x1, or 0x8000 if a -child. -The member -.Em ctt_name -is encoded as described in the section -.Sx String Identifiers . -The string that it points to is the name of the type. -If the identifier points to an empty string (one that consists solely of a null -terminator) then the type does not have a name, this is common with anonymous -structures and unions that only have a typedef to name them, as well as, -pointers and qualifiers. -.Lp -The next member, the -.Em ctt_info , -is encoded as described in the section -.Sx Type Encoding . -The types kind tells us how to interpret the remaining data in the -.Sy ctf_type_t -and any variable length data that may exist. -The rest of this section will be broken down into the interpretation of the -various kinds. -.Ss Encoding of Integers -Integers, which are of type -.Sy CTF_K_INTEGER , -have no variable length arguments. -Instead, they are followed by a four byte -.Sy uint_t -which describes their encoding. -All integers must be encoded with a variable length of zero. -The -.Em ctt_size -member describes the length of the integer in bytes. -In general, integer sizes will be rounded up to the closest power of two. -.Lp -The integer encoding contains three different pieces of information: -.Bl -bullet -offset indent -compact -.It -The encoding of the integer -.It -The offset in -.Sy bits -of the type -.It -The size in -.Sy bits -of the type -.El -.Pp -This encoding can be expressed through the following macros: -.Bd -literal -offset indent -#define CTF_INT_ENCODING(data) (((data) & 0xff000000) >> 24) -#define CTF_INT_OFFSET(data) (((data) & 0x00ff0000) >> 16) -#define CTF_INT_BITS(data) (((data) & 0x0000ffff)) - -#define CTF_INT_DATA(encoding, offset, bits) \\ - (((encoding) << 24) | ((offset) << 16) | (bits)) -.Ed -.Pp -The following flags are defined for the encoding at this time: -.Bd -literal -offset indent -#define CTF_INT_SIGNED 0x01 -#define CTF_INT_CHAR 0x02 -#define CTF_INT_BOOL 0x04 -#define CTF_INT_VARARGS 0x08 -.Ed -.Lp -By default, an integer is considered to be unsigned, unless it has the -.Sy CTF_INT_SIGNED -flag set. -If the flag -.Sy CTF_INT_CHAR -is set, that indicates that the integer is of a type that stores character -data, for example the intrinsic C type -.Sy char -would have the -.Sy CTF_INT_CHAR -flag set. -If the flag -.Sy CTF_INT_BOOL -is set, that indicates that the integer represents a boolean type. -For example, the intrinsic C type -.Sy _Bool -would have the -.Sy CTF_INT_BOOL -flag set. -Finally, the flag -.Sy CTF_INT_VARARGS -indicates that the integer is used as part of a variable number of arguments. -This encoding is rather uncommon. -.Ss Encoding of Floats -Floats, which are of type -.Sy CTF_K_FLOAT , -are similar to their integer counterparts. -They have no variable length arguments and are followed by a four byte encoding -which describes the kind of float that exists. -The -.Em ctt_size -member is the size, in bytes, of the float. -The float encoding has three different pieces of information inside of it: -.Lp -.Bl -bullet -offset indent -compact -.It -The specific kind of float that exists -.It -The offset in -.Sy bits -of the float -.It -The size in -.Sy bits -of the float -.El -.Lp -This encoding can be expressed through the following macros: -.Bd -literal -offset indent -#define CTF_FP_ENCODING(data) (((data) & 0xff000000) >> 24) -#define CTF_FP_OFFSET(data) (((data) & 0x00ff0000) >> 16) -#define CTF_FP_BITS(data) (((data) & 0x0000ffff)) - -#define CTF_FP_DATA(encoding, offset, bits) \\ - (((encoding) << 24) | ((offset) << 16) | (bits)) -.Ed -.Lp -Where as the encoding for integers was a series of flags, the encoding for -floats maps to a specific kind of float. -It is not a flag-based value. -The kinds of floats correspond to both their size, and the encoding. -This covers all of the basic C intrinsic floating point types. -The following are the different kinds of floats represented in the encoding: -.Bd -literal -offset indent -#define CTF_FP_SINGLE 1 /* IEEE 32-bit float encoding */ -#define CTF_FP_DOUBLE 2 /* IEEE 64-bit float encoding */ -#define CTF_FP_CPLX 3 /* Complex encoding */ -#define CTF_FP_DCPLX 4 /* Double complex encoding */ -#define CTF_FP_LDCPLX 5 /* Long double complex encoding */ -#define CTF_FP_LDOUBLE 6 /* Long double encoding */ -#define CTF_FP_INTRVL 7 /* Interval (2x32-bit) encoding */ -#define CTF_FP_DINTRVL 8 /* Double interval (2x64-bit) encoding */ -#define CTF_FP_LDINTRVL 9 /* Long double interval (2x128-bit) encoding */ -#define CTF_FP_IMAGRY 10 /* Imaginary (32-bit) encoding */ -#define CTF_FP_DIMAGRY 11 /* Long imaginary (64-bit) encoding */ -#define CTF_FP_LDIMAGRY 12 /* Long double imaginary (128-bit) encoding */ -.Ed -.Ss Encoding of Arrays -Arrays, which are of type -.Sy CTF_K_ARRAY , -have no variable length arguments. -They are followed by a structure which describes the number of elements in the -array, the type identifier of the elements in the array, and the type identifier -of the index of the array. -With arrays, the -.Em ctt_size -member is set to zero. -The structure that follows an array is defined as: -.Bd -literal -typedef struct ctf_array { - ushort_t cta_contents; /* reference to type of array contents */ - ushort_t cta_index; /* reference to type of array index */ - uint_t cta_nelems; /* number of elements */ -} ctf_array_t; -.Ed -.Lp -The -.Em cta_contents -and -.Em cta_index -members of the -.Sy ctf_array_t -are type identifiers which are encoded as per the section -.Sx Type Identifiers . -The member -.Em cta_nelems -is a simple four byte unsigned count of the number of elements. -This count may be zero when encountering C99's flexible array members. -.Ss Encoding of Functions -Function types, which are of type -.Sy CTF_K_FUNCTION , -use the variable length list to be the number of arguments in the function. -When the function has a final member which is a varargs, then the argument count -is incremented by one to account for the variable argument. -Here, the -.Em ctt_type -member is encoded with the type identifier of the return type of the function. -Note that the -.Em ctt_size -member is not used here. -.Lp -The variable argument list contains the type identifiers for the arguments of -the function, if any. -Each one is represented by a -.Sy uint16_t -and encoded according to the -.Sx Type Identifiers -section. -If the function's last argument is of type varargs, then it is also written out, -but the type identifier is zero. -This is included in the count of the function's arguments. -.Ss Encoding of Structures and Unions -Structures and Unions, which are encoded with -.Sy CTF_K_STRUCT -and -.Sy CTF_K_UNION -respectively, are very similar constructs in C. -The main difference between them is the fact that every member of a structure -follows one another, where as in a union, all members share the same memory. -They are also very similar in terms of their encoding in -.Nm . -The variable length argument for structures and unions represents the number of -members that they have. -The value of the member -.Em ctt_size -is the size of the structure and union. -There are two different structures which are used to encode members in the -variable list. -When the size of a structure or union is greater than or equal to the large -member threshold, 8192, then a different structure is used to encode the member, -all members are encoded using the same structure. -The structure for members is as follows: -.Bd -literal -typedef struct ctf_member { - uint_t ctm_name; /* reference to name in string table */ - ushort_t ctm_type; /* reference to type of member */ - ushort_t ctm_offset; /* offset of this member in bits */ -} ctf_member_t; - -typedef struct ctf_lmember { - uint_t ctlm_name; /* reference to name in string table */ - ushort_t ctlm_type; /* reference to type of member */ - ushort_t ctlm_pad; /* padding */ - uint_t ctlm_offsethi; /* high 32 bits of member offset in bits */ - uint_t ctlm_offsetlo; /* low 32 bits of member offset in bits */ -} ctf_lmember_t; -.Ed -.Lp -Both the -.Em ctm_name -and -.Em ctlm_name -refer to the name of the member. -The name is encoded as an offset into the string table as described by the -section -.Sx String Identifiers . -The members -.Sy ctm_type -and -.Sy ctlm_type -both refer to the type of the member. -They are encoded as per the section -.Sx Type Identifiers . -.Lp -The last piece of information that is present is the offset which describes the -offset in memory that the member begins at. -For unions, this value will always be zero because the start of unions in memory -is always zero. -For structures, this is the offset in -.Sy bits -that the member begins at. -Note that a compiler may lay out a type with padding. -This means that the difference in offset between two consecutive members may be -larger than the size of the member. -When the size of the overall structure is strictly less than 8192 bytes, the -normal structure, -.Sy ctf_member_t , -is used and the offset in bits is stored in the member -.Em ctm_offset . -However, when the size of the structure is greater than or equal to 8192 bytes, -then the number of bits is split into two 32-bit quantities. -One member, -.Em ctlm_offsethi , -represents the upper 32 bits of the offset, while the other member, -.Em ctlm_offsetlo , -represents the lower 32 bits of the offset. -These can be joined together to get a 64-bit sized offset in bits by shifting -the member -.Em ctlm_offsethi -to the left by thirty two and then doing a binary or of -.Em ctlm_offsetlo . -.Ss Encoding of Enumerations -Enumerations, noted by the type -.Sy CTF_K_ENUM , -are similar to structures. -Enumerations use the variable list to note the number of values that the -enumeration contains, which we'll term enumerators. -In C, an enumeration is always equivalent to the intrinsic type -.Sy int , -thus the value of the member -.Em ctt_size -is always the size of an integer which is determined based on the current model. -For illumos systems, this will always be 4, as an integer is always defined to -be 4 bytes large in both -.Sy ILP32 -and -.Sy LP64 , -regardless of the architecture. -.Lp -The enumerators encoded in an enumeration have the following structure in the -variable list: -.Bd -literal -typedef struct ctf_enum { - uint_t cte_name; /* reference to name in string table */ - int cte_value; /* value associated with this name */ -} ctf_enum_t; -.Ed -.Pp -The member -.Em cte_name -refers to the name of the enumerator's value, it is encoded according to the -rules in the section -.Sx String Identifiers . -The member -.Em cte_value -contains the integer value of this enumerator. -.Ss Encoding of Forward References -Forward references, types of kind -.Sy CTF_K_FORWARD , -in a -.Nm -file refer to types which may not have a definition at all, only a name. -If the -.Nm -file is a child, then it may be that the forward is resolved to an -actual type in the parent, otherwise the definition may be in another -.Nm -container or may not be known at all. -The only member of the -.Sy ctf_type_t -that matters for a forward declaration is the -.Em ctt_name -which points to the name of the forward reference in the string table as -described earlier. -There is no other information recorded for forward references. -.Ss Encoding of Pointers, Typedefs, Volatile, Const, and Restrict -Pointers, typedefs, volatile, const, and restrict are all similar in -.Nm . -They all refer to another type. -In the case of typedefs, they provide an alternate name, while volatile, const, -and restrict change how the type is interpreted in the C programming language. -This covers the -.Nm -kinds -.Sy CTF_K_POINTER , -.Sy CTF_K_TYPEDEF , -.Sy CTF_K_VOLATILE , -.Sy CTF_K_RESTRICT , -and -.Sy CTF_K_CONST . -.Lp -These types have no variable list entries and use the member -.Em ctt_type -to refer to the base type that they modify. -.Ss Encoding of Unknown Types -Types with the kind -.Sy CTF_K_UNKNOWN -are used to indicate gaps in the type identifier space. -These entries consume an identifier, but do not define anything. -Nothing should refer to these gap identifiers. -.Ss Dependencies Between Types -C types can be imagined as a directed, cyclic, graph. -Structures and unions may refer to each other in a way that creates a cyclic -dependency. -In cases such as these, the entire type section must be read in and processed. -Consumers must not assume that every type can be laid out in dependency order; -they cannot. -.Ss The String Section -The last section of the -.Nm -file is the -.Sy string -section. -This section encodes all of the strings that appear throughout the other -sections. -It is laid out as a series of characters followed by a null terminator. -Generally, all names are written out in ASCII, as most C compilers do not allow -and characters to appear in identifiers outside of a subset of ASCII. -However, any extended characters sets should be written out as a series of UTF-8 -bytes. -.Lp -The first entry in the section, at offset zero, is a single null -terminator to reference the empty string. -Following that, each C string should be written out, including the null -terminator. -Offsets that refer to something in this section should refer to the first byte -which begins a string. -Beyond the first byte in the section being the null terminator, the order of -strings is unimportant. -.Sh Data Encoding and ELF Considerations -.Nm -data is generally included in ELF objects which specify information to -identify the architecture and endianness of the file. -A -.Nm -container inside such an object must match the endianness of the ELF object. -Aside from the question of the endian encoding of data, there should be no other -differences between architectures. -While many of the types in this document refer to non-fixed size C integral -types, they are equivalent in the models -.Sy ILP32 -and -.Sy LP64 . -If any other model is being used with -.Nm -data that has different sizes, then it must not use the model's sizes for -those integral types and instead use the fixed size equivalents based on an -.Sy ILP32 -environment. -.Lp -When placing a -.Nm -container inside of an ELF object, there are certain conventions that are -expected for the purposes of tooling being able to find the -.Nm -data. -In particular, a given ELF object should only contain a single -.Nm -section. -Multiple containers should be merged together into a single one. -.Lp -The -.Nm -file should be included in its own ELF section. -The section's name must be -.Ql .SUNW_ctf . -The type of the section must be -.Sy SHT_PROGBITS . -The section should have a link set to the symbol table and its address -alignment must be 4. -.Sh SEE ALSO -.Xr mdb 1 , -.Xr dtrace 1M , -.Xr gelf 3ELF , -.Xr libelf 3LIB , -.Xr a.out 4 diff --git a/usr/src/man/man4/d_passwd.4 b/usr/src/man/man4/d_passwd.4 deleted file mode 100644 index e81c1cfc7f..0000000000 --- a/usr/src/man/man4/d_passwd.4 +++ /dev/null @@ -1,196 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 D_PASSWD 4 "Sep 2, 2004" -.SH NAME -d_passwd \- dial-up password file -.SH SYNOPSIS -.LP -.nf -\fB/etc/d_passwd\fR -.fi - -.SH DESCRIPTION -.sp -.LP -A dial-up password is an additional password required of users who access the -computer through a modem or dial-up port. The correct password must be entered -before the user is granted access to the computer. -.sp -.LP -\fBd_passwd\fR is an \fBASCII\fR file which contains a list of executable -programs (typically shells) that require a dial-up password and the associated -encrypted passwords. When a user attempts to log in on any of the ports listed -in the \fBdialups\fR file (see \fBdialups\fR(4)), the login program looks at -the user's login entry stored in the \fBpasswd\fR file (see \fBpasswd\fR(4)), -and compares the login shell field to the entries in \fBd_passwd\fR. These -entries determine whether the user will be required to supply a dial-up -password. -.sp -.LP -Each entry in \fBd_passwd\fR is a single line of the form: -.sp -.in +2 -.nf -\fIlogin-shell\fR\fB:\fR\fIpassword\fR\fB:\fR -.fi -.in -2 -.sp - -.sp -.LP -where -.sp -.ne 2 -.na -\fB\fIlogin-shell\fR\fR -.ad -.RS 15n -The name of the login program that will require an additional dial-up password. -.RE - -.sp -.ne 2 -.na -\fB\fIpassword\fR\fR -.ad -.RS 15n -An encrypted password. Users accessing the computer through a dial-up port or -modem using \fIlogin-shell\fR will be required to enter this password before -gaining access to the computer. -.RE - -.sp -.LP -\fBd_passwd\fR should be owned by the \fBroot\fR user and the \fBroot\fR group. -The file should have read and write permissions for the owner (\fBroot\fR) -only. -.sp -.LP -If the user's login program in the \fBpasswd\fR file is not found in -\fBd_passwd\fR or if the login shell field in \fBpasswd\fR is empty, the user -must supply the default password. The default password is the entry for -\fB/usr/bin/sh\fR. If \fBd_passwd\fR has no entry for \fB/usr/bin/sh\fR, then -those users whose login shell field in \fBpasswd\fR is empty or does not match -any entry in \fBd_passwd\fR will not be prompted for a dial-up password. -.sp -.LP -Dial-up logins are disabled if \fBd_passwd\fR has only the following entry: -.sp -.in +2 -.nf -/usr/bin/sh:*: -.fi -.in -2 -.sp - -.SH EXAMPLES -.LP -\fBExample 1 \fRSample \fBd_passwd\fR file. -.sp -.LP -Here is a sample \fBd_passwd\fR file: - -.sp -.in +2 -.nf -/usr/lib/uucp/uucico:q.mJzTnu8icF0: -/usr/bin/csh:6k/7KCFRPNVXg: -/usr/bin/ksh:9df/FDf.4jkRt: -/usr/bin/sh:41FuGVzGcDJlw: -.fi -.in -2 -.sp - -.SS "Generating An Encrypted Password" -.sp -.LP -The \fBpasswd\fR (see \fBpasswd\fR(1)) utility can be used to generate the -encrypted password for each login program. \fBpasswd\fR generates encrypted -passwords for users and places the password in the \fBshadow\fR (see -\fBshadow\fR(4)) file. Passwords for the \fBd_passwd\fR file will need to be -generated by first adding a temporary user id using \fBuseradd\fR (see -\fBuseradd\fR(1M)), and then using \fBpasswd\fR(1) to generate the desired -password in the \fBshadow\fR file. Once the encrypted version of the password -has been created, it can be copied to the \fBd_passwd\fR file. -.sp -.LP -For example: -.RS +4 -.TP -1. -Type \fBuseradd\fR \fBtempuser\fR and press Return. This creates a user -named \fBtempuser\fR. -.RE -.RS +4 -.TP -2. -Type \fBpasswd\fR \fBtempuser\fR and press Return. This creates an encrypted -password for \fBtempuser\fR and places it in the \fBshadow\fR file. -.RE -.RS +4 -.TP -3. -Find the entry for \fBtempuser\fR in the \fBshadow\fR file and copy the -encrypted password to the desired entry in the \fBd_passwd\fR file. -.RE -.RS +4 -.TP -4. -Type \fBuserdel\fR \fBtempuser\fR and press Return to delete \fBtempuser\fR. -.RE -.sp -.LP -These steps must be executed as the \fBroot\fR user. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/d_passwd\fR\fR -.ad -.RS 17n -dial-up password file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/dialups\fR\fR -.ad -.RS 17n -list of dial-up ports requiring dial-up passwords -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/passwd\fR\fR -.ad -.RS 17n -password file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/shadow\fR\fR -.ad -.RS 17n -shadow password file -.RE - -.SH SEE ALSO -.sp -.LP -\fBpasswd\fR(1), \fBuseradd\fR(1M), \fBdialups\fR(4), \fBpasswd\fR(4), -\fBshadow\fR(4) -.SH WARNINGS -.sp -.LP -When creating a new dial-up password, be sure to remain logged in on at least -one terminal while testing the new password. This ensures that there is an -available terminal from which you can correct any mistakes that were made when -the new password was added. diff --git a/usr/src/man/man4/dacf.conf.4 b/usr/src/man/man4/dacf.conf.4 deleted file mode 100644 index cb854b836e..0000000000 --- a/usr/src/man/man4/dacf.conf.4 +++ /dev/null @@ -1,37 +0,0 @@ -'\" te -.\" Copyright (c) 2001 Sun Microsystems, Inc. All Rights Reserved. -.\" 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 DACF.CONF 4 "May 15, 2001" -.SH NAME -dacf.conf \- device auto-configuration configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/dacf.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The kernel uses the \fBdacf.conf\fR file to automatically configure hot plugged -devices. Because the \fBdacf.conf\fR file contains important kernel state -information, it should not be modified. -.sp -.LP -The format of the \fB/etc/dacf.conf\fR file is not public and might change in -versions of the Solaris operating environment that are not compatible with -Solaris 8. -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) -.SH NOTES -.sp -.LP - This document does not constitute an \fBAPI\fR. The \fB/etc/dacf.conf\fR file -might not exist or might contain different contents or interpretations in -versions of the Solaris operating environment that are not compatible with -Solaris 8. The existence of this notice does not imply that any other -documentation lacking this notice constitutes an \fBAPI\fR. diff --git a/usr/src/man/man4/dat.conf.4 b/usr/src/man/man4/dat.conf.4 deleted file mode 100644 index 364cb28946..0000000000 --- a/usr/src/man/man4/dat.conf.4 +++ /dev/null @@ -1,192 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 DAT.CONF 4 "Jun 18, 2004" -.SH NAME -dat.conf \- DAT static registry -.SH SYNOPSIS -.LP -.nf -\fB/etc/dat/dat.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The DAT static registry, \fB/etc/dat/dat.conf\fR is a system-wide data resource -maintained by the system administrative command \fBdatadm\fR(1M). -.sp -.LP -\fB/etc/dat/dat.conf\fR contains a list of interface adapters supported by -uDAPL service providers. An interface adapter on Infiniband (IB) corresponds to -an IPoIB device instance, for example, \fBibd0\fR. An IPoIB device name -represents an IP interface plumbed by \fBifconfig\fR(1M) on an IB -partition/Host Channel Adapter port combination. -.sp -.LP -Each entry in the DAT static registry is a single line that contains eight -fields. Fields are separated by a SPACE. Lines that begin with a pound sign -(\fB#\fR) are considered comments. All characters that follow the \fB#\fR are -ignored. Enclose Solaris specific strings (\fISolaris_specific_string\fR) and -service provider's instance data (\fIservice _provider_instance_data\fR) in -quotes. -.sp -.LP -The following shows the order of the fields in a \fBdat.conf\fR entry: -.sp -.in +2 -.nf -"\fIinterface_adapter_name\fR" "\fIAPI_version\fR" "\fIthreadsafe\fR | \fInonthreadsafe\fR" \e -"\fIdefault\fR | \fInondefault\fR" "\fIservice_provider_library_pathname\fR" \e -"\fIservice_provider_version\fR" "\fIservice _provider_instance_data\fR"\e -"\fISolaris_specific_string\fR" -.fi -.in -2 - -.sp -.LP -The fields are defined as follows: -.sp -.ne 2 -.na -\fB\fIinterface_adapter_name\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the Interface Adapter (IA) name. In IB, this is the IPoIB device -instance name, for example, \fBibd0\fR. This represents an IP interface plumbed -on an IB partition/port combination of the HCA. -.RE - -.sp -.ne 2 -.na -\fB\fIAPI_version\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the API version of the service provide library: For example, -\fB"u"major.minor\fR is \fBu1.2\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIthreadsafe\fR | \fInonthreadsafe\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a threadsafe or non-threadsafe library. -.RE - -.sp -.ne 2 -.na -\fB\fIdefault\fR | \fInondefault\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a default or non-default version of library. A service provider can -offer several versions of the library. If so, one version is designated as -\fBdefault\fR with the rest as \fBnondefault\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIservice_provider_library_pathname\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the pathname of the library image. -.RE - -.sp -.ne 2 -.na -\fB\fIservice_provider_version\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the version of the service provider. By convention, specify the -company stock symbol as the service provider, followed by major and minor -version numbers, for example, \fBSUNW1.0\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIservice _provider_instance_data\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the service provider instance data. -.RE - -.sp -.ne 2 -.na -\fB\fISolaris_specific_string\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a platform specific string, for example, the device name in the -\fBservice_provider.conf\fR file. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRSample \fBdat.conf\fR File -.sp -.LP -The following \fBdat.conf\fR file shows a \fBuDAPL 1.2\fR service provider for -\fBtavor, udapl_tavor.so.1\fR supporting two interfaces, \fBibd0\fR and -\fBibd1\fR: - -.sp -.in +2 -.nf -# -# dat.conf for uDAPL 1.2 -# -ibd0 u1.2 nonthreadsafe default udapl_tavor.so.1 SUNW.1.0 "" -"driver_name=tavor" -ibd1 u1.2 nonthreadsafe default udapl_tavor.so.1 SUNW.1.0 "" -"driver_name=tavor" -.fi -.in -2 - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Standard -.TE - -.SH SEE ALSO -.sp -.LP -\fBdatadm\fR(1M), \fBifconfig\fR(1M), \fBlibdat\fR(3LIB), -\fBservice_provider.conf\fR(4), \fBattributes\fR(5) -.SH NOTES -.sp -.LP -An empty \fBdat.conf\fR is created during the package \fBSUNWudaplr\fR -installation if no file is present beforehand. Entries in the file are added or -removed by running \fBdatadm\fR(1M). -.sp -.LP -The content of the platform specific string does not constitute an API. It is -generated by \fBdatadm\fR(1M) and might have a different content or -interpretation in a future release. diff --git a/usr/src/man/man4/default_fs.4 b/usr/src/man/man4/default_fs.4 deleted file mode 100644 index e28d63b0b4..0000000000 --- a/usr/src/man/man4/default_fs.4 +++ /dev/null @@ -1,69 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" 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 DEFAULT_FS 4 "Mar 20, 1992" -.SH NAME -default_fs, fs \- specify the default file system type for local or remote file -systems -.SH DESCRIPTION -.sp -.LP -When file system administration commands have both specific and generic -components (for example, \fBfsck\fR(1M)), the file system type must be -specified. If it is not explicitly specified using the \fB-F\fR \fIFSType\fR -command line option, the generic command looks in \fB/etc/vfstab\fR in order to -determine the file system type, using the supplied raw or block device or mount -point. If the file system type can not be determined by searching -\fB/etc/vfstab\fR, the command will use the default file system type specified -in either \fB/etc/default/fs\fR or \fB/etc/dfs/dfstypes\fR, depending on -whether the file system is local or remote. -.sp -.LP -The default local file system type is specified in \fB/etc/default/fs\fR by a -line of the form \fBLOCAL=\fR\fIfstype\fR (for example, \fBLOCAL=ufs\fR). The -default remote file system type is determined by the first entry in the -\fB/etc/dfs/fstypes\fR file. -.sp -.LP -File system administration commands will determine whether the file system is -local or remote by examining the specified device name. If the device name -starts with ``/'' (slash), it is considered to be local; otherwise it is -remote. -.sp -.LP -The default file system types can be changed by editing the default files with -a text editor. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/vfstab\fR\fR -.ad -.RS 20n -list of default parameters for each file system -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/default/fs\fR\fR -.ad -.RS 20n -the default local file system type -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/dfs/fstypes\fR\fR -.ad -.RS 20n -the default remote file system type -.RE - -.SH SEE ALSO -.sp -.LP -\fBfsck\fR(1M), \fBfstypes\fR(4), \fBvfstab\fR(4) diff --git a/usr/src/man/man4/defaultdomain.4 b/usr/src/man/man4/defaultdomain.4 deleted file mode 100644 index eadfeaef5f..0000000000 --- a/usr/src/man/man4/defaultdomain.4 +++ /dev/null @@ -1,36 +0,0 @@ -'\" te -.\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 DEFAULTDOMAIN 4 "Feb 25, 2017" -.SH NAME -defaultdomain \- specify host's domain name -.SH SYNOPSIS -.LP -.nf -\fB/etc/defaultdomain\fR -.fi - -.SH DESCRIPTION -.LP -The file \fB/etc/defaultdomain\fR determines a host's domain name for direct -use by the \fBNIS\fR name service. The \fBdefaultdomain\fR file -is read at boot time and its contents used by the \fBdomainname\fR(1M) command. -Because of its use by \fBdomainname\fR, \fBdefaultdomain\fR is also used by the -\fBLDAP\fR service (see \fBldap\fR(1)). Under certain, narrow circumstances -(see \fBresolv.conf\fR(4)), because \fBdomainname\fR uses \fBdefaultdomain\fR, -a \fBDNS\fR client can use the contents of \fBdefaultdomain\fR. -.sp -.LP -The contents of \fBdefaultdomain\fR consists of a single line containing a -host's domain name. -.SH SEE ALSO -.LP -\fBuname\fR(1), \fBldapclient\fR(1M), -\fBypbind\fR(1M), \fBypinit\fR(1M), \fBresolv.conf\fR(4) -.SH NOTES -.LP -The \fBdefaultdomain\fR file is created and modified by Solaris installation -and configuration scripts. Only users knowledgeable of name service -configuration should edit the file. diff --git a/usr/src/man/man4/defaultrouter.4 b/usr/src/man/man4/defaultrouter.4 deleted file mode 100644 index 7451b4292d..0000000000 --- a/usr/src/man/man4/defaultrouter.4 +++ /dev/null @@ -1,65 +0,0 @@ -'\" te -.\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved -.\" 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 DEFAULTROUTER 4 "Aug 17, 2004" -.SH NAME -defaultrouter \- configuration file for default router(s) -.SH SYNOPSIS -.LP -.nf -\fB/etc/defaultrouter\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/etc/defaultrouter\fR file specifies a IPv4 host's default router(s). -.sp -.LP -The format of the file is as follows: -.sp -.in +2 -.nf -IP_address -\&... -.fi -.in -2 -.sp - -.sp -.LP -The \fB/etc/defaultrouter\fR file can contain the IP addresses or hostnames of -one or more default routers, with each entry on its own line. If you use -hostnames, each hostname must also be listed in the local \fB/etc/hosts\fR -file, because no name services are running at the time that \fBdefaultrouter\fR -is read. -.sp -.LP -Lines beginning with the ``#'' character are treated as comments. -.sp -.LP -The default routes listed in this file replace those added by the kernel during -diskless booting. An empty \fB/etc/defaultrouter\fR file will cause the default -route added by the kernel to be deleted. -.sp -.LP -Use of a default route, whether received from a \fBDHCP\fR server or from -\fB/etc/defaultrouter\fR, prevents a machine from acting as an IPv4 router. You -can use \fBrouteadm\fR(1M) to override this behavior. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/defaultrouter\fR\fR -.ad -.RS 22n -Configuration file containing the hostnames or IP addresses of one or more -default routers. -.RE - -.SH SEE ALSO -.sp -.LP -\fBin.rdisc\fR(1M), \fBin.routed\fR(1M), \fBrouteadm\fR(1M), \fBhosts\fR(4) diff --git a/usr/src/man/man4/depend.4 b/usr/src/man/man4/depend.4 deleted file mode 100644 index 29c4c35543..0000000000 --- a/usr/src/man/man4/depend.4 +++ /dev/null @@ -1,136 +0,0 @@ -'\" te -.\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright 1989 AT&T -.\" 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 DEPEND 4 "Oct 4, 1996" -.SH NAME -depend \- software dependencies file -.SH DESCRIPTION -.sp -.LP -\fBdepend\fR is an \fBASCII\fR file used to specify information concerning -software dependencies for a particular package. The file is created by a -software developer. -.sp -.LP -Each entry in the \fBdepend\fR file describes a single software package. The -instance of the package is described after the entry line by giving the package -architecture and/or version. The format of each entry and subsequent instance -definition is: -.sp -.in +2 -.nf -\fItype pkg name - (arch)version - (arch)version - .\|.\|.\fR -.fi -.in -2 -.sp - -.sp -.LP -The fields are: -.sp -.ne 2 -.na -\fB\fBtype\fR\fR -.ad -.RS 17n -Defines the dependency type. Must be one of the following characters: -.sp -.ne 2 -.na -\fB\fBP\fR\fR -.ad -.RS 5n -Indicates a prerequisite for installation; for example, the referenced package -or versions must be installed. -.RE - -.sp -.ne 2 -.na -\fB\fBI\fR\fR -.ad -.RS 5n -Implies that the existence of the indicated package or version is incompatible. -.RE - -.sp -.ne 2 -.na -\fB\fBR\fR\fR -.ad -.RS 5n -Indicates a reverse dependency. Instead of defining the package's own -dependencies, this designates that another package depends on this one. This -type should be used only when an old package does not have a \fBdepend\fR file, -but relies on the newer package nonetheless. Therefore, the present package -should not be removed if the designated old package is still on the system -since, if it is removed, the old package will no longer work. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIpkg\fR\fR -.ad -.RS 17n -Indicates the package abbreviation. -.RE - -.sp -.ne 2 -.na -\fB\fIname\fR\fR -.ad -.RS 17n -Specifies the full package name. -.RE - -.sp -.ne 2 -.na -\fB\fI(arch)version\fR\fR -.ad -.RS 17n -Specifies a particular instance of the software. A version name cannot begin -with a left parenthesis. The instance specifications, both \fI(arch)\fR and -\fIversion\fR, are completely optional, but each \fI(arch)version\fR pair must -begin on a new line that begins with white space. A null version set equates to -any version of the indicated package. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRSample of \fBdepend\fR file -.sp -.LP -Here are the contents of a sample \fBdepend\fR file, for the \fBSUNWftpr\fR -(FTP Server) package, stored in \fB/var/sadm/pkg/SUNWftpr/install\fR: - -.sp -.in +2 -.nf -P SUNWcar Core Architecture, (Root) -P SUNWkvm Core Architecture, (Kvm) -P SUNWcsr Core Solaris, (Root) -P SUNWcsu Core Solaris, (Usr) -P SUNWcsd Core Solaris Devices -P SUNWcsl Core Solaris Libraries -R SUNWftpu FTP Server, (Usr) -.fi -.in -2 - -.SH SEE ALSO -.sp -.LP -\fBpkginfo\fR(4) -.sp -.LP -\fIApplication Packaging Developer\&'s Guide\fR diff --git a/usr/src/man/man4/device_allocate.4 b/usr/src/man/man4/device_allocate.4 deleted file mode 100644 index 099022328e..0000000000 --- a/usr/src/man/man4/device_allocate.4 +++ /dev/null @@ -1,268 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. -.\" 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 DEVICE_ALLOCATE 4 "Mar 6, 2017" -.SH NAME -device_allocate \- device_allocate file -.SH SYNOPSIS -.LP -.nf -\fB/etc/security/device_allocate\fR -.fi - -.SH DESCRIPTION -.LP -The \fBdevice_allocate\fR file is an \fBASCII\fR file that resides in the -\fB/etc/security\fR directory. It contains mandatory access control information -about each physical device. Each device is represented by a one- line entry of -the form: -.sp -.LP -\fIdevice-name\fR;\fIdevice-type\fR;reserved1;reserved2;\fIauths\fR;\fIdevice-e -xec\fR -.sp -.LP -where: -.sp -.ne 2 -.na -\fB\fIdevice-name\fR\fR -.ad -.sp .6 -.RS 4n -Represents an arbitrary \fBASCII\fR string naming the physical device. This -field contains no embedded white space or non-printable characters. -.RE - -.sp -.ne 2 -.na -\fB\fIdevice-type\fR\fR -.ad -.sp .6 -.RS 4n -Represents an arbitrary \fBASCII\fR string naming the generic device type. This -field identifies and groups together devices of like type. This field contains -no embedded white space or non-printable characters. The following types of -devices are currently managed by the system: audio, \fBsr\fR (represents CDROM -drives), \fBfd\fR (represents floppy drives), \fBst\fR (represents tape -drives), \fBrmdisk\fR (removable media devices). -.RE - -.sp -.ne 2 -.na -\fB\fBreserved1\fR\fR -.ad -.sp .6 -.RS 4n -On systems configured with Trusted Extensions, this field stores a -colon-separated (\fB:\fR) list of key-value pairs that describe device -allocation attributes used in Trusted Extensions. Zero or more keys can be -specified. The following keys are currently interpreted by Trusted Extensions -systems: -.sp -.ne 2 -.na -\fB\fBminlabel\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the minimum label at which device can be allocated. Default value is -\fBadmin_low\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBmaxlabel\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the maximum label at which device can be allocated. Default value is -\fBadmin_high\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBzone\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the name of the zone in which device is currently allocated. -.RE - -.sp -.ne 2 -.na -\fB\fBclass\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a logical grouping of devices. For example, all Sun Ray devices of -all device types. There is no default class. -.RE - -.sp -.ne 2 -.na -\fB\fBxdpy\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the X display name. This is used to identify devices associated with -that X session. There is no default \fBxdpy\fR value. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBreserved2\fR\fR -.ad -.sp .6 -.RS 4n -Represents a field reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIauths\fR\fR -.ad -.sp .6 -.RS 4n -Represents a field that contains a comma-separated list of authorizations -required to allocate the device, an asterisk (\fB*\fR) to indicate that the -device is \fInot\fR allocatable, or an '\fB@\fR' symbol to indicate that no -explicit authorization is needed to allocate the device. The default -authorization is \fBsolaris.device.allocate\fR. See \fBauths\fR(1). -.RE - -.sp -.ne 2 -.na -\fB\fIdevice-exec\fR\fR -.ad -.sp .6 -.RS 4n -The physical device's data clean program to be run any time the device is acted -on by \fBallocate\fR(1). This ensures that unmanaged data does not remain in -the physical device between uses. This field contains the filename of a program -in \fB/etc/security/lib\fR or the full pathname of a cleanup script provided by -the system administrator. -.RE - -.SS "Notes on \fBdevice_allocate\fR" -.LP -The \fBdevice_allocate\fR file is an ASCII file that resides in the -\fB/etc/security\fR directory. -.sp -.LP -Lines in \fBdevice_allocate\fR can end with a `\fB\e\fR\&' to continue an entry -on the next line. -.sp -.LP -Comments can also be included. A `\fB#\fR' makes a comment of all further text -until the next NEWLINE not immediately preceded by a `\fB\e\fR\&'. -.sp -.LP -White space is allowed in any field. -.sp -.LP -The \fBdevice_allocate\fR file must be created by the system administrator -before device allocation is enabled. -.sp -.LP -The \fBdevice_allocate\fR file is owned by root, with a group of \fBsys\fR, and -a mode of 0644. -.SH EXAMPLES -.LP -\fBExample 1 \fRDeclaring an Allocatable Device -.sp -.LP -Declare that physical device \fBst0\fR is a type \fBst\fR. \fBst\fR is -allocatable, and the script used to clean the device after running -\fBdeallocate\fR(1) is named \fB/etc/security/lib/st_clean\fR. - -.sp -.in +2 -.nf -# scsi tape -st0;\e - st;\e - reserved;\e - reserved;\e - solaris.device.allocate;\e - /etc/security/lib/st_clean -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRDeclaring an Allocatable Device with Authorizations -.sp -.LP -Declare that physical device \fBfd0\fR is of type \fBfd\fR. \fBfd\fR is -allocatable by users with the \fBsolaris.device.allocate\fR authorization, and -the script used to clean the device after running \fBdeallocate\fR(1) is named -\fB/etc/security/lib/fd_clean\fR. - -.sp -.in +2 -.nf -# floppy drive -fd0;\e - fd;\e - reserved;\e - reserved;\e - solaris.device.allocate;\e - /etc/security/lib/fd_clean -.fi -.in -2 -.sp - -.sp -.LP -Making a device allocatable means that you need to allocate and deallocate it -to use it (with \fBallocate\fR(1) and \fBdeallocate\fR(1)). If a device is not -allocatable, there is an asterisk (\fB*\fR) in the \fIauths\fR field, and no -one can use the device. -.SH FILES -.ne 2 -.na -\fB\fB/etc/security/device_allocate\fR\fR -.ad -.sp .6 -.RS 4n -Contains list of allocatable devices -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -.LP -\fBauths\fR(1), \fBallocate\fR(1), \fBdeallocate\fR(1), -\fBlist_devices\fR(1), \fBauth_attr\fR(4), \fBattributes\fR(5) -.SH NOTES -.LP -On systems configured with Trusted Extensions, the functionality is enabled by -default. On such systems, the \fBdevice_allocate\fR file is updated -automatically by the system. diff --git a/usr/src/man/man4/device_contract.4 b/usr/src/man/man4/device_contract.4 deleted file mode 100644 index c6be174238..0000000000 --- a/usr/src/man/man4/device_contract.4 +++ /dev/null @@ -1,374 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved -.\" 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 DEVICE_CONTRACT 4 "Aug 21, 2007" -.SH NAME -device_contract \- device contract type -.SH SYNOPSIS -.LP -.nf -\fB/system/contract/device\fR -.fi - -.SH DESCRIPTION -.sp -.LP -Device contracts allow processes to monitor events involving a device of -interest and to react and/or block state changes involving such devices. -.sp -.LP -Device contracts are managed using the \fBcontract\fR(4) file system and the -\fBlibcontract\fR(3LIB) library. The process contract type directory is -\fB/system/contract/device\fR. -.SS "Creation" -.sp -.LP -A device contract may be created in one of two ways: -.RS +4 -.TP -.ie t \(bu -.el o -A process may create and activate a template and then invoke open on a minor -node of the device. The act of opening creates a contract based on the terms in -the activated template. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A process may create a contract after it has opened a device by creating a -template, setting appropriate terms (including the path to a minor node) on the -template and then invoking \fBct_tmpl_create\fR() on the template. -.RE -.SS "States, Breaks and Events" -.sp -.LP -A state refers to the state of the device which is the subject of the contract. -Currently, three states are defined for device contracts: -.sp -.ne 2 -.na -\fB\fBCT_DEV_EV_ONLINE\fR\fR -.ad -.RS 22n -The device is online and functioning normally. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_DEV_EV_DEGRADED\fR\fR -.ad -.RS 22n -The device is online, but functioning in a degraded capacity. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_DEV_EV_OFFLINE\fR\fR -.ad -.RS 22n -The device is offline and is not configured for use. -.RE - -.sp -.LP -A process creates a device contract with the kernel to get a guarantee that the -device is in an acceptable set of states as long as the contract is valid. This -acceptable set (or "A-set", for short) is specified as one of the terms of the -contract when the contract is created. -.sp -.LP -When a device moves to a state outside the "A-set", the contract is broken. The -breaking of the contract may be either asynchronous or synchronous, depending -on whether the transition that led to the breaking of the contract is -synchronous or asynchronous. -.sp -.LP -If the breaking of a contract is asynchronous, then a critical event is -generated and sent to the contract holder. The event is generated even if the -contract holder has not subscribed to the event via the critical or informative -event sets. -.sp -.LP -If the breaking of the contract is synchronous, a critical contract event is -generated with the \fBCTE_NEG\fR flag set to indicate that this is a -negotiation event. The contract holder is expected to either acknowledge -(\fBACK\fR) this change and allow the state change to occur or it may -negatively acknowledge (\fBNACK\fR) the change to block it (if it has -sufficient privileges). -.sp -.LP -The term "event" refers to the transition of a device from one state to -another. The event is named by the state to which the device is transitioning. -For instance, if a device is transitioning to the \fBOFFLINE\fR state, the name -of the event is \fBCT_DEV_EV_OFFLINE\fR. An event may have no consequence for a -contract, or it may result in the asynchronous breaking of a contract or it may -result in a synchronous (that is, negotiated) breaking of a contract. Events -are delivered to a contract holder in three cases: -.RS +4 -.TP -.ie t \(bu -.el o -The contract holder has subscribed to the event via the critical or informative -event sets. The event may be either critical or informative in this case -depending on the subscription. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The device transitions to a state outside the contract's "A-set" and the -transition is asynchronous. This results in the asynchronous breaking of the -contract and a critical event is delivered to the holder. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The device transitions to a state outside the contract's "A-set" and the -transition is synchronous. This results in the synchronous breaking of the -contract and a critical event with the \fBCTE_NEG\fR flag set is delivered to -the holder. -.RE -.sp -.LP -In the last two cases, a critical event is delivered even if the holder has not -subscribed to the event via the critical or informative event sets. -.SS "NEGOTIATION" -.sp -.LP -If the breaking of a contract is synchronous, the kernel begins negotiations -with the contract holder by generating a critical event before the device -changes state. The event has the \fBCTE_NEG\fR flag set indicating that this is -a negotiation event. The contract owner is allowed a limited period of time in -which to either \fBACK\fR the contract event (thus, allowing the state change) -or if it has appropriate privileges, \fBNACK\fR the state change (thus, -blocking the state change). \fBACK\fRs may be sent by the holder via -\fBct_ctl_ack\fR(3CONTRACT) and \fBNACK\fRs may be sent via -\fBct_ctl_nack\fR(3CONTRACT). If a contract holder does not send either a -\fBNACK\fR or \fBACK\fR within a specified period of time, an \fBACK\fR is -assumed and the kernel proceeds with the state change. -.sp -.LP -Once the device state change is finalized, the contract subsystem sends -negotiation end (\fBNEGEND\fR) critical messages to the contract owner -indicating the final disposition of the state transition. That is, either -success or failure. -.sp -.LP -Once a contract is broken, a contract owner may choose to create a replacement -contract. It may do this after the contract is broken or it may choose to do -this synchronously with the breaking of the old contract via -\fBct_ctl_newct\fR(3CONTRACT). -.SS "TERMS" -.sp -.LP -The following common contract terms, defined in \fBcontract\fR(4), have -device-contract specific attributes: -.sp -.ne 2 -.na -\fBinformative set\fR -.ad -.RS 19n -The default value for the informative set is \fBCT_DEV_EV_DEGRADE\fR that is, -transitions to the \fBDEGRADED\fR state will by default result in informative -events. Use \fBct_tmpl_set_informative\fR(3CONTRACT) to set this term. -.RE - -.sp -.ne 2 -.na -\fBcritical set\fR -.ad -.RS 19n -The default value for the informative set is \fBCT_DEV_EV_OFFLINE\fR. That is, -transitions to the \fBOFFLINE\fR state will by default result in critical -events. Use \fBct_tmpl_set_critical\fR(3CONTRACT) to set this term. -.RE - -.sp -.LP -The following contract terms can be read from or written to a device contract -template using the named \fBlibcontract\fR(3LIB) interfaces. These contract -terms are in addition to those described in \fBcontract\fR(4). -.sp -.ne 2 -.na -\fB\fBCTDP_ACCEPT\fR\fR -.ad -.RS 15n -Acceptable set or "A-set". -.sp -This term is required for every device contract. It defines the set of device -states which the contract owner expects to exist as long as the contract is -valid. If a device transitions to a state outside this "A-set", then the -contract breaks and is no longer valid. A critical contract event is sent to -the contract owner to signal this break. -.sp -Use \fBct_dev_tmpl_set_aset\fR() to set this term. The default "A-set" is -\fBCT_DEV_EV_ONLINE\fR | \fBCT_DEV_EV_DEGRADE\fR. This term is mandatory. Use -\fBct_dev_tmpl_get_aset\fR() to query a template for this term. -.RE - -.sp -.ne 2 -.na -\fB\fBCTDP_MINOR\fR\fR -.ad -.RS 15n -Specifies the \fBdevfs\fR path to a minor node that is the subject of the -contract. Used to specify the minor node to be used for creating a contract -when contract creation takes place other than at open time. -.sp -If the contract is created synchronously at \fBopen\fR(2) time, then this term -is implied to be the minor node being opened. In this case, this term need not -be explicitly be set. -.sp -Use \fBct_dev_tmpl_set_minor\fR() to set this term. The default setting for -this term is \fBNULL\fR. That is, no minor node is specified. -.sp -Use \fBct_dev_tmpl_get_noneg\fR() to query a template for the setting of this -term. -.RE - -.sp -.ne 2 -.na -\fB\fBCTDP_NONEG\fR\fR -.ad -.RS 15n -If set, this term indicates that any negotiable departure from the contract -terms should be \fBNACK\fRed. That is, the contract subsystem should assume a -\fBNACK\fR for any negotiated breaking of the contract. This term is ignored -for asynchronous contract breaks. -.sp -Use \fBct_dev_tmpl_set_noneg\fR() to set this term. The default setting is off. -.sp -Use \fBct_dev_tmpl_get_noneg\fR() to query a template for the setting of this -term. -.RE - -.SS "STATUS" -.sp -.LP -In addition to the standard items, the status object read from a status file -descriptor contains the following items if \fBCTD_FIXED\fR is specified: -.sp -.ne 2 -.na -\fB\fBCTDS_STATE\fR\fR -.ad -.RS 14n -Returns the current state of the device. One of the following states is -returned: -.RS +4 -.TP -.ie t \(bu -.el o -\fBCT_DEV_EV_ONLINE\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBCT_DEV_EV_DEGRADED\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBCT_DEV_EV_OFFLINE\fR -.sp -Use \fBct_dev_status_get_dev_state\fR() to obtain this information. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBCTDS_ASET\fR\fR -.ad -.RS 14n -Returns the acceptable states ("A-set") of the device contract. The return -value is a bitset of device states and may include one or more of the -following: -.RS +4 -.TP -.ie t \(bu -.el o -\fBCT_DEV_EV_ONLINE\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBCT_DEV_EV_DEGRADED\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBCT_DEV_EV_OFFLINE\fR -.sp -Use \fBct_dev_status_get_aset\fR() to obtain this information. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBCTDS_NONEG\fR\fR -.ad -.RS 14n -Returns the current setting of the \fBnoneg\fR flag. Returns 1 if the -\fBnoneg\fR flag is set, or 0 if the flag is not set. Use -\fBct_dev_status_get_noneg\fR() to obtain this information. -.RE - -.sp -.LP -If \fBCTD_ALL\fR is specified, the following items are also available: -.sp -.ne 2 -.na -\fB\fBCTDS_MINOR\fR\fR -.ad -.RS 14n -The \fBdevfs\fR path of the device which is the subject of the device contract. -Use \fBct_dev_status_get_minor\fR() to obtain this information. -.RE - -.SS "EVENTS" -.sp -.LP -No new event related interfaces (beyond the standard contract event interfaces) -are defined for device contract events. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/usr/include/sys/contract/device.h\fR\fR -.ad -.sp .6 -.RS 4n -Contains definitions of events, status fields and event fields -.RE - -.SH SEE ALSO -.sp -.LP -\fBctrun\fR(1), \fBctstat\fR(1), \fBctwatch\fR(1), \fBopen\fR(2), -\fBct_tmpl_set_critical\fR(3CONTRACT), -\fBct_tmpl_set_informative\fR(3CONTRACT), -\fBct_dev_tmpl_set_aset\fR(3CONTRACT), \fBct_dev_tmpl_get_aset\fR(3CONTRACT), -\fBct_dev_tmpl_set_minor\fR(3CONTRACT), \fBct_dev_tmpl_get_minor\fR(3CONTRACT), -\fBct_dev_tmpl_set_noneg\fR(3CONTRACT), \fBct_dev_tmpl_get_noneg\fR(3CONTRACT), -\fBct_dev_status_get_dev_state\fR(3CONTRACT), -\fBct_dev_status_get_aset\fR(3CONTRACT), -\fBct_dev_status_get_minor\fR(3CONTRACT), \fBlibcontract\fR(3LIB), -\fBcontract\fR(4), \fBprivileges\fR(5) diff --git a/usr/src/man/man4/device_maps.4 b/usr/src/man/man4/device_maps.4 deleted file mode 100644 index 5460ca44a0..0000000000 --- a/usr/src/man/man4/device_maps.4 +++ /dev/null @@ -1,140 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 DEVICE_MAPS 4 "Mar 6, 2017" -.SH NAME -device_maps \- device_maps file -.SH SYNOPSIS -.LP -.nf -\fB/etc/security/device_maps\fR -.fi - -.SH DESCRIPTION -.LP -The \fBdevice_maps\fR file contains access control information about each -physical device. Each device is represented by a one line entry of the form: -.sp -.in +2 -.nf -\fIdevice-name\fR \fB:\fR \fIdevice-type\fR \fB:\fR \fIdevice-list\fR \fB:\fR -.fi -.in -2 - -.sp -.LP -where -.sp -.ne 2 -.na -\fB\fIdevice-name\fR\fR -.ad -.sp .6 -.RS 4n -This is an arbitrary \fBASCII\fR string naming the physical device. This field -contains no embedded white space or non-printable characters. -.RE - -.sp -.ne 2 -.na -\fB\fIdevice-type\fR\fR -.ad -.sp .6 -.RS 4n -This is an arbitrary \fBASCII\fR string naming the generic device type. This -field identifies and groups together devices of like type. This field contains -no embedded white space or non-printable characters. -.RE - -.sp -.ne 2 -.na -\fB\fIdevice-list\fR\fR -.ad -.sp .6 -.RS 4n -This is a list of the device special files associated with the physical device. -This field contains valid device special file path names separated by white -space. -.RE - -.sp -.LP -The \fBdevice_maps\fR file is an \fBASCII\fR file that resides in the -\fB/etc/security\fR directory. -.sp -.LP -Lines in \fBdevice_maps\fR can end with a `\fB\e\fR\&' to continue an entry on -the next line. -.sp -.LP -Comments may also be included. A `\fB#\fR' makes a comment of all further text -until the next \fBNEWLINE\fR not immediately preceded by a `\fB\e\fR\&'. -.sp -.LP -Leading and trailing blanks are allowed in any of the fields. -.sp -.LP -The \fBdevice_maps\fR file must be created by the system administrator bef\eore -device allocation is enabled. -.sp -.LP -This file is owned by root, with a group of \fBsys\fR, and a mode of 0644. -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample \fBdevice_maps\fR File -.sp -.LP -The following is a sample \fBdevice_maps\fR file: - -.sp -.in +2 -.nf -# scsi tape -st1:\e -rmt:\e -/dev/rst21 /dev/nrst21 /dev/rst5 /dev/nrst5 /dev/rst13 \e -/dev/nrst13 /dev/rst29 /dev/nrst29 /dev/rmt/1l /dev/rmt/1m \e -/dev/rmt/1 /dev/rmt/1h /dev/rmt/1u /dev/rmt/1ln /dev/rmt/1mn \e -/dev/rmt/1n /dev/rmt/1hn /dev/rmt/1un /dev/rmt/1b /dev/rmt/1bn:\e -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/etc/security/device_maps\fR\fR -.ad -.RS 29n -Contains access control information for devices. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -.LP -\fBallocate\fR(1), \fBdeallocate\fR(1), -\fBlist_devices\fR(1), \fBdminfo\fR(1M), \fBdevice_allocate\fR(4), -\fBattributes\fR(5) -.SH NOTES -.LP -On systems configured with Trusted Extensions, the functionality is enabled by -default. On such systems, the \fBdevice_allocate\fR(4) file is updated -automatically by the system. diff --git a/usr/src/man/man4/devices.4 b/usr/src/man/man4/devices.4 deleted file mode 100644 index ca77d094f1..0000000000 --- a/usr/src/man/man4/devices.4 +++ /dev/null @@ -1,64 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 DEVICES 4 "Jun 8, 2006" -.SH NAME -devices, devid_cache, snapshot_cache, mdi_scsi_vhci_cache, mdi_ib_cache, -devname_cache \- device configuration information -.SH SYNOPSIS -.LP -.nf -\fB/etc/devices\fR -.fi - -.LP -.nf -\fB/etc/devices/devid_cache\fR -.fi - -.LP -.nf -\fB/etc/devices/snapshot_cache\fR -.fi - -.LP -.nf -\fB/etc/devices/mdi_scsi_vhci_cache\fR -.fi - -.LP -.nf -\fB/etc/devices/mdi_ib_cache\fR -.fi - -.LP -.nf -\fB/etc/devices/devname_cache\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The directory \fB/etc/devices\fR is a repository of device-related data. Files -in this directory are used to preserve this information across reboots and are -created and updated as necessary by the system. -.sp -.LP -There are no administrative actions necessary with respect to files in -\fB/etc/devices\fR. Should the contents of a file become corrupted or an update -fail, the file can simply be removed. The system re-creates the file as -necessary. -.SH SEE ALSO -.sp -.LP -\fBdevfsadm\fR(1M), \fBdev\fR(7FS), \fBddi_devid_compare\fR(9F), -\fBddi_devid_compare\fR(9F) -.SH NOTES -.sp -.LP -Files in this directory do not constitute an API. Files might not exist or -might have a different content or interpretation in a future release. The -existence of this notice does not imply that any other documentation that lacks -this notice constitutes an API. diff --git a/usr/src/man/man4/dfstab.4 b/usr/src/man/man4/dfstab.4 deleted file mode 100644 index 44eb353d4c..0000000000 --- a/usr/src/man/man4/dfstab.4 +++ /dev/null @@ -1,44 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 DFSTAB 4 "Aug 15, 2008" -.SH NAME -dfstab \- file containing commands for sharing resources across a network -.SH DESCRIPTION -.sp -.LP -\fBdfstab\fR resides in directory \fB/etc/dfs\fR and contains commands for -sharing resources across a network. \fBdfstab\fR gives a system administrator a -uniform method of controlling the automatic sharing of local resources. -.sp -.LP -Each line of the \fBdfstab\fR file consists of a \fBshare\fR(1M) command. The -\fBdfstab\fR file can be read by the shell to share all resources. System -administrators can also prepare their own shell scripts to execute particular -lines from \fBdfstab\fR. -.sp -.LP -The contents of \fBdfstab\fR put into effect when the command shown below is -run. See \fBsvcadm\fR(1M). -.sp -.in +2 -.nf -/usr/sbin/svcadm enable network/nfs/server -.fi -.in -2 - -.SH SEE ALSO -.sp -.LP -\fBshare\fR(1M), \fBshareall\fR(1M), \fBsharemgr\fR(1M), \fBsvcadm\fR(1M) -.SH NOTES -.sp -.LP -Do not modify this file directly. This file is reconstructed and only -maintained for backwards compatibility. Configuration lines could be lost. -.sp -.LP -Use the \fBsharemgr\fR(1M) command for all share management. diff --git a/usr/src/man/man4/dhcp_inittab.4 b/usr/src/man/man4/dhcp_inittab.4 deleted file mode 100644 index bf0c305f62..0000000000 --- a/usr/src/man/man4/dhcp_inittab.4 +++ /dev/null @@ -1,623 +0,0 @@ -'\" te -.\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright (c) 2016, Chris Fraire <cfraire@me.com>. -.\" 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 DHCP_INITTAB 4 "Oct 31, 2016" -.SH NAME -dhcp_inittab \- information repository for DHCP options -.SH DESCRIPTION -.LP -The \fB/etc/dhcp/inittab\fR and the \fB/etc/dhcp/inittab6\fR files contain -information about the Dynamic Host Configuration Protocol (\fBDHCP\fR) options, -which are network configuration parameters passed from \fBDHCP\fR servers to -\fBDHCP\fR clients when a client machine uses \fBDHCP\fR. Since many -\fBDHCP\fR-related commands must parse and understand these \fBDHCP\fR options, -this file serves as a central location where information about these options -may be obtained. -.sp -.LP -The \fBDHCP\fR \fBinittab\fR and \fBinittab6\fR files provide three general -pieces of information: -.RS +4 -.TP -.ie t \(bu -.el o -A mnemonic alias, or symbol name, for each option number. For instance, option -12 is aliased to the name \fBHostname\fR. This is useful for \fBDHCP\fR-related -programs that require human interaction, such as \fBdhcpinfo\fR(1). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Information about the syntax for each option. This includes information such as -the type of the value, for example, whether it is a 16-bit integer or an -\fBIP\fR address. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The policy for what options are visible to which \fBDHCP\fR-related programs. -.RE -.sp -.LP -If you make any changes to the \fB/etc/dhcp/inittab\fR file, note that only -additions of or changes to \fBSITE\fR options are preserved during upgrade. For -\fB/etc/dhcp/inittab6\fR, no options are preserved during upgrade. -.sp -.LP -The \fBVENDOR\fR options defined here are intended for use by the Solaris -\fBDHCP\fR client and \fBDHCP\fR management tools. The \fBSUNW\fR vendor space -is owned by Sun, and changes are likely during upgrade. If you need to -configure the Solaris \fBDHCP\fR server to support the vendor options of a -different client, see \fBdhcptab\fR(4) for details. -.sp -.LP -Each \fBDHCP\fR option belongs to a certain category, which roughly defines the -scope of the option; for instance, an option may only be understood by certain -hosts within a given site, or it may be globally understood by all \fBDHCP\fR -clients and servers. The following categories are defined; the category names -are not case-sensitive: -.sp -.ne 2 -.na -\fB\fBSTANDARD\fR\fR -.ad -.RS 12n -All client and server \fBDHCP\fR implementations agree on the semantics. These -are administered by the Internet Assigned Numbers Authority (\fBIANA\fR). These -options are numbered from \fB1\fR to \fB127\fR for IPv4 DHCP, and \fB1\fR to -\fB65535\fR for DHCPv6. -.RE - -.sp -.ne 2 -.na -\fB\fBSITE\fR\fR -.ad -.RS 12n -Within a specific site, all client and server implementations agree on the -semantics. However, at another site the type and meaning of the option may be -quite different. These options are numbered from \fB128\fR to \fB254\fR for -IPv4 DHCP. DHCPv6 does not support site options. -.RE - -.sp -.ne 2 -.na -\fB\fBVENDOR\fR\fR -.ad -.RS 12n -Each vendor may define \fB254\fR options (65536 for DHCPv6) unique to that -vendor. The vendor is identified within a \fBDHCP\fR packet by the "Vendor -Class" option, number \fB60\fR (number \fB17\fR for DHCPv6). An option with a -specific numeric identifier belonging to one vendor will, in general, have a -type and semantics different from that of a different vendor. Vendor options -are "super-encapsulated" into the vendor field number \fB43\fR, as defined in -\fIRFC 2132\fR for IPv4 DHCP, and number \fB17\fR as defined in RFC 3315 for -DHCPv6. The \fB/etc/dhcp/inittab\fR file contains only Sun vendor options. -Define non-Sun vendor options in the \fBdhcptab\fR file. -.RE - -.sp -.ne 2 -.na -\fB\fBFIELD\fR\fR -.ad -.RS 12n -This category allows the fixed fields within a \fBDHCP\fR packet to be aliased -to a mnemonic name for use with \fBdhcpinfo\fR(1). -.RE - -.sp -.ne 2 -.na -\fB\fBINTERNAL\fR\fR -.ad -.RS 12n -This category is internal to the Solaris \fBDHCP\fR implementation and will not -be further defined. -.RE - -.SS "DHCP \fBinittab\fR and \fBinittab6\fR Format" -.LP -Data entries are written one per line and have seven fields; each entry -provides information for one option. Each field is separated by a comma, except -for the first and second, which are separated by whitespace (as defined in -\fBisspace\fR(3C)). An entry cannot be continued onto another line. Blank lines -and those whose first non-whitespace character is '#' are ignored. -.sp -.LP -The fields, in order, are: -.RS +4 -.TP -.ie t \(bu -.el o -Mnemonic Identifier -.sp -The Mnemonic Identifier is a user-friendly alias for the option number; it is -not case sensitive. This field must be per-category unique and should be unique -across all categories. The option names in the \fBSTANDARD\fR, \fBSITE\fR, and -\fBVENDOR\fR spaces should not overlap, or the behavior will be undefined. See -\fBMnemonic Identifiers for Options\fR section of this man page for -descriptions of the option names. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Category (scope) -.sp -The Category field is one of \fBSTANDARD\fR, \fBSITE\fR, \fBVENDOR\fR, -\fBFIELD\fR, or \fBINTERNAL\fR and identifies the scope in which the option -falls. \fBSITE\fR is not used in \fBinittab6\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Option Number -.sp -The Option Number is the number of this option when it is in a \fBDHCP\fR -packet. This field should be per-category unique and the \fBSTANDARD\fR and -\fBSITE\fR fields should not have overlapping code fields or the behavior is -undefined. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Data Type -.sp -Data Type is one of the following values, which are not case sensitive: -.RS - -.sp -.ne 2 -.na -\fB\fBAscii\fR\fR -.ad -.RS 13n -A printable character string -.RE - -.sp -.ne 2 -.na -\fBBool\fR -.ad -.RS 13n -Has no value. Scope limited to category limited to \fBINTERNAL\fR. Presence of -an option of this type within a Solaris configuration file represents -\fBTRUE\fR, absence represents \fBFALSE\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBOctet\fR\fR -.ad -.RS 13n -An array of bytes -.RE - -.sp -.ne 2 -.na -\fB\fBUnumber8\fR\fR -.ad -.RS 13n -An 8-bit unsigned integer -.RE - -.sp -.ne 2 -.na -\fB\fBSnumber8\fR\fR -.ad -.RS 13n -An 8-bit signed integer -.RE - -.sp -.ne 2 -.na -\fB\fBUnumber16\fR\fR -.ad -.RS 13n -A 16-bit unsigned integer -.RE - -.sp -.ne 2 -.na -\fB\fBSnumber16\fR\fR -.ad -.RS 13n -A 16-bit signed integer -.RE - -.sp -.ne 2 -.na -\fB\fBUnumber24\fR\fR -.ad -.RS 13n -A 24-bit unsigned integer -.RE - -.sp -.ne 2 -.na -\fB\fBUnumber32\fR\fR -.ad -.RS 13n -A 32-bit unsigned integer -.RE - -.sp -.ne 2 -.na -\fB\fBSnumber32\fR\fR -.ad -.RS 13n -A 32-bit signed integer -.RE - -.sp -.ne 2 -.na -\fB\fBUnumber64\fR\fR -.ad -.RS 13n -A 64-bit unsigned integer -.RE - -.sp -.ne 2 -.na -\fB\fBSnumber64\fR\fR -.ad -.RS 13n -A 64-bit signed integer -.RE - -.sp -.ne 2 -.na -\fB\fBIp\fR\fR -.ad -.RS 13n -An \fBIPv4\fR address -.RE - -.sp -.ne 2 -.na -\fB\fBIpv6\fR\fR -.ad -.RS 13n -An \fBIPv6\fR address -.RE - -.sp -.ne 2 -.na -\fB\fBDuid\fR\fR -.ad -.RS 13n -An RFC 3315 Unique Identifier -.RE - -.sp -.ne 2 -.na -\fB\fBDomain\fR\fR -.ad -.RS 13n -An RFC 1035-encoded domain name -.RE - -.RE - -The data type field describes an indivisible unit of the option payload, using -one of the values listed above. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Granularity -.sp -The Granularity field describes how many indivisible units in the option -payload make up a whole value or item for this option. The value must be -greater than zero (\fB0\fR) for any data type other than Bool, in which case it -must be zero (\fB0\fR). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Maximum Number Of Items -.sp -This value specifies the maximum items of Granularity which are permissible -in a definition using this symbol. For example, there can only be one IP -address specified for a subnet mask, so the Maximum number of items -in this case is one (\fB1\fR). A Maximum value of zero (\fB0\fR) means -that a variable number of items is permitted. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Visibility -.sp -The Visibility field specifies which \fBDHCP\fR-related programs make use of -this information, and should always be defined as \fBsdmi\fR for newly added -options. -.RE -.SS "Mnemonic Identifiers for IPv4 Options" -.LP -The following table maps the mnemonic identifiers used in Solaris DHCP to -\fIRFC 2132\fR options: -.sp - -.sp -.TS -c c c -l l l . -\fISymbol\fR \fICode\fR \fIDescription\fR -_ -\fBSubnet\fR \fB1\fR T{ -Subnet Mask, dotted Internet address (IP). -T} -\fBUTCoffst\fR \fB2\fR T{ -Coordinated Universal time offset (seconds) [deprecated]. -T} -\fBRouter\fR \fB3\fR List of Routers, IP. -\fBTimeserv\fR \fB4\fR List of RFC-868 servers, IP. -\fBIEN116ns\fR \fB5\fR List of IEN 116 name servers, IP. -\fBDNSserv\fR \fB6\fR List of DNS name servers, IP. -\fBLogserv\fR \fB7\fR List of MIT-LCS UDP log servers, IP. -\fBCookie\fR \fB8\fR List of RFC-865 cookie servers, IP. -\fBLprserv\fR \fB9\fR T{ -List of RFC-1179 line printer servers, IP. -T} -\fBImpress\fR \fB10\fR List of Imagen Impress servers, IP. -\fBResource\fR \fB11\fR T{ -List of RFC-887 resource location servers, IP. -T} -\fBHostname\fR \fB12\fR T{ -Client's hostname, value from hosts database. -T} -\fBBootsize\fR \fB13\fR T{ -Number of 512 octet blocks in boot image, NUMBER. -T} -\fBDumpfile\fR \fB14\fR T{ -Path where core image should be dumped, ASCII. -T} -\fBDNSdmain\fR \fB15\fR DNS domain name, ASCII. -\fBSwapserv\fR \fB16\fR Client's swap server, IP. -\fBRootpath\fR \fB17\fR Client's Root path, ASCII. -\fBExtendP\fR \fB18\fR Extensions path, ASCII. -\fBIpFwdF\fR \fB19\fR IP Forwarding Enable/Disable, NUMBER. -\fBNLrouteF\fR \fB20\fR Non-local Source Routing, NUMBER. -\fBPFilter\fR \fB21\fR Policy Filter, IP. -\fBMaxIpSiz\fR \fB22\fR T{ -Maximum datagram Reassembly Size, NUMBER. -T} -\fBIpTTL\fR \fB23\fR T{ -Default IP Time to Live, (1=<x<=255), NUMBER. -T} -\fBPathTO\fR \fB24\fR RFC-1191 Path MTU Aging Timeout, NUMBER. -\fBPathTbl\fR \fB25\fR RFC-1191 Path MTU Plateau Table, NUMBER. -\fBMTU\fR \fB26\fR Interface MTU, x>=68, NUMBER. -\fBSameMtuF\fR \fB27\fR All Subnets are Local, NUMBER. -\fBBroadcst\fR \fB28\fR Broadcast Address, IP. -\fBMaskDscF\fR \fB29\fR Perform Mask Discovery, NUMBER. -\fBMaskSupF\fR \fB30\fR Mask Supplier, NUMBER. -\fBRDiscvyF\fR \fB31\fR Perform Router Discovery, NUMBER. -\fBRSolictS\fR \fB32\fR Router Solicitation Address, IP. -\fBStaticRt\fR \fB33\fR T{ -Static Route, Double IP (network router). -T} -\fBTrailerF\fR \fB34\fR Trailer Encapsulation, NUMBER. -\fBArpTimeO\fR \fB35\fR ARP Cache Time out, NUMBER. -\fBEthEncap\fR \fB36\fR Ethernet Encapsulation, NUMBER. -\fBTcpTTL\fR \fB37\fR TCP Default Time to Live, NUMBER. -\fBTcpKaInt\fR \fB38\fR TCP Keepalive Interval, NUMBER. -\fBTcpKaGbF\fR \fB39\fR TCP Keepalive Garbage, NUMBER. -\fBNISdmain\fR \fB40\fR NIS Domain name, ASCII. -\fBNISservs\fR \fB41\fR List of NIS servers, IP. -\fBNTPservs\fR \fB42\fR List of NTP servers, IP. -\fBNetBNms\fR \fB44\fR List of NetBIOS Name servers, IP. -\fBNetBDsts\fR \fB45\fR T{ -List of NetBIOS Distribution servers, IP. -T} -\fBNetBNdT\fR \fB46\fR T{ -NetBIOS Node type (1=B-node, 2=P, 4=M, 8=H). -T} -\fBNetBScop\fR \fB47\fR NetBIOS scope, ASCII. -\fBXFontSrv\fR \fB48\fR List of X Window Font servers, IP. -\fBXDispMgr\fR \fB49\fR List of X Window Display managers, IP. -\fBLeaseTim\fR \fB51\fR Lease Time Policy, (-1 = PERM), NUMBER. -\fBMessage\fR \fB56\fR T{ -Message to be displayed on client, ASCII. -T} -\fBT1Time\fR \fB58\fR Renewal (T1) time, NUMBER. -\fBT2Time\fR \fB59\fR Rebinding (T2) time, NUMBER. -\fBNW_dmain\fR \fB62\fR NetWare/IP Domain Name, ASCII. -\fBNWIPOpts\fR \fB63\fR T{ -NetWare/IP Options, OCTET (unknown type). -T} -\fBNIS+dom\fR \fB64\fR NIS+ Domain name, ASCII. -\fBNIS+serv\fR \fB65\fR NIS+ servers, IP. -\fBTFTPsrvN\fR \fB66\fR TFTP server hostname, ASCII. -\fBOptBootF\fR \fB67\fR Optional Bootfile path, ASCII. -\fBMblIPAgt\fR \fB68\fR Mobile IP Home Agent, IP. -\fBSMTPserv\fR \fB69\fR T{ -Simple Mail Transport Protocol Server, IP. -T} -\fBPOP3serv\fR \fB70\fR Post Office Protocol (POP3) Server, IP. -\fBNNTPserv\fR \fB71\fR T{ -Network News Transport Proto. (NNTP) Server, IP. -T} -\fBWWWservs\fR \fB72\fR Default WorldWideWeb Server, IP. -\fBFingersv\fR \fB73\fR Default Finger Server, IP. -\fBIRCservs\fR \fB74\fR Internet Relay Chat Server, IP. -\fBSTservs\fR \fB75\fR StreetTalk Server, IP. -\fBSTDAservs\fR \fB76\fR StreetTalk Directory Assist. Server, IP. -\fBUserClas\fR \fB77\fR User class information, ASCII. -\fBSLP_DA\fR \fB78\fR Directory agent, OCTET. -\fBSLP_SS\fR \fB79\fR Service scope, OCTET. -\fBClientFQDN\fR \fB81\fR Fully Qualified Domain Name, OCTET. -\fBAgentOpt\fR \fB82\fR Agent circuit ID, OCTET. -\fBFQDN\fR \fB89\fR Fully Qualified Domain Name, OCTET. -\fBPXEarch\fR \fB93\fR Client system architecture, NUMBER. -\fBBootFile\fR \fBN/A\fR File to Boot, ASCII. -\fBBootPath\fR \fBN/A\fR T{ -Boot path prefix to apply to client's requested boot file, ASCII. -T} -\fBBootSrvA\fR \fBN/A\fR Boot Server, IP. -\fBBootSrvN\fR \fBN/A\fR Boot Server Hostname, ASCII. -\fBEchoVC\fR \fBN/A\fR T{ -Echo Vendor Class Identifier Flag, (Present=\fBTRUE\fR) -T} -\fBLeaseNeg\fR \fBN/A\fR Lease is Negotiable Flag, (Present=\fBTRUE\fR) -.TE - -.SS "Mnemonic Identifiers for IPv6 Options" -.LP -The following table maps the mnemonic identifiers used in Solaris DHCP to RFC -3315, 3319, 3646, 3898, 4075, and 4280 options: -.sp - -.sp -.TS -c c c -l l l . -\fISymbol\fR \fICode\fR \fIDescription\fR -_ -\fBClientID\fR \fB1\fR Unique identifier for client, DUID -\fBServerID\fR \fB2\fR Unique identifier for server, DUID -\fBPreference\fR \fB7\fR Server preference, NUMBER -\fBUnicast\fR \fB12\fR Unicast server address, IPV6 -\fBUserClass\fR \fB15\fR User classes for client, OCTET -\fBVendorClass\fR \fB16\fR Vendor client hardware items, OCTET -\fBSIPNames\fR \fB21\fR SIP proxy server name list, DOMAIN -\fBSIPAddresses\fR \fB22\fR T{ -SIP proxy server addresses in preference order, IPV6 -T} -\fBDNSAddresses\fR \fB23\fR T{ -DNS server addresses in preference order, IPV6 -T} -\fBDNSSearch\fR \fB24\fR DNS search list, DOMAIN -\fBNISServers\fR \fB27\fR T{ -NIS server addresses in preference order, IPV6 -T} -\fBNIS+Servers\fR \fB28\fR T{ -NIS+ server addresses in preference order, IPV6 -T} -\fBNISDomain\fR \fB29\fR NIS domain name, DOMAIN -\fBNIS+Domain\fR \fB30\fR NIS+ domain name, DOMAIN -\fBSNTPServers\fR \fB31\fR IPV6 -\fBInfoRefresh\fR \fB32\fR UNUMBER32 -\fBBCMCDomain\fR \fB33\fR T{ -Broadcast/multicast control server name list, DOMAIN -T} -\fBBCMCAddresses\fR \fB34\fR T{ -Broadcast/multicast control server addresses, IPV6 -T} -.TE - -.SH EXAMPLES -.LP -\fBExample 1 \fRAltering the DHCP \fBinittab\fR File -.sp -.LP -In general, the \fBDHCP\fR \fBinittab\fR file should only be altered to add -\fBSITE\fR options. If other options are added, they will not be automatically -carried forward when the system is upgraded. For instance: - -.sp -.in +2 -.nf -ipPairs SITE, 132, IP, 2, 0, sdmi -.fi -.in -2 - -.sp -.LP -describes an option named \fBipPairs\fR, that is in the \fBSITE\fR category. -That is, it is defined by each individual site, and is option code 132, which -is of type \fBIP\fR Address, consisting of a potentially infinite number of -pairs of \fBIP\fR addresses. - -.SH FILES -.in +2 -\fB/etc/dhcp/inittab\fR -.in -2 -.br -.in +2 -\fB/etc/dhcp/inittabv6\fR -.in -2 -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.LP -\fBdhcpinfo\fR(1), \fBdhcpagent\fR(1M), \fBisspace\fR(3C), \fBdhcptab\fR(4), -\fBattributes\fR(5), \fBdhcp\fR(5), \fBdhcp_modules\fR(5) -.sp -.LP -\fISystem Administration Guide: IP Services\fR -.sp -.LP -Alexander, S., and R. Droms. \fIRFC 2132, DHCP Options and BOOTP Vendor -Extensions\fR. Network Working Group. March 1997. -.sp -.LP -Droms, R. \fI RFC 2131, Dynamic Host Configuration Protocol\fR. Network Working -Group. March 1997. -.sp -.LP -Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6 -(DHCPv6)\fR. Cisco Systems. July 2003. -.sp -.LP -Schulzrinne, H., and B. Volz. \fIRFC 3319, Dynamic Host Configuration Protocol -(DHCPv6) Options for Session Initiation Protocol (SIP) Servers\fR. Columbia -University and Ericsson. July 2003. -.sp -.LP -Droms, R. \fIRFC 3646, DNS Configuration options for Dynamic Host Configuration -Protocol for IPv6 (DHCPv6)\fR. Cisco Systems. December 2003. -.sp -.LP -Kalusivalingam, V. \fIRFC 3898, Network Information Service (NIS) Configuration -Options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6)\fR. Cisco -Systems. October 2004. -.sp -.LP -Chowdhury, K., P. Yegani, and L. Madour. \fIRFC 4280, Dynamic Host -Configuration Protocol (DHCP) Options for Broadcast and Multicast Control -Servers\fR. Starent Networks, Cisco Systems, and Ericsson. November 2005. -.sp -.LP -Mockapetris, P.V. \fIRFC 1035, Domain names - implementation and -specification\fR. ISI. November 1987. diff --git a/usr/src/man/man4/dialups.4 b/usr/src/man/man4/dialups.4 deleted file mode 100644 index 1ba309c61e..0000000000 --- a/usr/src/man/man4/dialups.4 +++ /dev/null @@ -1,92 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" 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 DIALUPS 4 "May 4, 1994" -.SH NAME -dialups \- list of terminal devices requiring a dial-up password -.SH SYNOPSIS -.LP -.nf -\fB/etc/dialups\fR -.fi - -.SH DESCRIPTION -.sp -.LP -\fBdialups\fR is an \fBASCII\fR file which contains a list of terminal devices -that require a dial-up password. A dial-up password is an additional password -required of users who access the computer through a modem or dial-up port. The -correct password must be entered before the user is granted access to the -computer. The set of ports that require a dial-up password are listed in the -\fBdialups\fR file. -.sp -.LP -Each entry in the \fBdialups\fR file is a single line of the form: -.sp -.in +2 -.nf -\fIterminal-device\fR -.fi -.in -2 -.sp - -.sp -.LP -where -.sp -.ne 2 -.na -\fB\fIterminal-device\fR\fR -.ad -.RS 19n -The full path name of the terminal device that will require a dial-up password -for users accessing the computer through a modem or dial-up port. -.RE - -.sp -.LP -The \fBdialups\fR file should be owned by the \fBroot\fR user and the -\fBroot\fR group. The file should have read and write permissions for the -owner (\fBroot\fR) only. -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample \fBdialups\fR file. -.sp -.LP -Here is a sample \fBdialups\fR file: - -.sp -.in +2 -.nf -/dev/term/a -/dev/term/b -/dev/term/c -.fi -.in -2 -.sp - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/d_passwd\fR\fR -.ad -.RS 17n -dial-up password file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/dialups\fR\fR -.ad -.RS 17n -list of dial-up ports requiring dial-up passwords -.RE - -.SH SEE ALSO -.sp -.LP -\fBd_passwd\fR(4) diff --git a/usr/src/man/man4/dir_ufs.4 b/usr/src/man/man4/dir_ufs.4 deleted file mode 100644 index f0c3e97f88..0000000000 --- a/usr/src/man/man4/dir_ufs.4 +++ /dev/null @@ -1,74 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 DIR_UFS 4 "Apr 16, 2003" -.SH NAME -dir_ufs, dir \- format of ufs directories -.SH SYNOPSIS -.LP -.nf -\fB#include <sys/param.h>\fR -.fi - -.LP -.nf -\fB#include <sys/types.h>\fR -.fi - -.LP -.nf -\fB#include <sys/fs/ufs_fsdir.h>\fR -.fi - -.SH DESCRIPTION -.sp -.LP -A directory consists of some number of blocks of \fBDIRBLKSIZ\fR bytes, where -\fBDIRBLKSIZ\fR is chosen such that it can be transferred to disk in a single -atomic operation, for example, 512 bytes on most machines. -.sp -.LP -Each \fBDIRBLKSIZ\fR-byte block contains some number of directory entry -structures, which are of variable length. Each directory entry has a -\fBstruct direct\fR at the front of it, containing its inode number, the length -of the entry, and the length of the name contained in the entry. These entries -are followed by the name padded to a 4 byte boundary with null bytes. All -names are guaranteed null-terminated. The maximum length of a name in a -directory is \fBMAXNAMLEN\fR. -.sp -.in +2 -.nf -#define DIRBLKSIZ DEV_BSIZE -#define MAXNAMLEN 256 -struct direct { - ulong_t d_ino; /* inode number of entry */ - ushort_t d_reclen; /* length of this record */ - ushort_t d_namlen; /* length of string in d_name */ - char d_name[MAXNAMLEN + 1]; /* maximum name length */ -}; -.fi -.in -2 - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Unstable -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBufs\fR(7FS) diff --git a/usr/src/man/man4/driver.conf.4 b/usr/src/man/man4/driver.conf.4 deleted file mode 100644 index 92cb57d2ef..0000000000 --- a/usr/src/man/man4/driver.conf.4 +++ /dev/null @@ -1,221 +0,0 @@ -'\" te -.\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved -.\" 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 DRIVER.CONF 4 "Sep 16, 2018" -.SH NAME -driver.conf \- driver configuration files -.SH SYNOPSIS -.LP -.nf -\fBdriver.conf\fR -.fi - -.SH DESCRIPTION -.LP -Driver configuration files provide values for device properties. The values -override values provided by the devices themselves. Most modern devices provide -enough property values to make a driver configuration file unnecessary. -.sp -.LP -The system associates a driver with its configuration file by name. For -example, a driver in \fB/usr/kernel/drv\fR called \fBwombat\fR has the driver -configuration file \fBwombat.conf\fR, also stored in \fB/usr/kernel/drv\fR, -associated with it. On systems that support 64-bit drivers, the driver -configuration file should be placed in the directory in which the 32-bit driver -is (or would be) located, even if only a 64-bit version is provided. For -example, a 64-bit driver stored in \fB/usr/kernel/drv/sparcv9\fR stores its -driver configuration file in \fB/usr/kernel/drv\fR. -.sp -.LP -The value of the \fBname\fR property is the node name. In a \fBdriver.conf\fR -file, where the generic node name and \fBcompatible\fR property associated with -a self-identifying devices are typically not used, the node name must be a -binding name. The binding name is the name chosen by the system to bind a -driver to the device. The binding name is either an alias associated with the -driver established by \fBadd_drv\fR(1M) or the driver name itself. -.sp -.LP -The syntax of a single entry in a driver configuration file takes one of three -forms: -.sp -.in +2 -.nf -\fBname\fR="\fInode name\fR" \fBparent\fR="\fIparent name\fR" [\fIproperty-name=value\fR ...]\fB;\fR -.fi -.in -2 - -.sp -.LP -In this form, the parent name can be either the binding name of the parent -nexus driver or a specific full pathname, beginning with a slash (\fB/\fR) -character, identifying a specific instance of a parent bus. If a binding name -is used then all parent nodes bound to that driver match. A generic name (for -example, \fBpci\fR) is not a valid binding name even though it can appear in -the full pathname of all intended parents. -.sp -.LP -Alternatively, the parent can be specified by the type of interface it presents -to its children. -.sp -.in +2 -.nf -\fBname\fR="\fInode name\fR" \fBclass\fR="\fIclass name\fR" [\fIproperty-name=value\fR ...]\fB;\fR -.fi -.in -2 - -.sp -.LP -For example, the driver for the \fBSCSI\fR host adapter can have different -names on different platforms, but the target drivers can use class \fBscsi\fR -to insulate themselves from these differences. -.sp -.LP -Entries of either form above correspond to a device information (\fBdevinfo\fR) -node in the kernel device tree. Each node has a \fIname\fR which is usually the -name of the driver, and a \fIparent\fR name which is the name of the parent -\fBdevinfo\fR node to which it will be connected. Any number of name-value -pairs can be specified to create properties on the prototype \fBdevinfo\fR -node. These properties can be retrieved using the DDI property interfaces (for -example, \fBddi_prop_get_int\fR(9F) and \fBddi_prop_lookup\fR(9F)). The -prototype \fBdevinfo\fR node specification must be terminated with a semicolon -(\fB;\fR). -.sp -.LP -The third form of an entry is simply a list of properties. -.sp -.in +2 -.nf -[\fIproperty-name=value\fR ...]\fB;\fR -.fi -.in -2 -.sp - -.sp -.LP -A property created in this way is treated as global to the driver. It can be -overridden by a property with the same name on a particular \fBdevinfo\fR node, -either by creating one explicitly on the prototype node in the driver.conf file -or by the driver. -.sp -.LP -Items are separated by any number of newlines, \fBSPACE\fR or \fBTAB\fR -characters. -.sp -.LP -The configuration file can contain several entries to specify different device -configurations and parent nodes. The system can call the driver for each -possible prototype \fBdevinfo\fR node, and it is generally the responsibility -of the drivers \fBprobe\fR(9E) routine to determine if the hardware described -by the prototype \fBdevinfo\fR node is really present. -.sp -.LP -Property names must not violate the naming conventions for Open Boot PROM -properties or for IEEE 1275 names. In particular, property names should contain -only printable characters, and should not contain at-sign (\fB@\fR), slash -(\fB/\fR), backslash (\fB\e\fR), colon (\fB:\fR), or square brackets -(\fB[]\fR). Property values can be decimal integers or strings delimited by -double quotes (\fB"\fR). Hexadecimal integers can be constructed by prefixing -the digits with \fB0x\fR. -.sp -.LP -A comma separated list of integers can be used to construct properties whose -value is an integer array. The value of such properties can be retrieved inside -the driver using \fBddi_prop_lookup_int_array\fR(9F). -.sp -.LP -Comments are specified by placing a \fB#\fR character at the beginning of the -comment string, the comment string extends for the rest of the line. -.SH EXAMPLES -.LP -\fBExample 1 \fRConfiguration File for a PCI Bus Frame Buffer -.sp -.LP -The following is an example of a configuration file called -\fBACME,simple.conf\fR for a \fBPCI\fR bus frame buffer called -\fBACME,simple\fR. - -.sp -.in +2 -.nf -# -# Copyright (c) 1993, by ACME Fictitious Devices, Inc. -# -#ident "@(#)ACME,simple.conf 1.3 1999/09/09" - -name="ACME,simple" class="pci" unit-address="3,1" - debug-mode=12; -.fi -.in -2 - -.sp -.LP -This example creates a prototype \fBdevinfo\fR node called \fBACME,simple\fR -under all parent nodes of class \fBpci\fR. The node has device and function -numbers of 3 and 1, respectively; the property \fBdebug-mode\fR is provided for -all instances of the driver. - -.LP -\fBExample 2 \fRConfiguration File for a Pseudo Device Driver -.sp -.LP -The following is an example of a configuration file called -\fBACME,example.conf\fR for a pseudo device driver called \fBACME,example\fR. - -.sp -.in +2 -.nf -# -# Copyright (c) 1993, ACME Fictitious Devices, Inc. -# -#ident "@(#)ACME,example.conf 1.2 93/09/09" -name="ACME,example" parent="pseudo" instance=0 - debug-level=1; - -name="ACME,example" parent="pseudo" instance=1; - -whizzy-mode="on"; -debug-level=3; -.fi -.in -2 - -.sp -.LP -This creates two \fBdevinfo\fR nodes called \fBACME,example\fR which attaches -below the \fBpseudo\fR node in the kernel device tree. The \fBinstance\fR -property is only interpreted by the \fBpseudo\fR node, see \fBpseudo\fR(4) for -further details. A property called \fBdebug-level\fR is created on the first -\fBdevinfo\fR node which has the value 1. The \fBexample\fR driver is able to -fetch the value of this property using \fBddi_prop_get_int\fR(9F). - -.sp -.LP -Two global driver properties are created, \fBwhizzy-mode\fR (which has the -string value "on") and \fBdebug-level\fR (which has the value 3). If the driver -looks up the property \fBwhizzy-mode\fR on either node, it retrieves the value -of the global \fBwhizzy-mode\fR property ("on"). If the driver looks up the -\fBdebug-level\fR property on the first node, it retrieves the value of the -\fBdebug-level\fR property on that node (1). Looking up the same property on -the second node retrieves the value of the global \fBdebug-level\fR property -(3). - -.SH SEE ALSO -.LP -\fBadd_drv\fR(1M), \fBpci\fR(4), \fBpseudo\fR(4), \fBsbus\fR(4), \fBscsi\fR(4), -\fBprobe\fR(9E), \fBddi_getlongprop\fR(9F), \fBddi_getprop\fR(9F), -\fBddi_getproplen\fR(9F), \fBddi_prop_get_int\fR(9F), -\fBddi_prop_lookup\fR(9F), \fBddi_prop_op\fR(9F) -.sp -.LP -\fIWriting Device Drivers\fR -.SH WARNINGS -.LP -To avoid namespace collisions between multiple driver vendors, it is strongly -recommended that the \fIname\fR property of the driver should begin with a -vendor-unique string. A reasonably compact and unique choice is the vendor -over-the-counter stock symbol. -.SH NOTES -.LP -The \fBupdate_drv\fR(1M) command should be used to prompt the kernel to reread -\fBdriver.conf\fR files. diff --git a/usr/src/man/man4/ethers.4 b/usr/src/man/man4/ethers.4 deleted file mode 100644 index 93c67d9dd6..0000000000 --- a/usr/src/man/man4/ethers.4 +++ /dev/null @@ -1,47 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. -.\" 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 ETHERS 4 "Feb 25, 2017" -.SH NAME -ethers \- Ethernet address to hostname database or domain -.SH DESCRIPTION -.LP -The \fBethers\fR file is a local source of information about the (48-bit) -Ethernet addresses of hosts on the Internet. The \fBethers\fR file can be used -in conjunction with or instead of other \fBethers\fR sources, including the -\fBNIS\fR maps \fBethers.byname\fR and \fBethers.byaddr\fR, -or Ethernet address data stored on an LDAP server. Programs -use the \fBethers\fR(3SOCKET) routines to access this information. -.sp -.LP -The \fBethers\fR file has one line for each host on an Ethernet. The line has -the following format: -.sp -.LP -\fIEthernet-address\fR \fIofficial-host-name\fR -.sp -.LP -Items are separated by any number of \fBSPACE\fR and/or \fBTAB\fR characters. A -`\fB#\fR' indicates the beginning of a comment extending to the end of line. -.sp -.LP -The standard form for Ethernet addresses is -"\fIx\fR\fB:\fR\fIx\fR\fB:\fR\fIx\fR\fB:\fR\fIx\fR\fB:\fR\fIx\fR\fB:\fR\fIx\fR" -where \fIx\fR is a hexadecimal number between 0 and ff, representing one byte. -The address bytes are always in network order. Host names may contain any -printable character other than \fBSPACE\fR, \fBTAB\fR, \fBNEWLINE\fR, or -comment character. -.SH FILES -.ne 2 -.na -\fB\fB/etc/ethers\fR\fR -.ad -.RS 15n - -.RE - -.SH SEE ALSO -.LP -\fBethers\fR(3SOCKET), \fBhosts\fR(4), \fBnsswitch.conf\fR(4) diff --git a/usr/src/man/man4/exec_attr.4 b/usr/src/man/man4/exec_attr.4 deleted file mode 100644 index a2eb6b77a4..0000000000 --- a/usr/src/man/man4/exec_attr.4 +++ /dev/null @@ -1,229 +0,0 @@ -'\" te -.\" Copyright 2017 Peter Tribble -.\" Copyright (c) 2006 by Sun Microsystems, Inc. All rights reserved -.\" 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 EXEC_ATTR 4 "Aug 3, 2017" -.SH NAME -exec_attr \- execution profiles database -.SH SYNOPSIS -.LP -.nf -\fB/etc/security/exec_attr\fR -.fi - -.SH DESCRIPTION -.LP -\fB/etc/security/exec_attr\fR is a local database that specifies the execution -attributes associated with profiles. The \fBexec_attr\fR file can be used with -other sources for execution profiles, including the \fBexec_attr\fR \fBNIS\fR -map. Programs use the \fBgetexecattr\fR(3SECDB) routines -to access this information. -.sp -.LP -The search order for multiple execution profile sources is specified in the -\fB/etc/nsswitch.conf\fR file, as described in the \fBnsswitch.conf\fR(4) man -page. The search order follows the entry for \fBprof_attr\fR(4). -.sp -.LP -A profile is a logical grouping of authorizations and commands that is -interpreted by a profile shell to form a secure execution environment. The -shells that interpret profiles are \fBpfcsh\fR, \fBpfksh\fR, and \fBpfsh\fR. -See the \fBpfsh\fR(1) man page. Each user's account is assigned zero or more -profiles in the \fBuser_attr\fR(4) database file. -.sp -.LP -Each entry in the \fBexec_attr\fR database consists of one line of text -containing seven fields separated by colons (\fB:\fR). Line continuations using -the backslash (\fB\e\fR) character are permitted. The basic format of each -entry is: -.sp -.LP -\fIname\fR:\fIpolicy\fR:\fItype\fR:\fIres1\fR:\fIres2\fR:\fIid\fR:\fIattr\fR -.sp -.ne 2 -.na -\fB\fIname\fR\fR -.ad -.RS 10n -The name of the profile. Profile names are case-sensitive. -.RE - -.sp -.ne 2 -.na -\fB\fIpolicy\fR\fR -.ad -.RS 10n -The security policy that is associated with the profile entry. The valid -policies are \fBsuser\fR (standard Solaris superuser) and \fBsolaris\fR. The -\fBsolaris\fR policy recognizes privileges (see \fBprivileges\fR(5)); the -\fBsuser\fR policy does not. -.sp -The \fBsolaris\fR and \fBsuser\fR policies can coexist in the same -\fBexec_attr\fR database, so that Solaris releases prior to the current release -can use the \fBsuser\fR policy and the current Solaris release can use a -\fBsolaris\fR policy. \fBsolaris\fR is a superset of \fBsuser\fR; it allows you -to specify privileges in addition to UIDs. Policies that are specific to the -current release of Solaris or that contain privileges should use \fBsolaris\fR. -Policies that use UIDs only or that are not specific to the current Solaris -release should use \fBsuser\fR. -.RE - -.sp -.ne 2 -.na -\fB\fItype\fR\fR -.ad -.RS 10n -The type of object defined in the profile. The only valid type is -\fBcmd\fR, which specifies that the \fBID\fR field is a -command that would be executed by a shell. -.RE - -.sp -.ne 2 -.na -\fB\fIres1\fR\fR -.ad -.RS 10n -Reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIres2\fR\fR -.ad -.RS 10n -Reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIid\fR\fR -.ad -.RS 10n -A string that uniquely identifies the object described by the profile. -The id is either the full path to the command or the asterisk (\fB*\fR) symbol, -which is used to allow all commands. An asterisk that replaces the filename -component in a pathname indicates all files in a particular directory. -.sp -To specify arguments, the pathname should point to a shell script that is -written to execute the command with the desired argument. In a Bourne shell, -the effective UID is reset to the real UID of the process when the effective -UID is less than 100 and not equal to the real UID. Depending on the \fBeuid\fR -and \fBegid\fR values, Bourne shell limitations might make other shells -preferable. To prevent the effective UIDs from being reset to real UIDs, you -can start the script with the \fB-p\fR option. -.sp -.in +2 -.nf -#!/bin/sh -p -.fi -.in -2 -.sp -.RE - -.sp -.ne 2 -.na -\fB\fIattr\fR\fR -.ad -.RS 10n -An optional list of semicolon-separated (\fB;\fR) key-value pairs that describe -the security attributes to apply to the object upon execution. Zero or more -keys may be specified. The list of valid key words depends on the policy -enforced. The following key words are valid: \fBeuid\fR, \fBuid,\fR \fBegid\fR, -\fBgid\fR, \fBprivs\fR, and \fBlimitprivs\fR. -.sp -\fBeuid\fR and \fBuid\fR contain a single user name or a numeric user \fBID\fR. -Commands designated with \fBeuid\fR run with the effective \fBUID\fR indicated, -which is similar to setting the setuid bit on an executable file. Commands -designated with \fBuid\fR run with both the real and effective \fBUID\fRs. -Setting \fBuid\fR may be more appropriate than setting the \fBeuid\fR on -privileged shell scripts. -.sp -\fBegid\fR and \fBgid\fR contain a single group name or a numeric group -\fBID\fR. Commands designated with \fBegid\fR run with the effective \fBGID\fR -indicated, which is similar to setting the setgid bit on a file. Commands -designated with \fBgid\fR run with both the real and effective \fBGID\fRs. -Setting \fBgid\fR may be more appropriate than setting \fBguid\fR on privileged -shell scripts. -.sp -\fBprivs\fR contains a privilege set which will be added to the inheritable set -prior to running the command. -.sp -\fBlimitprivs\fR contains a privilege set which will be assigned to the limit -set prior to running the command. -.sp -\fBprivs\fR and \fBlimitprivs\fR are only valid for the \fBsolaris\fR policy. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRUsing Effective User ID -.sp -.LP -The following example shows the \fBaudit\fR command specified in the Audit -Control profile to execute with an effective user \fBID\fR of root (\fB0\fR): - -.sp -.in +2 -.nf -\fBAudit Control:suser:cmd:::/usr/sbin/audit:euid=0\fR -.fi -.in -2 -.sp - -.SH FILES -.LP -\fB/etc/nsswitch.conf\fR -.sp -.LP -\fB/etc/user_attr\fR -.sp -.LP -\fB/etc/security/exec_attr\fR -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Availibility SUNWcsr -_ -Interface Stability See below. -.TE - -.sp -.LP -The command-line syntax is Committed. The output is Uncommitted. -.SH CAVEATS -.LP -Because the list of legal keys is likely to expand, any code that parses this -database must be written to ignore unknown key-value pairs without error. When -any new keywords are created, the names should be prefixed with a unique -string, such as the company's stock symbol, to avoid potential naming -conflicts. -.sp -.LP -The following characters are used in describing the database format and must be -escaped with a backslash if used as data: colon (\fB:\fR), semicolon (\fB;\fR), -equals (\fB=\fR), and backslash (\fB\e\fR). -.SH SEE ALSO -.LP -\fBauths\fR(1), \fBprofiles\fR(1), \fBroles\fR(1), -\fBsh\fR(1), \fBmakedbm\fR(1M), \fBgetauthattr\fR(3SECDB), -\fBgetexecattr\fR(3SECDB), \fBgetprofattr\fR(3SECDB), -\fBgetuserattr\fR(3SECDB), \fBkva_match\fR(3SECDB), \fBauth_attr\fR(4), -\fBprof_attr\fR(4), \fBuser_attr\fR(4), \fBattributes\fR(5), -\fBprivileges\fR(5) diff --git a/usr/src/man/man4/fdi.4 b/usr/src/man/man4/fdi.4 deleted file mode 100644 index 39b5db99a4..0000000000 --- a/usr/src/man/man4/fdi.4 +++ /dev/null @@ -1,448 +0,0 @@ -'\" te -.\" This manual page is dervied from documentation obtained from David Zeuthen. -.\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 FDI 4 "April 9, 2016" -.SH NAME -fdi \- HAL device information file format -.SH SYNOPSIS -.LP -.nf -/usr/share/lib/xml/dtd/fdi.dtd.1 -.fi - -.SH DESCRIPTION -.LP -The hardware abstraction layer facility, described in \fBhal\fR(5), uses an -\fBXML\fR-based file format to merge arbitrary properties onto device objects. -The way device information files works is that once all physical properties are -merged onto a device object, it is tried against the set of installed device -information files. Device information files are used for both merging facts and -policy settings for devices. -.sp -.LP -Each device information file has a number of match directives that are tested -against the properties of the device object. The directives have the form: -.sp -.in +2 -.nf -<match key="property" [string|int|bool|..]="value"> -.fi -.in -2 - -.sp -.LP -If all the match directives pass, then the device information can include the -following property directives in the form: -.sp -.in +2 -.nf -<[merge|append|prepend] key="property" type="[string|int|bool|..]"> -.fi -.in -2 - -.sp -.LP -These directives are used to merge new properties or append to existing -properties on the device object. Any previously property stemming from device -detection can be overridden by a device information file. -.sp -.LP -The \fBmatch\fR, \fBmerge\fR, \fBappend\fR, and \fBprepend\fR directives -require that the key attribute be either a property name on the device object -in question or a path to a property on another device object. The path to a -property is expressed either through direct specification of the \fBUDI\fR, -such as \fB/org/freedesktop/Hal/devices/computer:foo.bar\fR or through indirect -references such as "\fB@info.parent:baz\fR", meaning that the device object -specified by the \fBUDI\fR in the string property "\fBinfo.parent\fR" should be -used to query the property "\fBbaz\fR". It is also possible to use multiple -indirections. For example, for a volume on a \fBUSB\fR memory stick, the -indirection -"\fB@block.storage_device:@storage.physical_device:usb.vendor_id\fR" references -the "\fBusb.vendor_id\fR" property on the device object representing the -\fBUSB\fR interface. -.sp -.LP -When the property to match has been determined, the following attributes can be -used within the "\fBmatch\fR" tag: -.sp -.ne 2 -.na -\fB\fBstring\fR\fR -.ad -.RS 20n -Match a string property. For example, <match key= "foo.bar" string="baz"> -matches only if "\fBfoo.bar\fR" is a string property assuming the value -"\fBbaz\fR". -.RE - -.sp -.ne 2 -.na -\fB\fBint\fR\fR -.ad -.RS 20n -Match an integer property -.RE - -.sp -.ne 2 -.na -\fB\fBuint64\fR\fR -.ad -.RS 20n -Match property with the 64-bit unsigned type -.RE - -.sp -.ne 2 -.na -\fB\fBbool\fR\fR -.ad -.RS 20n -Match a boolean property -.RE - -.sp -.ne 2 -.na -\fB\fBdouble\fR\fR -.ad -.RS 20n -Match a property of type double -.RE - -.sp -.ne 2 -.na -\fB\fBexists\fR\fR -.ad -.RS 20n -Used as <match key="foo.bar" exists="true">. This attribute can be used with -"true" and "false", respectively to match when a property exists or does not -exist. -.RE - -.sp -.ne 2 -.na -\fB\fBempty\fR\fR -.ad -.RS 20n -This attribute can only be used on string properties with "true" and "false". -The semantics for "true" is to match only when the string is non-empty. -.RE - -.sp -.ne 2 -.na -\fB\fBis_absolute_path\fR\fR -.ad -.RS 20n -Matches only when a string property represents an absolute path (the path does -not have to exist). This attribute can be can be used with "true" or "false". -.RE - -.sp -.ne 2 -.na -\fB\fBis_ascii\fR\fR -.ad -.RS 20n -Matches only when a string property contains \fBASCII\fR characters. This -attribute can be used with "true" or "false". -.RE - -.sp -.ne 2 -.na -\fB\fBcompare_lt\fR\fR -.ad -.RS 20n -This attribute can be used with \fBint\fR, \fBuint64\fR, \fBdouble\fR and -\fBstring\fR properties to compare with a constant. It matches when the given -property is less than the given constant using the default ordering. -.RE - -.sp -.ne 2 -.na -\fB\fBcompare_le\fR\fR -.ad -.RS 20n -Similar to \fBcompare_lt\fR, but matches when the given property is less than -or equal than the given constant using the default ordering. -.RE - -.sp -.ne 2 -.na -\fB\fBcompare_gt\fR\fR -.ad -.RS 20n -Similar to \fBcompare_lt\fR, but matches when the given property is greater -than the given constant using the default ordering. -.RE - -.sp -.ne 2 -.na -\fB\fR -.ad -.RS 20n -Similar to \fBcompare_lt\fR, but matches when the given property is greater -than or equal than the given constant using the default ordering. -.RE - -.sp -.ne 2 -.na -\fB\fR -.ad -.RS 20n -This attribute can only be used with \fBstring\fR and \fBstrlist\fR (string -list). For a string key, this matches when the property contains the given -(sub)string. For a string list, this matches if the given string matches a item -in the list. -.RE - -.sp -.ne 2 -.na -\fB\fBcontains_ncase\fR\fR -.ad -.RS 20n -Similar to \fBcontains\fR, but the property and the given key are converted to -lowercase before it is checked. -.RE - -.sp -.LP -The \fBmerge\fR, \fBappend\fR, and \fBprepend\fR directives all require the -attribute type which specifies what is to be merged. The following values are -supported: -.sp -.ne 2 -.na -\fB\fBstring\fR\fR -.ad -.RS 17n -The value is copied to the property. For example, <merge key="foo bar" -type="string"> baz</merege> merges the value "baz" into the property "foo.bar". -.RE - -.sp -.ne 2 -.na -\fB\fBstrlist\fR\fR -.ad -.RS 17n -For \fBmerge\fR, the value is copied to the property and the current property -is overwritten. For \fBappend\fR and \fBprepend\fR, the value is appended or -prepended to the list as a new item. -.RE - -.sp -.ne 2 -.na -\fB\fBbool\fR\fR -.ad -.RS 17n -This attribute can merge the values "true" or "false" -.RE - -.sp -.ne 2 -.na -\fB\fBint\fR\fR -.ad -.RS 17n -Merges an integer -.RE - -.sp -.ne 2 -.na -\fBuint64\fR -.ad -.RS 17n -Merges an unsigned 64-bit integer -.RE - -.sp -.ne 2 -.na -\fB\fBdouble\fR\fR -.ad -.RS 17n -Merges a double precision floating point number -.RE - -.sp -.ne 2 -.na -\fB\fBcopy_property\fR\fR -.ad -.RS 17n -Copies the value of a given property; supports paths with direct and indirect -UDI's. For example, <merge key="foo.bar" -type="copy_property">@info.parent:baz.bat</merge> merges the value of the -property "baz.bat" on the device object with the \fBUDI\fR from the property -"info.parent" into the property "foo.bar" on the device object being processed. -.RE - -.sp -.LP -The \fBremove\fR directive requires only a key and can be used with all keys. -For \fBstrlist\fR, there is also a special syntax to remove a item from the -string list. For example, to remove item "bla" from property "foo.bar", use the -following syntax: -.sp -.in +2 -.nf -<remove key="foo.bar" type="strlist">bla</merge> -.fi -.in -2 - -.sp -.LP -Device Information files are stored in the following standard hierarchy with the -following default top level directories \fBinformation\fR, \fBpolicy\fR and -\fBpreprobe\fR: -.sp -.ne 2 -.na -\fB\fBinformation\fR\fR -.ad -.RS 15n -Device information files to merge device information. -.sp -.ne 2 -.na -\fB\fB10freedesktop\fR\fR -.ad -.RS 17n -Device information files included with the \fBhal\fR tarball. -.RE - -.sp -.ne 2 -.na -\fB\fB20thirdparty\fR\fR -.ad -.RS 17n -Device information files from the device manufacturer and installed from media -accompanying the hardware. -.RE - -.sp -.ne 2 -.na -\fB\fB30user\fR\fR -.ad -.RS 17n -Device information for specific devices. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBpolicy\fR\fR -.ad -.RS 15n -Device information files to merge policy properties. -.sp -.ne 2 -.na -\fB10osvendor\fR -.ad -.RS 16n -Device information files included with the hal tarball and supplied by the -operating system vendor for policy rules. -.RE - -.sp -.ne 2 -.na -\fB20thirdparty\fR -.ad -.RS 16n -Policy rules from the device manufacturer and installed from media accompanying -the hardware. -.RE - -.sp -.ne 2 -.na -\fB30user\fR -.ad -.RS 16n -Policy rules for specific devices. -.RE - -.RE - -.sp -.ne 2 -.na -\fBpreprobe\fR -.ad -.RS 15n -Device information files to merge information before probe devices. -.sp -.ne 2 -.na -\fB10osvendor\fR -.ad -.RS 16n -Device information files included with the \fBhal\fR tarball and supplied by -the operating system vendor. -.RE - -.sp -.ne 2 -.na -\fB20thirdparty\fR -.ad -.RS 16n -Device information files from the device manufacturer and installed from media -accompanying the hardware. -.RE - -.sp -.ne 2 -.na -\fB30user\fR -.ad -.RS 16n -Device information for specific devices. -.RE - -.RE - -.sp -.LP -All device information files are matched for every \fBhal\fR device object. -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Volatile -.TE - -.SH SEE ALSO -.LP -\fBhald\fR(1M), \fBattributes\fR(5), \fBhal\fR(5), \fBlocale\fR(5), -\fBsmf\fR(5) diff --git a/usr/src/man/man4/format.dat.4 b/usr/src/man/man4/format.dat.4 deleted file mode 100644 index 010ece499c..0000000000 --- a/usr/src/man/man4/format.dat.4 +++ /dev/null @@ -1,480 +0,0 @@ -'\" te -.\" Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved -.\" 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 FORMAT.DAT 4 "Apr 19, 2001" -.SH NAME -format.dat \- disk drive configuration for the format command -.SH DESCRIPTION -.sp -.LP -\fBformat.dat\fR enables you to use your specific disk drives with -\fBformat\fR(1M). On Solaris 2.3 and compatible systems, \fBformat\fR will -automatically configure and label SCSI drives, so that they need not be defined -in \fBformat.dat\fR. Three things can be defined in the data file: -.RS +4 -.TP -.ie t \(bu -.el o -search paths -.RE -.RS +4 -.TP -.ie t \(bu -.el o -disk types -.RE -.RS +4 -.TP -.ie t \(bu -.el o -partition tables. -.RE -.SS "Syntax" -.sp -.LP -The following syntax rules apply to the data file: -.RS +4 -.TP -.ie t \(bu -.el o -The pound \fB#\fR sign is the comment character. Any text on a line after a -pound sign is not interpreted by \fBformat\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Each definition in the \fBformat.dat\fR file appears on a single logical line. -If the definition is more than one line long, all but the last line of the -definition must end with a backslash (\e). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A definition consists of a series of assignments that have an identifier on the -left side and one or more values on the right side. The assignment operator is -the equal sign (=). Assignments within a definition must be separated by a -colon (:). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -White space is ignored by \fBformat\fR(1M). If you want an assigned value to -contain white space, enclose the entire value in double quotes ("). This will -cause the white space within quotes to be preserved as part of the assignment -value. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Some assignments can have multiple values on the right hand side. Separate -values by a comma (,). -.RE -.SS "Keywords" -.sp -.LP -The data file contains disk definitions that are read in by \fBformat\fR(1M) -when it starts up. Each definition starts with one of the following keywords: -\fBsearch_path\fR, \fBdisk_type\fR, and \fBpartition\fR. -.sp -.ne 2 -.na -\fB\fBsearch_path\fR\fR -.ad -.RS 15n -4.x: Tells \fBformat\fR which disks it should search for when it starts up. The -list in the default data file contains all the disks in the GENERIC -configuration file. If your system has disks that are not in the GENERIC -configuration file, add them to the \fBsearch_path\fR definition in your data -file. The data file can contain only one \fBsearch_path\fR definition. However, -this single definition lets you specify all the disks you have in your system. -.sp -5.x: By default, \fBformat\fR(1M) understands all the logical devices that are -of the form \fB/dev/rdsk/cntndnsn\fR; hence \fBsearch_path\fR is not normally -defined on a 5.x system. -.RE - -.sp -.ne 2 -.na -\fB\fBdisk_type\fR\fR -.ad -.RS 15n -Defines the controller and disk model. Each \fBdisk_type\fR definition contains -information concerning the physical geometry of the disk. The default data file -contains definitions for the controllers and disks that the Solaris operating -environment supports. You need to add a new \fBdisk_type\fR only if you have an -unsupported disk. You can add as many \fBdisk_type\fR definitions to the data -file as you want. -.sp -The following controller types are supported by \fBformat\fR(1M): -.sp -.ne 2 -.na -\fBXY450\fR -.ad -.RS 10n -Xylogics 450 controller (SMD) -.RE - -.sp -.ne 2 -.na -\fBXD7053\fR -.ad -.RS 10n -Xylogics 7053 controller (SMD) -.RE - -.sp -.ne 2 -.na -\fBSCSI\fR -.ad -.RS 10n -True SCSI (CCS or SCSI-2) -.RE - -.sp -.ne 2 -.na -\fBISP-80\fR -.ad -.RS 10n -IPI panther controller -.RE - -The keyword itself is assigned the name of the disk type. This name appears in -the disk's label and is used to identify the disk type whenever -\fBformat\fR(1M) is run. Enclose the name in double quotes to preserve any -white space in the name. -.sp -Below are lists of identifiers for supported controllers. Note that an asterisk -('*') indicates the identifier is mandatory for that controller -- it is not -part of the keyword name. -.sp -The following identifiers are assigned values in all \fBdisk_type\fR -definitions: -.sp -.ne 2 -.na -\fB\fBacyl*\fR\fR -.ad -.RS 12n -alternate cylinders -.RE - -.sp -.ne 2 -.na -\fB\fBasect\fR\fR -.ad -.RS 12n -alternate sectors per track -.RE - -.sp -.ne 2 -.na -\fB\fBatrks\fR\fR -.ad -.RS 12n -alternate tracks -.RE - -.sp -.ne 2 -.na -\fB\fBfmt_time\fR\fR -.ad -.RS 12n -formatting time per cylinder -.RE - -.sp -.ne 2 -.na -\fB\fBncyl*\fR\fR -.ad -.RS 12n -number of logical cylinders -.RE - -.sp -.ne 2 -.na -\fB\fBnhead*\fR\fR -.ad -.RS 12n -number of logical heads -.RE - -.sp -.ne 2 -.na -\fB\fBnsect*\fR\fR -.ad -.RS 12n -number of logical sectors per track -.RE - -.sp -.ne 2 -.na -\fB\fBpcyl*\fR\fR -.ad -.RS 12n -number of physical cylinders -.RE - -.sp -.ne 2 -.na -\fB\fBphead\fR\fR -.ad -.RS 12n -number of physical heads -.RE - -.sp -.ne 2 -.na -\fB\fBpsect\fR\fR -.ad -.RS 12n -number of physical sectors per track -.RE - -.sp -.ne 2 -.na -\fB\fBrpm*\fR\fR -.ad -.RS 12n -drive RPM -.RE - -These identifiers are for SCSI and MD-21 Controllers -.sp -.ne 2 -.na -\fB\fBread_retries\fR\fR -.ad -.RS 17n -page 1 byte 3 (read retries) -.RE - -.sp -.ne 2 -.na -\fB\fBwrite_retries\fR\fR -.ad -.RS 17n -page 1 byte 8 (write retries) -.RE - -.sp -.ne 2 -.na -\fB\fBcyl_skew\fR\fR -.ad -.RS 17n -page 3 bytes 18-19 (cylinder skew) -.RE - -.sp -.ne 2 -.na -\fB\fBtrk_skew\fR\fR -.ad -.RS 17n -page 3 bytes 16-17 (track skew) -.RE - -.sp -.ne 2 -.na -\fB\fBtrks_zone\fR\fR -.ad -.RS 17n -page 3 bytes 2-3 (tracks per zone) -.RE - -.sp -.ne 2 -.na -\fB\fBcache\fR\fR -.ad -.RS 17n -page 38 byte 2 (cache parameter) -.RE - -.sp -.ne 2 -.na -\fB\fBprefetch\fR\fR -.ad -.RS 17n -page 38 byte 3 (prefetch parameter) -.RE - -.sp -.ne 2 -.na -\fB\fBmax_prefetch\fR\fR -.ad -.RS 17n -page 38 byte 4 (minimum prefetch) -.RE - -.sp -.ne 2 -.na -\fB\fBmin_prefetch\fR\fR -.ad -.RS 17n -page 38 byte 6 (maximum prefetch) -.RE - -Note: The Page 38 values are device-specific. Refer the user to the particular -disk's manual for these values. -.sp -For SCSI disks, the following geometry specifiers may cause a mode select on -the byte(s) indicated: -.sp -.ne 2 -.na -\fB\fBasect\fR\fR -.ad -.RS 9n -page 3 bytes 4-5 (alternate sectors per zone) -.RE - -.sp -.ne 2 -.na -\fB\fBatrks\fR\fR -.ad -.RS 9n -page 3 bytes 8-9 (alt. tracks per logical unit) -.RE - -.sp -.ne 2 -.na -\fB\fBphead\fR\fR -.ad -.RS 9n -page 4 byte 5 (number of heads) -.RE - -.sp -.ne 2 -.na -\fB\fBpsect\fR\fR -.ad -.RS 9n -page 3 bytes 10-11 (sectors per track) -.RE - -And these identifiers are for SMD Controllers Only -.sp -.ne 2 -.na -\fB\fBbps*\fR\fR -.ad -.RS 8n -bytes per sector (SMD) -.RE - -.sp -.ne 2 -.na -\fB\fBbpt*\fR\fR -.ad -.RS 8n -bytes per track (SMD) -.RE - -Note: under SunOS 5.x, bpt is only required for SMD disks. Under SunOS 4.x, bpt -was required for all disk types, even though it was only used for SMD disks. -.sp -And this identifier is for XY450 SMD Controllers Only -.sp -.ne 2 -.na -\fB\fBdrive_type*\fR\fR -.ad -.RS 15n -drive type (SMD) (just call this "xy450 drive type") -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBpartition\fR\fR -.ad -.RS 15n -Defines a partition table for a specific disk type. The partition table -contains the partitioning information, plus a name that lets you refer to it in -\fBformat\fR(1M). The default data file contains default partition definitions -for several kinds of disk drives. Add a partition definition if you -repartitioned any of the disks on your system. Add as many partition -definitions to the data file as you need. -.sp -Partition naming conventions differ in SunOS 4.x and in SunOS 5.x. -.sp -4.x: the partitions are named as \fBa\fR, \fBb\fR, \fBc\fR, \fBd\fR, \fBe\fR, -\fBf\fR, \fBg\fR, \fBh\fR. -.sp -5.x: the partitions are referred to by numbers \fB0\fR, \fB1\fR, \fB2\fR, -\fB3\fR, \fB4\fR, \fB5\fR, \fB6\fR, \fB7\fR. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample \fBdisk_type\fR and \fBpartition\fR. -.sp -.LP -Following is a sample \fBdisk_type\fR and \fBpartition\fR definition in -\fBformat.dat\fR file for SUN0535 disk device. - -.sp -.in +2 -.nf -disk_type = "SUN0535" \e - : ctlr = SCSI : fmt_time = 4 \e - : ncyl = 1866 : acyl = 2 : pcyl = 2500 : nhead = 7 : nsect = 80 \e - : rpm = 5400 -partition = "SUN0535" \e - : disk = "SUN0535" : ctlr = SCSI \e - : 0 = 0, 64400 : 1 = 115, 103600 : 2 = 0, 1044960 : 6 = 300, 876960 -.fi -.in -2 -.sp - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/format.dat\fR\fR -.ad -.RS 19n -default data file if \fBformat\fR \fB-x\fR is not specified, nor is there a -\fBformat.dat\fR file in the current directory. -.RE - -.SH SEE ALSO -.sp -.LP -\fBformat\fR(1M) -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR diff --git a/usr/src/man/man4/fspec.4 b/usr/src/man/man4/fspec.4 deleted file mode 100644 index 29ed119d77..0000000000 --- a/usr/src/man/man4/fspec.4 +++ /dev/null @@ -1,116 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" 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 FSPEC 4 "Jul 3, 1990" -.SH NAME -fspec \- format specification in text files -.SH DESCRIPTION -.sp -.LP -It is sometimes convenient to maintain text files on the system with -non-standard tabs, (tabs that are not set at every eighth column). Such files -must generally be converted to a standard format, frequently by replacing all -tabs with the appropriate number of spaces, before they can be processed by -system commands. A format specification occurring in the first line of a text -file specifies how tabs are to be expanded in the remainder of the file. -.sp -.LP -A format specification consists of a sequence of parameters separated by blanks -and surrounded by the brackets \fB<:\fR and \fB:>\fR. Each parameter consists -of a keyletter, possibly followed immediately by a value. The following -parameters are recognized: -.sp -.ne 2 -.na -\fB\fBt\fR\fItabs\fR\fR -.ad -.RS 11n -The \fBt\fR parameter specifies the tab settings for the file. The value of -\fBtabs\fR must be one of the following: -.RS +4 -.TP -.ie t \(bu -.el o -A list of column numbers separated by commas, indicating tabs set at the -specified columns. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A '\fB\(mi\fR\&' followed immediately by an integer \fIn\fR, indicating tabs at -intervals of \fIn\fR columns. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A '\fB\(mi\fR\&' followed by the name of a ``canned'' tab specification. -.RE -Standard tabs are specified by \fBt\(mi8\fR, or equivalently, \fBt1,9,17,25,\fR -etc. The canned tabs that are recognized are defined by the \fBtabs\fR(1) -command. -.RE - -.sp -.ne 2 -.na -\fB\fBs\fR\fIsize\fR\fR -.ad -.RS 11n -The \fBs\fR parameter specifies a maximum line size. The value of \fBsize\fR -must be an integer. Size checking is performed after tabs have been expanded, -but before the margin is prepended. -.RE - -.sp -.ne 2 -.na -\fB\fBm\fR\fImargin\fR\fR -.ad -.RS 11n -The \fBm\fR parameter specifies a number of spaces to be prepended to each -line. The value of \fImargin\fR must be an integer. -.RE - -.sp -.ne 2 -.na -\fB\fBd\fR\fR -.ad -.RS 11n -The \fBd\fR parameter takes no value. Its presence indicates that the line -containing the format specification is to be deleted from the converted file. -.RE - -.sp -.ne 2 -.na -\fB\fBe\fR\fR -.ad -.RS 11n -The \fBe\fR parameter takes no value. Its presence indicates that the current -format is to prevail only until another format specification is encountered in -the file. -.RE - -.sp -.LP -Default values, which are assumed for parameters not supplied, are \fBt\(mi8\fR -and \fBm0\fR. If the \fBs\fR parameter is not specified, no size checking is -performed. If the first line of a file does not contain a format specification, -the above defaults are assumed for the entire file. The following is an example -of a line containing a format specification: -.sp -.LP -\fB* <:t5,10,15 s72:> *\fR -.sp -.LP -If a format specification can be disguised as a comment, it is not necessary to -code the \fBd\fR parameter. -.SH SEE ALSO -.sp -.LP -\fBed\fR(1), \fBnewform\fR(1), \fBtabs\fR(1) diff --git a/usr/src/man/man4/fstypes.4 b/usr/src/man/man4/fstypes.4 deleted file mode 100644 index ddabacdc04..0000000000 --- a/usr/src/man/man4/fstypes.4 +++ /dev/null @@ -1,31 +0,0 @@ -'\" te -.\" Copyright (c) 1993, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 FSTYPES 4 "Dec 18, 1991" -.SH NAME -fstypes \- file that registers distributed file system packages -.SH DESCRIPTION -.sp -.LP -\fBfstypes\fR resides in directory \fB/etc/dfs\fR and lists distributed file -system utilities packages installed on the system. For each installed -distributed file system type, there is a line that begins with the file system -type name (for example, ``nfs''), followed by white space and descriptive text. -.sp -.LP -The file system indicated in the first line of the file is the default file -system; when Distributed File System (DFS) Administration commands are entered -without the option \fB\(miF\fR \fIfstypes\fR, the system takes the file -system type from the first line of the \fBfstypes\fR file. -.sp -.LP -The default file system can be changed by editing the \fBfstypes\fR file with -any supported text editor. -.SH SEE ALSO -.sp -.LP -\fBdfmounts\fR(1M), \fBdfshares\fR(1M), \fBshare\fR(1M), \fBshareall\fR(1M), -\fBunshare\fR(1M) diff --git a/usr/src/man/man4/ftp.4 b/usr/src/man/man4/ftp.4 deleted file mode 100644 index 2b5285b948..0000000000 --- a/usr/src/man/man4/ftp.4 +++ /dev/null @@ -1,45 +0,0 @@ -'\" te -.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 FTP 4 "Oct 22, 2002" -.SH NAME -ftp \- FTP client configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/default/ftp\fR -.fi - -.SH DESCRIPTION -.sp -.LP -Use the \fBftp\fR file to configure the behavior of the FTP client. Lines that -begin with a hash symbol ("# ") are treated as comment lines and are ignored. -.SS "Behavior Directives" -.sp -.LP -The \fBftp\fR file supports the following behavior directives: -.sp -.ne 2 -.na -\fB\fBFTP_LS_SENDS_NLST=yes | no\fR\fR -.ad -.RS 30n -The \fBls\fR command of the ftp client sends an \fBNLST\fR to the FTP Server by -default. Several non-Solaris clients send \fBLIST\fR instead. In order to make -the Solaris \fBftp\fR client send \fBLIST\fR when the \fBls\fR command is -issued, set \fBFTP_LS_SENDS_NLST\fR to \fBno\fR. The value of -\fBFTP_LS_SENDS_NLST\fR is \fByes\fR by default. -.RE - -.sp -.LP -If the user sets a value for \fBFTP_LS_SENDS_NLST\fR in the user's environment, -this value will override any \fBFTP_LS_SENDS_NLST\fR directive that is -specified in \fB/etc/default/ftp\fR. -.SH SEE ALSO -.sp -.LP -\fBftp\fR(1), \fBattributes\fR(5) diff --git a/usr/src/man/man4/ftpusers.4 b/usr/src/man/man4/ftpusers.4 deleted file mode 100644 index 54ba4780ca..0000000000 --- a/usr/src/man/man4/ftpusers.4 +++ /dev/null @@ -1,153 +0,0 @@ -'\" te -.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved -.\" 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 FTPUSERS 4 "May 1, 2003" -.SH NAME -ftpusers \- file listing users to be disallowed ftp login privileges -.SH SYNOPSIS -.LP -.nf -\fB/etc/ftpd/ftpusers\fR -.fi - -.SH DESCRIPTION -.LP -The \fBftpusers\fR file lists users for whom \fBftp\fR login privileges are -disallowed. Each \fBftpuser\fR entry is a single line of the form: -.sp -.in +2 -.nf -name -.fi -.in -2 - -.sp -.LP -where \fBname\fR is the user's login name. -.sp -.LP -The FTP Server, \fBin.ftpd\fR(1M), reads the \fBftpusers\fR file. If the login -name of the user matches one of the entries listed, it rejects the login -attempt. -.sp -.LP -The \fBftpusers\fR file has the following default configuration entries: -.sp -.in +2 -.nf -root -daemon -bin -sys -adm -lp -uccp -nuucp -smmsp -listen -nobody -noaccess -nobody4 -.fi -.in -2 - -.sp -.LP -These entries match the default instantiated entries from \fBpasswd\fR(4). The -list of default entries typically contains the superuser \fBroot\fR and other -administrative and system application identities. -.sp -.LP -The root entry is included in the \fBftpusers\fR file as a security measure -since the default policy is to disallow remote logins for this identity. This -policy is also set in the default value of the \fBCONSOLE\fR entry in the -\fB/etc/default/login\fR file. See \fBlogin\fR(1). If you allow \fBroot\fR -login privileges by deleting the root entry in \fBftpusers\fR, you should also -modify the security policy in \fB/etc/default/login\fR to reflect the site -security policy for remote login access by \fBroot\fR. -.sp -.LP -Other default entries are administrative identities that are typically assumed -by system applications but never used for local or remote login, for example -\fBsys\fR and \fBnobody\fR. Since these entries do not have a valid password -field instantiated in \fBshadow\fR(4), no login can be performed. -.sp -.LP -If a site adds similar administrative or system application identities in -\fBpasswd\fR(4) and \fBshadow\fR(4), for example, \fBmajordomo\fR, the site -should consider including them in the \fBftpusers\fR file for a consistent -security policy. -.sp -.LP -Lines that begin with \fB#\fR are treated as comment lines and are ignored. -.SH FILES -.ne 2 -.na -\fB\fB/etc/ftpd/ftpusers\fR\fR -.ad -.RS 22n -A file that lists users for whom \fBftp\fR login privileges are disallowed. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/ftpusers\fR\fR -.ad -.RS 22n -See \fB/etc/ftpd/ftpusers\fR. This file is deprecated, although its use is -still supported. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/default/login\fR\fR -.ad -.RS 22n - -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/passwd\fR\fR -.ad -.RS 22n -password file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/shadow\fR\fR -.ad -.RS 22n -shadow password file -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability See below. -.TE - -.sp -.LP -The interface stability for \fB/etc/ftpd/ftpusers\fR is Volatile. The interface -stability for \fB/etc/ftpusers\fR is (Obsolete). -.SH SEE ALSO -.LP -\fBlogin\fR(1), \fBftphosts\fR(4), -\fBpasswd\fR(4), \fBshadow\fR(4), \fBattributes\fR(5), \fBenviron\fR(5) diff --git a/usr/src/man/man4/fx_dptbl.4 b/usr/src/man/man4/fx_dptbl.4 deleted file mode 100644 index ce2ad1bc3f..0000000000 --- a/usr/src/man/man4/fx_dptbl.4 +++ /dev/null @@ -1,398 +0,0 @@ -'\" te -.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 FX_DPTBL 4 "Oct 15, 2002" -.SH NAME -fx_dptbl \- fixed priority dispatcher parameter table -.SH SYNOPSIS -.nf -\fBfx_dptbl\fR -.fi - -.SH DESCRIPTION -The process scheduler or dispatcher is the portion of the kernel that controls -allocation of the CPU to processes. The scheduler supports the notion of -scheduling classes, where each class defines a scheduling policy used to -schedule processes within that class. Associated with each scheduling class is -a set of priority queues on which ready-to-run processes are linked. These -priority queues are mapped by the system configuration into a set of global -scheduling priorities, which are available to processes within the class. The -dispatcher always selects for execution the process with the highest global -scheduling priority in the system. The priority queues associated with a given -class are viewed by that class as a contiguous set of priority levels numbered -from 0 (lowest priority) to \fIn\fR (highest priority\(ema -configuration-dependent value). The set of global scheduling priorities that -the queues for a given class are mapped into might not start at zero and might -not be contiguous, depending on the configuration. -.sp -.LP -Processes in the fixed priority class are scheduled according to the parameters -in a fixed-priority dispatcher parameter table (\fBfx_dptbl\fR). The -\fBfx_dptbl\fR table consists of an array (\fBconfig_fx_dptbl[]\fR) of -parameter structures (\fBstruct fxdpent_t\fR), one for each of the \fIn\fR -priority levels used by fixed priority processes in user mode. The structures -are accessed by way of a pointer, (\fBfx_dptbl\fR), to the array. The -properties of a given priority level \fIi\fR are specified by the \fIi\fRth -parameter structure in this array (\fBfx_dptbl[\fIi\fR]\fR). -.sp -.LP -A parameter structure consists of the following members. These are also -described in the \fB/usr/include/sys/fx.h\fR header. -.sp -.ne 2 -.na -\fB\fBfx_globpri\fR\fR -.ad -.RS 14n -The global scheduling priority associated with this priority level. The mapping -between fixed-priority priority levels and global scheduling priorities is -determined at boot time by the system configuration. \fBfx_globpri\fR can not -be changed with \fBdispadmin\fR(1M). -.RE - -.sp -.ne 2 -.na -\fB\fBfx_quantum\fR\fR -.ad -.RS 14n -The length of the time quantum allocated to processes at this level in ticks -(\fBhz\fR). The time quantum value is only a default or starting value for -processes at a particular level, as the time quantum of a fixed priority -process can be changed by the user with the \fBpriocntl\fR(1) command or the -\fBpriocntl\fR(2) system call. -.sp -In the default high resolution clock mode (\fBhires_tick\fR set to \fB1\fR), -the value of \fBhz\fR is set to \fB1000\fR. If this value is overridden to -\fB0\fR then \fBhz\fR will instead be \fB100\fR; the number of ticks per -quantum must then be decreased to maintain the same length of quantum in -absolute time. -.sp -An administrator can affect the behavior of the fixed priority portion of the -scheduler by reconfiguring the \fBfx_dptbl\fR. There are two methods available -for doing this: reconfigure with a loadable module at boot-time or by using -\fBdispadmin\fR(1M) at run-time. -.RE - -.SS "fx_dptbl Loadable Module" -The \fBfx_dptbl\fR can be reconfigured with a loadable module that contains a -new fixed priority dispatch table. The module containing the dispatch table is -separate from the \fBFX\fR loadable module, which contains the rest of the -fixed priority software. This is the only method that can be used to change the -number of fixed priority priority levels or the set of global scheduling -priorities used by the fixed priority class. The relevant procedure and source -code is described in Replacing the fx_dptbl Loadable Module below. -.SS "dispadmin Configuration File" -The \fBfx_quantum\fR values in the \fBfx_dptbl\fR can be examined and modified -on a running system using the \fBdispadmin\fR(1M) command. Invoking -\fBdispadmin\fR for the fixed-priority class allows the administrator to -retrieve the current \fBfx_dptbl\fR configuration from the kernel's in-core -table or overwrite the in-core table with values from a configuration file. The -configuration file used for input to \fBdispadmin\fR must conform to the -specific format described as follows: -.RS +4 -.TP -.ie t \(bu -.el o -Blank lines are ignored and any part of a line to the right of a # symbol is -treated as a comment. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The first non-blank, non-comment line must indicate the resolution to be used -for interpreting the time quantum values. The resolution is specified as: -.sp -.in +2 -.nf -RES=\fIres\fR -.fi -.in -2 -.sp - -where \fIres\fR is a positive integer between 1 and 1,000,000,000 inclusive and -the resolution used is the reciprocal of \fIres\fR in seconds (for example, -\fBRES=1000\fR specifies millisecond resolution). Although you can specify very -fine (nanosecond) resolution, the time quantum lengths are rounded up to the -next integral multiple of the system clock's resolution. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The remaining lines in the file are used to specify the \fBfx_quantum\fR values -for each of the fixed-priority priority levels. The first line specifies the -quantum for fixed-priority level 0, the second line specifies the quantum for -fixed-priority level 1, and so forth. There must be exactly one line for each -configured fixed priority priority level. Each \fBfx_quantum\fR entry must be a -positive integer specifying the desired time quantum in the resolution given by -\fIres\fR. -.RE -.sp -.LP -See Examples for an example of an excerpt of a \fBdispadmin\fR configuration -file. -.SS "Replacing the fx_dptbl Loadable Module" -To change the size of the fixed priority dispatch table, you must build the -loadable module that contains the dispatch table information. Save the existing -module before using the following procedure. -.RS +4 -.TP -1. -Place the dispatch table code shown below in a file called \fBfx_dptbl.c\fR. -See EXAMPLES, below, for an example of this file. -.RE -.RS +4 -.TP -2. -Compile the code using the given compilation and link lines supplied: -.sp -.in +2 -.nf -cc -c -0 -D_KERNEL fx_dptbl.c -ld -r -o FX_DPTBL fx_dptbl.o -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -3. -Copy the current dispatch table in \fB/usr/kernel/sched\fR to -\fBFX_DPTBL.bak\fR. -.RE -.RS +4 -.TP -4. -Replace the current \fBFX_DPTBL\fR in \fB/usr/kernel/sched\fR. -.RE -.RS +4 -.TP -5. -Make changes in the \fB/etc/system\fR file to reflect the changes to the -sizes of the tables. See \fBsystem\fR(4). The variables affected is -\fBfx_maxupri\fR. The syntax for setting this is as follows: -.sp -.in +2 -.nf -set FX:fx_maxupri=(\fIvalue for max fixed-priority user priority\fR) -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -6. -Reboot the system to use the new dispatch table. -.RE -.sp -.LP -Exercise great care in using the preceding method to replace the dispatch -table. A mistake can result in panics, thus making the system unusable. -.SH EXAMPLES -\fBExample 1 \fRConfiguration File Excerpt -.sp -.LP -The following excerpt from a \fBdispadmin\fR configuration file illustrates the -correct format. Note that, for each line specifying a set of parameters, there -is a comment indicating the corresponding priority level. These level numbers -indicate priority within the fixed priority class; the mapping between these -fixed-priority priorities and the corresponding global scheduling priorities is -determined by the configuration specified in the \fBFX_DPTBL\fR loadable -module. The level numbers are strictly for the convenience of the administrator -reading the file and, as with any comment, they are ignored by \fBdispadmin\fR. -The \fBdispadmin\fR command assumes that the lines in the file are ordered by -consecutive, increasing priority level (from 0 to the maximum configured -fixed-priority priority). For the sake of someone reading the file, the level -numbers in the comments should agree with this ordering. If for some reason -they do not, \fBdispadmin\fR is unaffected. - -.sp -.in +2 -.nf -# Fixed Priority Dispatcher Configuration File RES=1000 - -RES=1000 -# TIME QUANTUM PRIORITY -# (fx_quantum) LEVEL -200 # 0 -200 # 1 -200 # 2 -200 # 3 -200 # 4 -200 # 5 -200 # 6 -200 # 7 - . . . - . . . - . . . -20 # 58 -20 # 59 -20 # 60 -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fR\fBfx_dptbl.c\fR File Used for Building the New \fBfx_dptbl\fR -.sp -.LP -The following is an example of a \fBfx_dptbl.c\fR file used for building the -new \fBfx_dptbl\fR. - -.sp -.in +2 -.nf -/* BEGIN fx_dptbl.c */ - -#include <sys/proc.h> -#include <sys/priocntl.h> -#include <sys/class.h> -#include <sys/disp.h> -#include <sys/fx.h> -#include <sys/fxpriocntl.h> - - -/* - * This is the loadable module wrapper. - */ - -#include <sys/modctl.h> - -extern struct mod_ops mod_miscops; - -/* - * Module linkage information for the kernel. - */ - -static struct modlmisc modlmisc = { - &mod_miscops, "Fixed priority dispatch table" -}; - -static struct modlinkage modlinkage = { - MODREV_1, &modlmisc, 0 -}; - -_init() -{ - return (mod_install(&modlinkage)); -} - -_info(modinfop) - struct modinfo *modinfop; -{ - return (mod_info(&modlinkage, modinfop)); -} - -#define FXGPUP0 0 /* Global priority for FX user priority 0 */ -fxdpent_t config_fx_dptbl[] = { - -/* glbpri qntm */ - - FXGPUP0+0, 20, - FXGPUP0+1, 20, - FXGPUP0+2, 20, - FXGPUP0+3, 20, - FXGPUP0+4, 20, - FXGPUP0+5, 20, - FXGPUP0+6, 20, - FXGPUP0+7, 20, - FXGPUP0+8, 20, - FXGPUP0+9, 20, - FXGPUP0+10, 16, - FXGPUP0+11, 16, - FXGPUP0+12, 16, - FXGPUP0+13, 16, - FXGPUP0+14, 16, - FXGPUP0+15, 16, - FXGPUP0+16, 16, - FXGPUP0+17, 16, - FXGPUP0+18, 16, - FXGPUP0+19, 16, - FXGPUP0+20, 12, - FXGPUP0+21, 12, - FXGPUP0+22, 12, - FXGPUP0+23, 12, - FXGPUP0+24, 12, - FXGPUP0+25, 12, - FXGPUP0+26, 12, - FXGPUP0+27, 12, - FXGPUP0+28, 12, - FXGPUP0+29, 12, - FXGPUP0+30, 8, - FXGPUP0+31, 8, - FXGPUP0+32, 8, - FXGPUP0+33, 8, - FXGPUP0+34, 8, - FXGPUP0+35, 8, - FXGPUP0+36, 8, - FXGPUP0+37, 8, - FXGPUP0+38, 8, - FXGPUP0+39, 8, - FXGPUP0+40, 4, - FXGPUP0+41, 4, - FXGPUP0+42, 4, - FXGPUP0+43, 4, - FXGPUP0+44, 4, - FXGPUP0+45, 4, - FXGPUP0+46, 4, - FXGPUP0+47, 4, - FXGPUP0+48, 4, - FXGPUP0+49, 4, - FXGPUP0+50, 4, - FXGPUP0+51, 4, - FXGPUP0+52, 4, - FXGPUP0+53, 4, - FXGPUP0+54, 4, - FXGPUP0+55, 4, - FXGPUP0+56, 4, - FXGPUP0+57, 4, - FXGPUP0+58, 4, - FXGPUP0+59, 2, - FXGPUP0+60 2, -}; - - - -pri_t config_fx_maxumdpri = - sizeof (config_fx_dptbl) / sizeof (fxdpent_t) - 1; - -/* - * Return the address of config_fx_dptbl - */ -fxdpent_t * -fx_getdptbl() -{ - return (config_fx_dptbl); -} - -/* - * Return the address of fx_maxumdpri - */ -pri_t -fx_getmaxumdpri() -{ -/* - * the config_fx_dptbl table. - */ - return (config_fx_maxumdpri); -} -.fi -.in -2 -.sp - -.SH SEE ALSO -\fBpriocntl\fR(1), \fBdispadmin\fR(1M), \fBpriocntl\fR(2), \fBsystem\fR(4) -.sp -.LP -\fISystem Administration Guide, Volume 1, System Interface Guide\fR -.SH NOTES -In order to improve performance under heavy system load, both the \fBnfsd\fR -daemon and the \fBlockd\fR daemon utilize the maximum priority in the \fBFX\fR -class. Unusual \fBfx_dptbl\fR configurations may have significant negative -impact on the performance of the \fBnfsd\fR and \fBlockd\fR daemons. diff --git a/usr/src/man/man4/gateways.4 b/usr/src/man/man4/gateways.4 deleted file mode 100644 index ae4abcf561..0000000000 --- a/usr/src/man/man4/gateways.4 +++ /dev/null @@ -1,501 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 GATEWAYS 4 "May 20, 2009" -.SH NAME -gateways \- configuration file for /usr/sbin/in.routed IPv4 network routing -daemon -.SH SYNOPSIS -.LP -.nf -\fB/etc/gateways\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/etc/gateways\fR file is used by the routing daemon, -\fBin.routed\fR(1M). When the daemon starts, it reads \fB/etc/gateways\fR to -find such distant gateways that cannot be located using only information from a -routing socket, to discover if some of the local gateways are passive, and to -obtain other parameters. -.sp -.LP -The \fB/etc/gateways\fR file consists of a series of lines, each in one of the -two formats shown below or consisting of parameters described later. Blank -lines and lines starting with "\fB#\fR" are treated as comments. -.sp -.LP -One format specifies networks: -.sp -.in +2 -.nf -net Nname[/mask] gateway Gname metric value <passive | active | external> -.fi -.in -2 - -.sp -.LP -The other format specifies hosts: -.sp -.in +2 -.nf -host \fIHname\fR gateway \fIGname\fR metric \fIvalue\fR <passive | active | external> -.fi -.in -2 - -.sp -.LP -Host \fIhname\fR is equivalent to \fBnet \fInname\fR/32\fR. -.sp -.LP -The parameters in the lines shown above are described as follows: -.sp -.ne 2 -.na -\fB\fINname\fR or \fIHname\fR\fR -.ad -.sp .6 -.RS 4n -Name of the destination network or host. It can be a symbolic network name or -an Internet address specified in \fBdot\fR notation (see \fBinet\fR(3SOCKET)). -If it is a name, then it must either be defined in \fB/etc/networks\fR or -\fB/etc/hosts\fR, or a naming service must have been started before -\fBin.routed\fR(1M). -.RE - -.sp -.ne 2 -.na -\fB\fIMask\fR\fR -.ad -.sp .6 -.RS 4n -An optional number between 1 and 32 indicating the netmask associated with -Nname. -.RE - -.sp -.ne 2 -.na -\fB\fIGname\fR\fR -.ad -.sp .6 -.RS 4n -Name or address of the gateway to which RIP responses should be forwarded. -.RE - -.sp -.ne 2 -.na -\fB\fIValue\fR\fR -.ad -.sp .6 -.RS 4n -The hop count to the destination host or network. -.RE - -.sp -.ne 2 -.na -\fB\fBpassive\fR | \fBactive\fR | \fBexternal\fR\fR -.ad -.sp .6 -.RS 4n -One of these keywords must be present to indicate whether the gateway should be -treated as passive or active, or whether the gateway is external to the scope -of the RIP protocol. A passive gateway is not expected to exchange routing -information, while gateways marked active should be willing to exchange RIP -packets. See \fBin.routed\fR(1M) for further details. -.RE - -.sp -.LP -After turning on debugging in \fBin.routed\fR with the \fB-t\fR option, you can -see that lines that follow the format described above create pseudo-interfaces. -To set parameters for remote or external interfaces, use a line starting with -\fBif=alias(\fIHname\fR)\fR, \fBif=remote(\fIHname\fR)\fR, and so forth. -.sp -.LP -For backward compatibility with the previous Solaris \fBin.routed\fR -implementation, three special keyword formats are accepted. If present, these -forms must each be on a separate line, and must not be combined on the same -line with any of the keywords listed elsewhere in this document. These three -forms are: -.sp -.ne 2 -.na -\fB\fBnorip \fIifname\fR\fR\fR -.ad -.RS 19n -Disable all RIP processing on the specified interface. -.RE - -.sp -.ne 2 -.na -\fB\fBnoripin \fIifname\fR\fR\fR -.ad -.RS 19n -Disable the processing of received RIP responses on the specified interface. -.RE - -.sp -.ne 2 -.na -\fB\fBnoripout \fIifname\fR\fR\fR -.ad -.RS 19n -Disable RIP output on the specified interface. -.RE - -.sp -.LP -Lines that start with neither \fBnet\fR nor \fBhost\fR must consist of one or -more of the following parameter settings, separated by commas or blanks: -.sp -.ne 2 -.na -\fB\fB\fR\fBif=\fIifname\fR\fR\fR -.ad -.sp .6 -.RS 4n -Indicates that the other parameters on the line apply only to the interface -name \fIifname\fR. If this parameter is not specified, then other parameters on -the line apply to all interfaces. -.RE - -.sp -.ne 2 -.na -\fB\fBsubnet=\fInname\fR[/\fImask\fR][,\fImetric\fR]\fR\fR -.ad -.sp .6 -.RS 4n -Advertises a route to network nname with mask mask and the supplied metric -(default 1). This is useful for filling \fBholes\fR in CIDR allocations. This -parameter must appear by itself on a line. The network number must specify a -full, 32-bit value, as in \fB192.0.2.0\fR instead of \fB192.0.2\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBripv1_mask=\fInname\fR/\fImask1\fR,\fImask2\fR\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that the netmask of the network of which \fInname\fR/\fImask1\fR is a -subnet should be \fImask2\fR. For example, \fBripv1_mask=192.0.2.16/28,27\fR -marks \fB192.0.2.16/28\fR as a subnet of \fB192.0.2.0/27\fR instead of -\fB192.0.2.0/24\fR. It is better to turn on RIPv2 instead of using this -facility. See the description of \fBripv2_out\fR, below. -.RE - -.sp -.ne 2 -.na -\fB\fBpasswd=\fIXXX\fR[|\fIKeyID\fR[\fIstart\fR|\fIstop\fR]]\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a RIPv2 cleartext password that will be included on all RIPv2 -responses sent, and checked on all RIPv2 responses received. Any blanks, tab -characters, commas, or "\fB#\fR", "\fB|\fR", or NULL characters in the password -must be escaped with a backslash (\fB\e\fR). The common escape sequences -\fB\en\fR, \fB\er\fR, \fB\et\fR, \fB\eb\fR, and \fB\e\fIxxx\fR\fR have their -usual meanings. The \fIKeyID\fR must be unique but is ignored for cleartext -passwords. If present, \fIstart\fR and \fIstop\fR are timestamps in the form -year/month/day@hour:minute. They specify when the password is valid. The valid -password with the longest future is used on output packets, unless all -passwords have expired, in which case the password that expired most recently -is used. If no passwords are valid yet, no password is output. Incoming packets -can carry any password that is valid, will be valid within 24 hours, or that -was valid within 24 hours. To protect password secrecy, the passwd settings are -valid only in the \fB/etc/gateways\fR file and only when that file is readable -only by UID 0. -.RE - -.sp -.ne 2 -.na -\fB\fBmd5_passwd=\fR\fIXXX\fR|\fIKeyID\fR[\fIstart\fR|\fIstop\fR]\fR -.ad -.sp .6 -.RS 4n -Specifies a RIPv2 MD5 password. Except that a KeyID is required, this keyword -is similar to \fBpasswd\fR (described above). -.RE - -.sp -.ne 2 -.na -\fB\fBno_ag\fR\fR -.ad -.sp .6 -.RS 4n -Turns off aggregation of subnets in RIPv1 and RIPv2 responses. -.RE - -.sp -.ne 2 -.na -\fB\fBno_host\fR\fR -.ad -.sp .6 -.RS 4n -Turns off acceptance of host routes. -.RE - -.sp -.ne 2 -.na -\fB\fBno_super_ag\fR\fR -.ad -.sp .6 -.RS 4n -Turns off aggregation of networks into supernets in RIPv2 responses. -.RE - -.sp -.ne 2 -.na -\fB\fBpassive\fR\fR -.ad -.sp .6 -.RS 4n -Marks the interface not to be advertised in updates sent over other interfaces, -and turns off all RIP and router discovery through the interface. -.RE - -.sp -.ne 2 -.na -\fB\fBno_rip\fR\fR -.ad -.sp .6 -.RS 4n -Disables all RIP processing on the specified interface. If no interfaces are -allowed to process RIP packets, \fBin.routed\fR acts purely as a router -discovery daemon. -.sp -Note that turning off RIP without explicitly turning on router discovery -advertisements with \fBrdisc_adv\fR or \fB-s\fR causes \fBin.routed\fR to act -as a client router discovery daemon, which does not advertise. -.RE - -.sp -.ne 2 -.na -\fB\fBno_rip_mcast\fR\fR -.ad -.sp .6 -.RS 4n -Causes RIPv2 packets to be broadcast instead of multicast. -.RE - -.sp -.ne 2 -.na -\fB\fBno_ripv1_in\fR\fR -.ad -.sp .6 -.RS 4n -Causes RIPv1 received responses to be ignored. -.RE - -.sp -.ne 2 -.na -\fB\fBno_ripv2_in\fR\fR -.ad -.sp .6 -.RS 4n -Causes RIPv2 received responses to be ignored. -.RE - -.sp -.ne 2 -.na -\fB\fBripv2_out\fR\fR -.ad -.sp .6 -.RS 4n -Turns on RIPv2 output and causes RIPv2 advertisements to be multicast when -possible. -.RE - -.sp -.ne 2 -.na -\fB\fBripv2\fR\fR -.ad -.sp .6 -.RS 4n -Equivalent to \fBno_ripv1_in\fR and \fBripv2_out\fR. This enables RIPv2 and -disables RIPv1. -.RE - -.sp -.ne 2 -.na -\fB\fBno_rdisc\fR\fR -.ad -.sp .6 -.RS 4n -Disables the Internet Router Discovery Protocol. -.RE - -.sp -.ne 2 -.na -\fB\fBno_solicit\fR\fR -.ad -.sp .6 -.RS 4n -Disables the transmission of Router Discovery Solicitations. -.RE - -.sp -.ne 2 -.na -\fB\fBsend_solicit\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that Router Discovery solicitations should be sent, even on -point-to-point links, which, by default, only listen to Router Discovery -messages. -.RE - -.sp -.ne 2 -.na -\fB\fBno_rdisc_adv\fR\fR -.ad -.sp .6 -.RS 4n -Disables the transmission of Router Discovery Advertisements. -.RE - -.sp -.ne 2 -.na -\fB\fBrdisc_adv\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that Router Discovery Advertisements should be sent, even on -point-to-point links, which by default only listen to Router Discovery -messages. -.RE - -.sp -.ne 2 -.na -\fB\fBbcast_rdisc\fR\fR -.ad -.sp .6 -.RS 4n -Specifies that Router Discovery packets should be broadcast instead of -multicast. -.RE - -.sp -.ne 2 -.na -\fB\fBrdisc_pref=\fIN\fR\fR\fR -.ad -.sp .6 -.RS 4n -Sets the preference in Router Discovery Advertisements to the optionally signed -integer \fIN\fR. The default preference is 0. Default routes with higher or -less negative preferences are preferred by clients. -.RE - -.sp -.ne 2 -.na -\fB\fBrdisc_interval=\fIN\fR\fR\fR -.ad -.sp .6 -.RS 4n -Sets the nominal interval with which Router Discovery Advertisements are -transmitted to \fIN\fR seconds and their lifetime to 3*\fIN\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBfake_default=\fImetric\fR\fR\fR -.ad -.sp .6 -.RS 4n -Has an identical effect to \fB-F\fR \fBnet\fR[/\fImask\fR][=\fImetric\fR] with -the network number and netmask coming from the specified interface. -.RE - -.sp -.ne 2 -.na -\fB\fBpm_rdisc\fR\fR -.ad -.sp .6 -.RS 4n -Similar to \fBfake_default\fR. To prevent RIPv1 listeners from receiving RIPv2 -routes when those routes are multicast, this feature causes a RIPv1 default -route to be broadcast to RIPv1 listeners. Unless modified with -\fBfake_default\fR, the default route is broadcast with a metric of 14. That -serves as a \fBpoor man's router discovery\fR protocol. -.RE - -.sp -.ne 2 -.na -\fB\fBtrust_gateway=\fIrtr_name\fR[|\fInet1\fR/\fImask1\fR|\fInet2\fR/\fImask2\fR|...]\fR\fR -.ad -.sp .6 -.RS 4n -Causes RIP packets from that router and other routers named in other -\fBtrust_gateway\fR keywords to be accepted, and packets from other routers to -be ignored. If networks are specified, then routes to other networks will be -ignored from that router. -.RE - -.sp -.ne 2 -.na -\fB\fBredirect_ok\fR\fR -.ad -.sp .6 -.RS 4n -Causes RIP to allow ICMP Redirect messages when the system is acting as a -router and forwarding packets. Otherwise, ICMP Redirect messages are -overridden. -.RE - -.sp -.ne 2 -.na -\fB\fBrip_neighbor=\fIx.x.x.x\fR\fR\fR -.ad -.sp .6 -.RS 4n -By default, RIPv1 advertisements over point-to-point links are sent to the -peer's address (255.255.255.255, if none is available), and RIPv2 -advertisements are sent to either the RIP multicast address or the peer's -address if \fBno_rip_mcast\fR is set. This option overrides those defaults and -configures a specific address to use on the indicated interface. This can be -used to set a broadcast type advertisement on a point-to-point link. -.RE - -.SH SEE ALSO -.sp -.LP -\fBin.routed\fR(1M), \fBroute\fR(1M), \fBrtquery\fR(1M), \fBinet\fR(3SOCKET), -.sp -.LP -\fIInternet Transport Protocols, XSIS 028112, Xerox System Integration -Standard\fR diff --git a/usr/src/man/man4/group.4 b/usr/src/man/man4/group.4 deleted file mode 100644 index 025c936b78..0000000000 --- a/usr/src/man/man4/group.4 +++ /dev/null @@ -1,161 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright 1989 AT&T -.\" 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 GROUP 4 "Feb 25, 2017" -.SH NAME -group \- group file -.SH DESCRIPTION -.LP -The \fBgroup\fR file is a local source of group information. The \fBgroup\fR -file can be used in conjunction with other group sources, including the -\fBNIS\fR maps \fBgroup.byname\fR and \fBgroup.bygid\fR, or group information -stored on an LDAP server. Programs use the -\fBgetgrnam\fR(3C) routines to access this information. -.sp -.LP -The \fBgroup\fR file contains a one-line entry for each group recognized by the -system, of the form: -.sp -.LP -\fIgroupname\fR:\fIpassword\fR: \fIgid\fR:\fIuser-list\fR -.sp -.LP -where -.sp -.ne 2 -.na -\fB\fIgroupname\fR\fR -.ad -.RS 13n -The name of the group. A string consisting of lower case alphabetic characters -and numeric characters. Neither a colon (\fB:\fR) nor a NEWLINE can be part of -a \fIgroupname\fR. The string must be less than \fBMAXGLEN-1\fR, usually -\fB8\fR, characters long. -.RE - -.sp -.ne 2 -.na -\fB\fIgid\fR\fR -.ad -.RS 13n -The group's unique numerical ID (GID) within the system. -.RE - -.sp -.ne 2 -.na -\fB\fIuser-list\fR\fR -.ad -.RS 13n -A comma-separated list of users allowed in the group. -.RE - -.sp -.LP -The maximum value of the \fIgid\fR field is 2147483647. To maximize -interoperability and compatibility, administrators are recommended to assign -groups using the range of GIDs below 60000 where possible. -.sp -.LP -If the password field is empty, no password is demanded. During user -identification and authentication, the supplementary group access list is -initialized sequentially from information in this file. If a user is in more -groups than the system is configured for, \fB{NGROUPS_MAX}\fR, a warning will -be given and subsequent group specifications will be ignored. -.sp -.LP -Malformed entries cause routines that read this file to halt, in which case -group assignments specified further along are never made. To prevent this from -happening, use \fBgrpck\fR(1B) to check the \fB/etc/group\fR database from time -to time. -.sp -.LP -If the number of characters in an entry exceeds 2047, group maintenance -commands, such as \fBgroupdel\fR(1M) and \fBgroupmod\fR(1M), fail. -.sp -.LP -Previous releases used a group entry beginning with a `\fB+\fR' (plus sign) or -`\fB\(mi\fR\&' (minus sign) to selectively incorporate entries from a naming -service source (for example, an NIS map or data from an LDAP server) for group. -If still required, this is supported by specifying \fBgroup:compat\fR in -\fBnsswitch.conf\fR(4). The \fBcompat\fR source may not be supported in future -releases. Possible sources are \fBfiles\fR followed by \fBldap\fR. -This has the effect of incorporating information from an LDAP -server after the \fBgroup\fR file. -.SH EXAMPLES -.LP -\fBExample 1 \fRExample \fBgroup\fR File. -.sp -.LP -The following is an example of a \fBgroup\fR file: - -.sp -.in +2 -.nf -\fBroot::0:root -stooges:q.mJzTnu8icF.:10:larry,moe,curly\fR -.fi -.in -2 -.sp - -.sp -.LP -and the sample group entry from \fBnsswitch.conf\fR: - -.sp -.in +2 -.nf -\fBgroup: files ldap\fR -.fi -.in -2 -.sp - -.sp -.LP -With these entries, the group \fBstooges\fR will have members \fBlarry\fR, -\fBmoe\fR, and \fBcurly\fR, and all groups listed on the LDAP server are -effectively incorporated after the entry for \fBstooges\fR. - -.sp -.LP -If the \fBgroup\fR file was: - -.sp -.in +2 -.nf -root::0:root -stooges:q.mJzTnu8icF.:10:larry,moe,curly -+: -.fi -.in -2 -.sp - -.sp -.LP -and the group entry from \fBnsswitch.conf\fR: - -.sp -.in +2 -.nf -\fBgroup: compat\fR -.fi -.in -2 -.sp - -.sp -.LP -all the groups listed in the \fBNIS\fR \fBgroup.bygid\fR and \fBgroup.byname\fR -maps would be effectively incorporated after the entry for stooges. - -.SH SEE ALSO -.LP -\fBgroups\fR(1), \fBgrpck\fR(1B), \fBnewgrp\fR(1), \fBgroupadd\fR(1M), -\fBgroupdel\fR(1M), \fBgroupmod\fR(1M), \fBgetgrnam\fR(3C), -\fBinitgroups\fR(3C), \fBnsswitch.conf\fR(4), \fBunistd.h\fR(3HEAD) -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR diff --git a/usr/src/man/man4/gsscred.conf.4 b/usr/src/man/man4/gsscred.conf.4 deleted file mode 100644 index d8764f1f14..0000000000 --- a/usr/src/man/man4/gsscred.conf.4 +++ /dev/null @@ -1,64 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 GSSCRED.CONF 4 "Mar 17, 2004" -.SH NAME -gsscred.conf \- Generic Security Services credential configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/gss/gsscred.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBgsscred.conf\fR file contains GSS credential information including -options that can be set by the system administrator. -.sp -.LP -The options that are in this file include: -.sp -.in +2 -.nf -SYSLOG_UID_MAPPING=yes -.fi -.in -2 - -.sp -.LP -If this option is set to \fByes\fR, GSS cred to Unix cred mapping results will -be logged to \fBsyslog\fR(3C) at level \fBauth.debug\fR. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/gss/gsscred.conf\fR\fR -.ad -.RS 25n -Contains GSS credential information. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBgsscred\fR(1M), \fBgssd\fR(1M), \fBsyslog\fR(3C), \fBkrb5.conf\fR(4), -\fBattributes\fR(5), \fBkerberos\fR(5) diff --git a/usr/src/man/man4/hba.conf.4 b/usr/src/man/man4/hba.conf.4 deleted file mode 100644 index a6434e19dd..0000000000 --- a/usr/src/man/man4/hba.conf.4 +++ /dev/null @@ -1,104 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 HBA.CONF 4 "Sep 4, 2003" -.SH NAME -hba.conf \- configuration file for the HBAAPI library -.SH DESCRIPTION -.sp -.LP -The \fB/etc/hba.conf\fR file is used to specify the Vendor-Specific Libraries -that are installed on the system. This file is used by the Common Library to -load the individual VSLs when \fBHBA_LoadLibrary\fR(3HBAAPI) is called. If -changes are made to the file while the library is in use, the library should be -freed and reloaded. A version 1 VSL is compatible only with a version 1 Common -Library. A version 2 VSL is compatible with both a version 1 and a version 2 -Common Library. -.sp -.LP -Each VSL entry is a single line of the form: -.sp -.in +2 -.nf -"name" "library path" -.fi -.in -2 - -.sp -.LP -where: -.sp -.ne 2 -.na -\fB\fIname\fR\fR -.ad -.RS 16n -is the description of library. The library name should be prepended with the -domain of the manufacturer of the library. -.RE - -.sp -.ne 2 -.na -\fB\fIlibrary path\fR\fR -.ad -.RS 16n -is the absolute path to the shared object library file. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRContents of \fB/etc/hba.conf\fR -.sp -.in +2 -.nf -# -# This file contains names and references to HBA libraries -# -# Format: -# -# <library name> <library pathname> -# -# The library name should be prepended with the domain of -# the manufacturer or driver author. -com.sun.fchba32 /usr/lib/libsun_fc.so.1 -com.sun.fchba64 /usr/lib/sparcv9/libsun_fc.so.1 -.fi -.in -2 - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Standard: FC-MI 1.92 (API version 1) -_ - T{ -Standard: FC-HBA Version 4 (API version 2) -T} -.TE - -.SH SEE ALSO -.sp -.LP -\fBHBA_LoadLibrary\fR(3HBAAPI), \fBlibhbaapi\fR(3LIB), \fBattributes\fR(5) -.SH BUGS -.sp -.LP -The HBAAPI is provided in both 32- and 64-bit versions, but only one -configuration file is specified. As a result, both 32- and 64-bit VSL libraries -must be specified within the same file. When using the 32-bit Common Library, -the 64-bit VSLs will fail to load. When using the 64-bit Common Library, the -32-bit VSLs will fail to load. These failures are silently ignored by the -Common Library during normal usage, but can result in warning messages when -running client applications in a debugger. diff --git a/usr/src/man/man4/holidays.4 b/usr/src/man/man4/holidays.4 deleted file mode 100644 index 2e86b41cb2..0000000000 --- a/usr/src/man/man4/holidays.4 +++ /dev/null @@ -1,94 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. -.\" 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 HOLIDAYS 4 "Aug 18, 2008" -.SH NAME -holidays \- prime/nonprime table for the accounting system -.SH SYNOPSIS -.LP -.nf -\fB/etc/acct/holidays\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/etc/acct/holidays\fR file specifies prime time hours and holidays. -Holidays and weekends are considered non-prime time hours. -.sp -.LP -\fB/etc/acct/holidays\fR is used by the accounting system. -.sp -.LP -All lines beginning with an \fB*\fR are comments. -.sp -.LP -The \fB/etc/acct/holidays\fR file consists of two sections. The first -non-comment line defines the current year and the start time of prime and -non-prime time hours, in the form of: -.sp -.in +2 -.nf -\fIcurrent_year\fR \fIprime_start\fR \fInon_prime_start\fR -.fi -.in -2 - -.sp -.LP -Specify \fIprime_start\fR and \fInon_prime_start\fR times in the range of -\fB0000\fR to \fB2400\fR. -.sp -.LP -The remaining non-comment lines define the holidays in the form of: -.sp -.in +2 -.nf -\fImonth/day\fR \fIcompany_holiday\fR -.fi -.in -2 - -.sp -.LP -Of these two fields, only the \fImonth/day\fR is actually used by the -accounting system programs. -.sp -.LP -The \fB/etc/acct/holidays\fR file must be updated every year. -.SH EXAMPLES -.LP -\fBExample 1 \fRAn Example of the \fB/etc/acct/holidays\fR File -.sp -.LP -The following is an example of the \fB/etc/acct/holidays\fR file: - -.sp -.in +2 -.nf -* Prime/Nonprime Table for the accounting system -* -* Curr Prime Non-Prime -* Year Start Start -* - 1991 0830 1800 -* -* only the first column (month/day) is significant. -* -* month/day Company Holiday -* - 1/1 New Years Day - 5/30 Memorial Day - 7/4 Indep. Day - 9/5 Labor Day - 11/24 Thanksgiving Day - 11/25 day after Thanksgiving - 12/25 Christmas - 12/26 day after Christmas -.fi -.in -2 - -.SH SEE ALSO -.sp -.LP -\fBacct\fR(1M) diff --git a/usr/src/man/man4/hosts.4 b/usr/src/man/man4/hosts.4 deleted file mode 100644 index d8c36d4e49..0000000000 --- a/usr/src/man/man4/hosts.4 +++ /dev/null @@ -1,177 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1988, 1995 Sun Microsystems, Inc. All Rights Reserved. -.\" 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 HOSTS 4 "Feb 25, 2017" -.SH NAME -hosts \- host name database -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/hosts\fR -.fi - -.LP -.nf -\fB/etc/hosts\fR -.fi - -.LP -.nf -\fB/etc/inet/ipnodes\fR -.fi - -.SH DESCRIPTION -.LP -The \fBhosts\fR file is a local database that associates the names of hosts -with their Internet Protocol (IP) addresses. An IP address can be in either -IPv4 or IPv6 format. The \fBhosts\fR file can be used in conjunction with, or -instead of, other hosts databases, including the Domain Name System (DNS), the -NIS \fBhosts\fR map, or information from an LDAP -server. Programs use library interfaces to access information in the -\fBhosts\fR file. -.sp -.LP -Note that \fB/etc/hosts\fR and \fB/etc/inet/ipnodes\fR are symbolic links to -\fB/etc/inet/hosts\fR. -.sp -.LP -The \fBhosts\fR file has one entry for each IP address of each host. If a host -has more than one IP address, it will have one entry for each, on consecutive -lines. The format of each line is: -.sp -.LP -\fIIP-address\fR \fIofficial-host-name\fR \fInicknames\|.\|.\|\fR. -.sp -.LP -Items are separated by any number of \fBSPACE\fR and/or \fBTAB\fR characters. -The first item on a line is the host's IP address. The second entry is the -host's official name. Subsequent entries on the same line are alternative names -for the same machine, or "nicknames." Nicknames are optional. -.sp -.LP -For a host with more than one IP address, consecutive entries for these -addresses may contain the same or differing nicknames. Different nicknames are -useful for assigning distinct names to different addresses. -.sp -.LP -A call to \fBgethostbyname\fR(3NSL) returns a \fBhostent\fR structure -containing the union of all IPv4 addresses and nicknames from each line -containing a matching official name or nickname. A call to -\fBgetipnodebyname\fR(3SOCKET) is similar, but is capable of returning -\fBhostent\fR structures containing IPv4 and IPv6 addresses. Applications might -prefer to use the address-family independent \fBgetaddrinfo\fR(3SOCKET) API for -name-to-address lookups. -.sp -.LP -A `\fB#\fR' indicates the beginning of a comment; characters up to the end of -the line are not interpreted by routines that search the file. -.sp -.LP -Network addresses are written in one of two ways: -.RS +4 -.TP -.ie t \(bu -.el o -The conventional "decimal dot" notation and interpreted using the -\fBinet_addr\fR routine from the Internet address manipulation library, -\fBinet\fR(3SOCKET). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The IP Version 6 protocol [IPV6], defined in RFC 1884 and interpreted using the -\fBinet_pton()\fR routine from the Internet address manipulation library. See -\fBinet\fR(3SOCKET). -.RE -.sp -.LP -This interface supports node names as defined in Internet RFC 952, which -states: -.sp -.LP -A "name" (Net, Host, Gateway, or Domain name) is a text string up to 24 -characters drawn from the alphabet (A-Z), digits (0-9), minus sign (\(mi), and -period (.). Note that periods are only allowed when they serve to delimit -components of "domain style names". (See RFC 921, "Domain Name System -Implementation Schedule," for background). No blank or space characters are -permitted as part of a name. No distinction is made between uppercase and -lowercase. The first character must be an alpha character [or a digit. (RFC -1123 relaxed RFC 952's limitation of the first character to only alpha -characters.)] The last character must not be a minus sign or period. -.sp -.LP -Host names must not consist of numbers only. A host name must contain at least -one alphabetical or special character. -.sp -.LP -Although the interface accepts host names longer than 24 characters for the -host portion (exclusive of the domain component), choosing names for hosts that -adhere to the 24 character restriction will insure maximum interoperability on -the Internet. -.sp -.LP -A host which serves as a GATEWAY should have "\(miGATEWAY" or "\(miGW" as part -of its name. Hosts which do not serve as Internet gateways should not use -"\(miGATEWAY" and "\(miGW" as part of their names. A host which is a TAC should -have "\(miTAC" as the last part of its host name, if it is a DoD host. Single -character names or nicknames are not allowed. -.SH EXAMPLES -.LP -\fBExample 1 \fRExample \fBhosts\fR File Entry -.sp -.LP -The following is a typical line from the \fBhosts\fR file: - -.sp -.in +2 -.nf -192.9.1.20 gaia # John Smith -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRExample IPv6 Address Entry -.sp -.LP -The following is an example of an IPv6 \fBhosts\fR entry: - -.sp -.in +2 -.nf -2001:0db8:3c4d:55:a00:20ff:fe8e:f3ad myhost # John Smith -.fi -.in -2 -.sp - -.SH SEE ALSO -.LP -\fBgethostbyname\fR(3NSL), \fBgetipnodebyname\fR(3SOCKET), \fBinet\fR(3SOCKET), -\fBnsswitch.conf\fR(4), \fBresolv.conf\fR(4) -.sp -.LP -Braden, B., editor, RFC 1123, \fIRequirements for Internet Hosts - Application -and Support\fR, Network Working Group, October, 1989. -.sp -.LP -Harrenstien, K., Stahl, M., and Feinler, E., RFC 952, \fIDOD Internet Host -Table Specification\fR, Network Working Group, October 1985. -.sp -.LP -Hinden, R., and Deering, S., editors, RFC 1884, \fIIP Version 6 Addressing -Architecture\fR, Network Working Group, December, 1995. -.sp -.LP -Postel, Jon, RFC 921, \fIDomain Name System Implementation Schedule -(Revised)\fR, Network Working Group, October 1984. -.SH NOTES -.LP -\fB/etc/inet/hosts\fR is the official SVR4 name of the \fBhosts\fR file. The -symbolic link \fB/etc/hosts\fR exists for \fBBSD\fR compatibility. -.sp -.LP -The symbolic link \fB/etc/net/ipnodes\fR exists for backwards compatibility -with previous Solaris releases. diff --git a/usr/src/man/man4/hosts.equiv.4 b/usr/src/man/man4/hosts.equiv.4 deleted file mode 100644 index 81679a1aa8..0000000000 --- a/usr/src/man/man4/hosts.equiv.4 +++ /dev/null @@ -1,331 +0,0 @@ -'\" te -.\" Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright 1989 AT&T -.\" 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 HOSTS.EQUIV 4 "Nov 26, 2017" -.SH NAME -hosts.equiv, rhosts \- trusted remote hosts and users -.SH DESCRIPTION -.LP -The \fB/etc/hosts.equiv\fR and \fB\&.rhosts\fR files provide the "remote -authentication" database for \fBrlogin\fR(1), \fBrsh\fR(1), \fBrcp\fR(1), and -\fBrcmd\fR(3SOCKET). The files specify remote hosts and users that are -considered "trusted". Trusted users are allowed to access the local system -without supplying a password. The library routine \fBruserok()\fR (see -\fBrcmd\fR(3SOCKET)) performs the authentication procedure for programs by -using the \fB/etc/hosts.equiv\fR and \fB\&.rhosts\fR files. The -\fB/etc/hosts.equiv\fR file applies to the entire system, while individual -users can maintain their own \fB\&.rhosts\fR files in their home directories. -.sp -.LP -These files bypass the standard password-based user authentication mechanism. -To maintain system security, care must be taken in creating and maintaining -these files. -.sp -.LP -The remote authentication procedure determines whether a user from a remote -host should be allowed to access the local system with the identity of a local -user. This procedure first checks the \fB/etc/hosts.equiv\fR file and then -checks the \fB\&.rhosts\fR file in the home directory of the local user who is -requesting access. Entries in these files can be of two forms. Positive entries -allow access, while negative entries deny access. The authentication succeeds -when a matching positive entry is found. The procedure fails when the first -matching negative entry is found, or if no matching entries are found in either -file. The order of entries is important. If the files contain both positive and -negative entries, the entry that appears first will prevail. The \fBrsh\fR(1) -and \fBrcp\fR(1) programs fail if the remote authentication procedure fails. -The \fBrlogin\fR program falls back to the standard password-based login -procedure if the remote authentication fails. -.sp -.LP -Both files are formatted as a list of one-line entries. Each entry has the -form: -.sp -.in +2 -.nf -\fIhostname\fR [\fIusername\fR] -.fi -.in -2 -.sp - -.sp -.LP -Hostnames must be the official name of the host, not one of its nicknames. -.sp -.LP -Negative entries are differentiated from positive entries by a `\(mi' character -preceding either the \fIhostname\fR or \fIusername\fR field. -.SS "Positive Entries" -.LP -If the form: -.sp -.in +2 -.nf -\fIhostname\fR -.fi -.in -2 -.sp - -.sp -.LP -is used, then users from the named host are trusted. That is, they may access -the system with the same user name as they have on the remote system. This form -may be used in both the \fB/etc/hosts.equiv\fR and \fB\&.rhosts\fR files. -.sp -.LP -If the line is in the form: -.sp -.in +2 -.nf -\fIhostname\fR \fIusername\fR -.fi -.in -2 -.sp - -.sp -.LP -then the named user from the named host can access the system. This form may be -used in individual \fB\&.rhosts\fR files to allow remote users to access the -system \fIas a different local user\fR. If this form is used in the -\fB/etc/hosts.equiv\fR file, the named remote user will be allowed to access -the system as \fBany\fR local user. -.sp -.LP -\fBnetgroup\fR(4) can be used in either the \fIhostname\fR or \fIusername\fR -fields to match a number of hosts or users in one entry. The form: -.sp -.in +2 -.nf -\fB+@\fR\fInetgroup\fR -.fi -.in -2 -.sp - -.sp -.LP -allows access from all hosts in the named netgroup. When used in the -\fIusername\fR field, netgroups allow a group of remote users to access the -system as a particular local user. The form: -.sp -.in +2 -.nf -\fIhostname\fR \fB+@\fR\fInetgroup\fR -.fi -.in -2 -.sp - -.sp -.LP -allows all of the users in the named netgroup from the named host to access the -system as the local user. The form: -.sp -.in +2 -.nf -\fB+@\fR\fInetgroup1\fR \fB+@\fR\fInetgroup2\fR -.fi -.in -2 -.sp - -.sp -.LP -allows the users in \fInetgroup2\fR from the hosts in \fInetgroup1\fR to access -the system as the local user. -.sp -.LP -The special character `+' can be used in place of either \fIhostname\fR or -\fIusername\fR to match any host or user. For example, the entry -.sp -.in +2 -.nf -\fB+\fR -.fi -.in -2 -.sp - -.sp -.LP -will allow a user from any remote host to access the system with the same -username. The entry -.sp -.in +2 -.nf -\fB+\fR \fIusername\fR -.fi -.in -2 -.sp - -.sp -.LP -will allow the named user from any remote host to access the system. The entry -.sp -.in +2 -.nf -\fIhostname\fR \fB+\fR -.fi -.in -2 -.sp - -.sp -.LP -will allow any user from the named host to access the system as the local user. -.SS "Negative Entries" -.LP -Negative entries are preceded by a `\(mi' sign. The form: -.sp -.in +2 -.nf -\fB\(mi\fR\fIhostname\fR -.fi -.in -2 -.sp - -.sp -.LP -will disallow all access from the named host. The form: -.sp -.in +2 -.nf -\fB\(mi@\fR\fInetgroup\fR -.fi -.in -2 -.sp - -.sp -.LP -means that access is explicitly disallowed from all hosts in the named -netgroup. The form: -.sp -.in +2 -.nf -\fIhostname\fR \fB\(mi\fR\fIusername\fR -.fi -.in -2 -.sp - -.sp -.LP -disallows access by the named user only from the named host, while the form: -.sp -.in +2 -.nf -\fB+ \(mi@\fR\fInetgroup\fR -.fi -.in -2 -.sp - -.sp -.LP -will disallow access by all of the users in the named netgroup from all hosts. -.SS "Search Sequence" -.LP -To help maintain system security, the \fB/etc/hosts.equiv\fR file is not -checked when access is being attempted for super-user. If the user attempting -access is not the super-user, \fB/etc/hosts.equiv\fR is searched for lines of -the form described above. Checks are made for lines in this file in the -following order: -.RS +4 -.TP -1. -\fB+\fR -.RE -.RS +4 -.TP -2. -\fB+@\fR\fInetgroup\fR -.RE -.RS +4 -.TP -3. -\fB\(mi@\fR\fInetgroup\fR -.RE -.RS +4 -.TP -4. -\fB\(mi\fR\fIhostname\fR -.RE -.RS +4 -.TP -5. -\fIhostname\fR -.RE -.sp -.LP -The user is granted access if a positive match occurs. Negative entries apply -only to \fB/etc/hosts.equiv\fR and may be overridden by subsequent -\fB\&.rhosts\fR entries. -.sp -.LP -If no positive match occurred, the \fB\&.rhosts\fR file is then searched if the -user attempting access maintains such a file. This file is searched whether or -not the user attempting access is the super-user. As a security feature, the -\fB\&.rhosts\fR file must be owned by the user who is attempting access. Checks -are made for lines in \fB\&.rhosts\fR in the following order: -.RS +4 -.TP -1. -\fB+\fR -.RE -.RS +4 -.TP -2. -\fB+@\fR\fInetgroup\fR -.RE -.RS +4 -.TP -3. -\fB\(mi@\fR\fInetgroup\fR -.RE -.RS +4 -.TP -4. -\fB\(mi\fR\fIhostname\fR -.RE -.RS +4 -.TP -5. -\fIhostname\fR -.RE -.SH FILES -.ne 2 -.na -\fB\fB/etc/hosts.equiv\fR\fR -.ad -.RS 20n -system trusted hosts and users -.RE - -.sp -.ne 2 -.na -\fB\fB~/.rhosts\fR\fR -.ad -.RS 20n -user's trusted hosts and users -.RE - -.SH SEE ALSO -.LP -\fBrcp\fR(1), \fBrlogin\fR(1), \fBrsh\fR(1), \fBrcmd\fR(3SOCKET), -\fBhosts\fR(4), \fBnetgroup\fR(4), \fBpasswd\fR(4) -.SH WARNINGS -.LP -Positive entries in \fB/etc/hosts.equiv\fR that include a \fIusername\fR field -(either an individual named user, a netgroup, or `\fB+\fR' sign) should be -used with extreme caution. Because \fB/etc/hosts.equiv\fR applies system-wide, -these entries allow one, or a group of, remote users to access the system -\fBas any local user\fR. This can be a security hole. For example, because of -the search sequence, an \fB/etc/hosts.equiv\fR file consisting of the entries -.sp -.in +2 -.nf -\fB+ -\(mihostxxx\fR -.fi -.in -2 -.sp - -.sp -.LP -will not deny access to "hostxxx". diff --git a/usr/src/man/man4/hosts_access.4 b/usr/src/man/man4/hosts_access.4 deleted file mode 100644 index ebeaa7f513..0000000000 --- a/usr/src/man/man4/hosts_access.4 +++ /dev/null @@ -1,399 +0,0 @@ -'\" t -.\" -.\" Modified for Solaris to to add the Solaris stability classification, -.\" and to add a note about source availability. -.\" -.TH HOSTS_ACCESS 4 "May 13, 2017" -.SH NAME -hosts_access \- format of host access control files -.SH DESCRIPTION -This manual page describes a simple access control language that is -based on client (host name/address, user name), and server (process -name, host name/address) patterns. Examples are given at the end. The -impatient reader is encouraged to skip to the EXAMPLES section for a -quick introduction. -.PP -An extended version of the access control language is described in the -\fIhosts_options\fR(4) document. The extensions are turned on at -program build time by building with -DPROCESS_OPTIONS. -.PP -In the following text, \fIdaemon\fR is the process name of a -network daemon process, and \fIclient\fR is the name and/or address of -a host requesting service. Network daemon process names are specified -in the inetd configuration file. -.SH ACCESS CONTROL FILES -The access control software consults two files. The search stops -at the first match: -.IP \(bu -Access will be granted when a (daemon,client) pair matches an entry in -the \fI/etc/hosts.allow\fR file. -.IP \(bu -Otherwise, access will be denied when a (daemon,client) pair matches an -entry in the \fI/etc/hosts.deny\fR file. -.IP \(bu -Otherwise, access will be granted. -.PP -A non-existing access control file is treated as if it were an empty -file. Thus, access control can be turned off by providing no access -control files. -.SH ACCESS CONTROL RULES -Each access control file consists of zero or more lines of text. These -lines are processed in order of appearance. The search terminates when a -match is found. -.IP \(bu -A newline character is ignored when it is preceded by a backslash -character. This permits you to break up long lines so that they are -easier to edit. -.IP \(bu -Blank lines or lines that begin with a `#\' character are ignored. -This permits you to insert comments and whitespace so that the tables -are easier to read. -.IP \(bu -All other lines should satisfy the following format, things between [] -being optional: -.sp -daemon_list : client_list [ : shell_command ] -.PP -\fIdaemon_list\fR is a list of one or more daemon process names -(argv[0] values) or wildcards (see below). -.PP -\fIclient_list\fR is a list -of one or more host names, host addresses, patterns or wildcards (see -below) that will be matched against the client host name or address. -.PP -The more complex forms \fIdaemon@host\fR and \fIuser@host\fR are -explained in the sections on server endpoint patterns and on client -username lookups, respectively. -.PP -List elements should be separated by blanks and/or commas. -.PP -With the exception of NIS (YP) netgroup lookups, all access control -checks are case insensitive. -.ne 4 -.SH HOST ADDRESSES -IPv4 client addresses can be denoted in their usual dotted notation, i.e. -x.x.x.x, but IPv6 addresses require a square brace around them - e.g. -[::1]. -.SH PATTERNS -The access control language implements the following patterns: -.IP \(bu -A string that begins with a `.\' character. A host name is matched if -the last components of its name match the specified pattern. For -example, the pattern `.tue.nl\' matches the host name -`wzv.win.tue.nl\'. -.IP \(bu -A string that ends with a `.\' character. A host address is matched if -its first numeric fields match the given string. For example, the -pattern `131.155.\' matches the address of (almost) every host on the -Eind\%hoven University network (131.155.x.x). -.IP \(bu -A string that begins with an `@\' character is treated as an NIS -(formerly YP) netgroup name. A host name is matched if it is a host -member of the specified netgroup. Netgroup matches are not supported -for daemon process names or for client user names. -.IP \(bu -An expression of the form `n.n.n.n/m.m.m.m\' is interpreted as a -`net/mask\' pair. A host address is matched if `net\' is equal to the -bitwise AND of the address and the `mask\'. For example, the net/mask -pattern `131.155.72.0/255.255.254.0\' matches every address in the -range `131.155.72.0\' through `131.155.73.255\'. -.IP \(bu -Prefixes can be specified for IPv6 address, e.g. [2001:DB8::/32] -.SH WILDCARDS -The access control language supports explicit wildcards: -.IP ALL -The universal wildcard, always matches. -.IP LOCAL -Matches any host whose name does not contain a dot character. -.IP UNKNOWN -Matches any user whose name is unknown, and matches any host whose name -\fIor\fR address are unknown. This pattern should be used with care: -host names may be unavailable due to temporary name server problems. A -network address will be unavailable when the software cannot figure out -what type of network it is talking to. -.IP KNOWN -Matches any user whose name is known, and matches any host whose name -\fIand\fR address are known. This pattern should be used with care: -host names may be unavailable due to temporary name server problems. A -network address will be unavailable when the software cannot figure out -what type of network it is talking to. -.IP PARANOID -Matches any host whose name does not match its address. When tcpd is -built with -DPARANOID (default mode), it drops requests from such -clients even before looking at the access control tables. Build -without -DPARANOID when you want more control over such requests. -.ne 6 -.SH OPERATORS -.IP EXCEPT -Intended use is of the form: `list_1 EXCEPT list_2\'; this construct -matches anything that matches \fIlist_1\fR unless it matches -\fIlist_2\fR. The EXCEPT operator can be used in daemon_lists and in -client_lists. The EXCEPT operator can be nested: if the control -language would permit the use of parentheses, `a EXCEPT b EXCEPT c\' -would parse as `(a EXCEPT (b EXCEPT c))\'. -.br -.ne 6 -.SH SHELL COMMANDS -If the first-matched access control rule contains a shell command, that -command is subjected to %<letter> substitutions (see next section). -The result is executed by a \fI/bin/sh\fR child process with standard -input, output and error connected to \fI/dev/null\fR. Specify an `&\' -at the end of the command if you do not want to wait until it has -completed. -.PP -Shell commands should not rely on the PATH setting of the inetd. -Instead, they should use absolute path names, or they should begin with -an explicit PATH=whatever statement. -.PP -The \fIhosts_options\fR(4) document describes an alternative language -that uses the shell command field in a different and incompatible way. -.SH % EXPANSIONS -The following expansions are available within shell commands: -.IP "%a (%A)" -The client (server) host address. -.IP %c -Client information: user@host, user@address, a host name, or just an -address, depending on how much information is available. -.IP %d -The daemon process name (argv[0] value). -.IP "%h (%H)" -The client (server) host name or address, if the host name is -unavailable. -.IP "%n (%N)" -The client (server) host name (or "unknown" or "paranoid"). -.IP %p -The daemon process id. -.IP %s -Server information: daemon@host, daemon@address, or just a daemon name, -depending on how much information is available. -.IP %u -The client user name (or "unknown"). -.IP %% -Expands to a single `%\' character. -.PP -Characters in % expansions that may confuse the shell are replaced by -underscores. -.SH SERVER ENDPOINT PATTERNS -In order to distinguish clients by the network address that they -connect to, use patterns of the form: -.sp -process_name@host_pattern : client_list ... -.sp -Patterns like these can be used when the machine has different internet -addresses with different internet hostnames. Service providers can use -this facility to offer FTP, GOPHER or WWW archives with internet names -that may even belong to different organizations. See also the `twist' -option in the hosts_options(4) document. Some systems (Solaris, -FreeBSD) can have more than one internet address on one physical -interface; with other systems you may have to resort to SLIP or PPP -pseudo interfaces that live in a dedicated network address space. -.sp -The host_pattern obeys the same syntax rules as host names and -addresses in client_list context. Usually, server endpoint information -is available only with connection-oriented services. -.SH CLIENT USERNAME LOOKUP -When the client host supports the RFC 931 protocol or one of its -descendants (TAP, IDENT, RFC 1413) the wrapper programs can retrieve -additional information about the owner of a connection. Client username -information, when available, is logged together with the client host -name, and can be used to match patterns like: -.PP -daemon_list : ... user_pattern@host_pattern ... -.PP -The daemon wrappers can be configured at compile time to perform -rule-driven username lookups (default) or to always interrogate the -client host. In the case of rule-driven username lookups, the above -rule would cause username lookup only when both the \fIdaemon_list\fR -and the \fIhost_pattern\fR match. -.PP -A user pattern has the same syntax as a daemon process pattern, so the -same wildcards apply (netgroup membership is not supported). One -should not get carried away with username lookups, though. -.IP \(bu -The client username information cannot be trusted when it is needed -most, i.e. when the client system has been compromised. In general, -ALL and (UN)KNOWN are the only user name patterns that make sense. -.IP \(bu -Username lookups are possible only with TCP-based services, and only -when the client host runs a suitable daemon; in all other cases the -result is "unknown". -.IP \(bu -A well-known UNIX kernel bug may cause loss of service when username -lookups are blocked by a firewall. The wrapper README document -describes a procedure to find out if your kernel has this bug. -.IP \(bu -Username lookups may cause noticeable delays for non-UNIX users. The -default timeout for username lookups is 10 seconds: too short to cope -with slow networks, but long enough to irritate PC users. -.PP -Selective username lookups can alleviate the last problem. For example, -a rule like: -.PP -daemon_list : @pcnetgroup ALL@ALL -.PP -would match members of the pc netgroup without doing username lookups, -but would perform username lookups with all other systems. -.SH DETECTING ADDRESS SPOOFING ATTACKS -A flaw in the sequence number generator of many TCP/IP implementations -allows intruders to easily impersonate trusted hosts and to break in -via, for example, the remote shell service. The IDENT (RFC931 etc.) -service can be used to detect such and other host address spoofing -attacks. -.PP -Before accepting a client request, the wrappers can use the IDENT -service to find out that the client did not send the request at all. -When the client host provides IDENT service, a negative IDENT lookup -result (the client matches `UNKNOWN@host') is strong evidence of a host -spoofing attack. -.PP -A positive IDENT lookup result (the client matches `KNOWN@host') is -less trustworthy. It is possible for an intruder to spoof both the -client connection and the IDENT lookup, although doing so is much -harder than spoofing just a client connection. It may also be that -the client\'s IDENT server is lying. -.PP -Note: IDENT lookups don\'t work with UDP services. -.SH EXAMPLES -The language is flexible enough that different types of access control -policy can be expressed with a minimum of fuss. Although the language -uses two access control tables, the most common policies can be -implemented with one of the tables being trivial or even empty. -.PP -When reading the examples below it is important to realize that the -allow table is scanned before the deny table, that the search -terminates when a match is found, and that access is granted when no -match is found at all. -.PP -The examples use host and domain names. They can be improved by -including address and/or network/netmask information, to reduce the -impact of temporary name server lookup failures. -.SH MOSTLY CLOSED -In this case, access is denied by default. Only explicitly authorized -hosts are permitted access. -.PP -The default policy (no access) is implemented with a trivial deny -file: -.PP -.ne 2 -/etc/hosts.deny: -.in +3 -ALL: ALL -.PP -This denies all service to all hosts, unless they are permitted access -by entries in the allow file. -.PP -The explicitly authorized hosts are listed in the allow file. -For example: -.PP -.ne 2 -/etc/hosts.allow: -.in +3 -ALL: LOCAL @some_netgroup -.br -ALL: .foobar.edu EXCEPT terminalserver.foobar.edu -.PP -The first rule permits access from hosts in the local domain (no `.\' -in the host name) and from members of the \fIsome_netgroup\fP -netgroup. The second rule permits access from all hosts in the -\fIfoobar.edu\fP domain (notice the leading dot), with the exception of -\fIterminalserver.foobar.edu\fP. -.SH MOSTLY OPEN -Here, access is granted by default; only explicitly specified hosts are -refused service. -.PP -The default policy (access granted) makes the allow file redundant so -that it can be omitted. The explicitly non-authorized hosts are listed -in the deny file. For example: -.PP -/etc/hosts.deny: -.in +3 -ALL: some.host.name, .some.domain -.br -ALL EXCEPT in.fingerd: other.host.name, .other.domain -.PP -The first rule denies some hosts and domains all services; the second -rule still permits finger requests from other hosts and domains. -.SH BOOBY TRAPS -The next example permits tftp requests from hosts in the local domain -(notice the leading dot). Requests from any other hosts are denied. -Instead of the requested file, a finger probe is sent to the offending -host. The result is mailed to the superuser. -.PP -.ne 2 -/etc/hosts.allow: -.in +3 -.nf -in.tftpd: LOCAL, .my.domain -.PP -.ne 2 -/etc/hosts.deny: -.in +3 -in.tftpd: ALL: (/some/where/safe_finger -l @%h | \\ - /usr/ucb/mail -s %d-%h root) & -.fi -.PP -The safe_finger command comes with the tcpd wrapper and should be -installed in a suitable place. It limits possible damage from data sent -by the remote finger server. It gives better protection than the -standard finger command. -.PP -The expansion of the %h (client host) and %d (service name) sequences -is described in the section on shell commands. -.PP -Warning: do not booby-trap your finger daemon, unless you are prepared -for infinite finger loops. -.PP -On network firewall systems this trick can be carried even further. -The typical network firewall only provides a limited set of services to -the outer world. All other services can be "bugged" just like the above -tftp example. The result is an excellent early-warning system. -.br -.ne 4 -.SH DIAGNOSTICS -An error is reported when a syntax error is found in a host access -control rule; when the length of an access control rule exceeds the -capacity of an internal buffer; when an access control rule is not -terminated by a newline character; when the result of %<letter> -expansion would overflow an internal buffer; when a system call fails -that shouldn\'t. All problems are reported via the syslog daemon. -.SH FILES -.na -.nf -/etc/hosts.allow, (daemon,client) pairs that are granted access. -/etc/hosts.deny, (daemon,client) pairs that are denied access. -.ad -.fi -.SH SEE ALSO -.nf -tcpd(1M) tcp/ip daemon wrapper program. -tcpdchk(1M), tcpdmatch(1M), test programs. -.SH BUGS -If a name server lookup times out, the host name will not be available -to the access control software, even though the host is registered. -.PP -Domain name server lookups are case insensitive; NIS (formerly YP) -netgroup lookups are case sensitive. -.SH AUTHOR -.nf -Wietse Venema (wietse@wzv.win.tue.nl) -Department of Mathematics and Computing Science -Eindhoven University of Technology -Den Dolech 2, P.O. Box 513 -5600 MB Eindhoven, The Netherlands -.fi -.\" @(#) hosts_access.5 1.20 95/01/30 19:51:46 -.\" Begin Sun update -.SH ATTRIBUTES -See -.BR attributes (5) -for descriptions of the following attributes: -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -= -Interface Stability Committed -.TE -.\" End Sun update diff --git a/usr/src/man/man4/hosts_options.4 b/usr/src/man/man4/hosts_options.4 deleted file mode 100644 index 0fcc660792..0000000000 --- a/usr/src/man/man4/hosts_options.4 +++ /dev/null @@ -1,183 +0,0 @@ -'\" t -.\" -.\" Modified for Solaris to to add the Solaris stability classification, -.\" and to add a note about source availability. -.\" -.TH HOSTS_OPTIONS 4 "Sep 15, 2011" -.SH NAME -hosts_options \- host access control language extensions -.SH DESCRIPTION -This document describes optional extensions to the language described -in the hosts_access(4) document. The extensions are enabled at program -build time. For example, by editing the Makefile and turning on the -PROCESS_OPTIONS compile-time option. -.PP -The extensible language uses the following format: -.sp -daemon_list : client_list : option : option ... -.PP -The first two fields are described in the hosts_access(4) manual page. -The remainder of the rules is a list of zero or more options. Any ":" -characters within options should be protected with a backslash. -.PP -An option is of the form "keyword" or "keyword value". Options are -processed in the specified order. Some options are subjected to -%<letter> substitutions. For the sake of backwards compatibility with -earlier versions, an "=" is permitted between keyword and value. -.SH LOGGING -.IP "severity mail.info" -.IP "severity notice" -Change the severity level at which the event will be logged. Facility -names (such as mail) are optional, and are not supported on systems -with older syslog implementations. The severity option can be used -to emphasize or to ignore specific events. -.SH ACCESS CONTROL -.IP "allow" -.IP "deny" -Grant (deny) service. These options must appear at the end of a rule. -.PP -The \fIallow\fR and \fIdeny\fR keywords make it possible to keep all -access control rules within a single file, for example in the -\fIhosts.allow\fR file. -.sp -To permit access from specific hosts only: -.sp -.ne 2 -ALL: .friendly.domain: ALLOW -ALL: ALL: DENY -.sp -To permit access from all hosts except a few trouble makers: -.sp -.ne 2 -ALL: .bad.domain: DENY -ALL: ALL: ALLOW -.sp -Notice the leading dot on the domain name patterns. -.SH RUNNING OTHER COMMANDS -.IP "spawn shell_command" -Execute, in a child process, the specified shell command, after -performing the %<letter> expansions described in the hosts_access(4) -manual page. The command is executed with stdin, stdout and stderr -connected to the null device, so that it won\'t mess up the -conversation with the client host. Example: -.sp -.nf -spawn (/some/where/safe_finger -l @%h | /usr/ucb/mail root) & -.fi -.sp -executes, in a background child process, the shell command "safe_finger --l @%h | mail root" after replacing %h by the name or address of the -remote host. -.sp -The example uses the "safe_finger" command instead of the regular -"finger" command, to limit possible damage from data sent by the finger -server. The "safe_finger" command is part of the daemon wrapper -package; it is a wrapper around the regular finger command that filters -the data sent by the remote host. -.IP "twist shell_command" -Replace the current process by an instance of the specified shell -command, after performing the %<letter> expansions described in the -hosts_access(4) manual page. Stdin, stdout and stderr are connected to -the client process. This option must appear at the end of a rule. -.sp -To send a customized bounce message to the client instead of -running the real ftp daemon: -.sp -.nf -in.ftpd : ... : twist /bin/echo 421 Some bounce message -.fi -.sp -For an alternative way to talk to client processes, see the -\fIbanners\fR option below. -.sp -To run /some/other/in.telnetd without polluting its command-line -array or its process environment: -.sp -.nf -in.telnetd : ... : twist PATH=/some/other; exec in.telnetd -.fi -.sp -Warning: in case of UDP services, do not twist to commands that use -the standard I/O or the read(2)/write(2) routines to communicate with -the client process; UDP requires other I/O primitives. -.SH NETWORK OPTIONS -.IP "keepalive" -Causes the server to periodically send a message to the client. The -connection is considered broken when the client does not respond. The -keepalive option can be useful when users turn off their machine while -it is still connected to a server. The keepalive option is not useful -for datagram (UDP) services. -.IP "linger number_of_seconds" -Specifies how long the kernel will try to deliver not-yet delivered -data after the server process closes a connection. -.SH USERNAME LOOKUP -.IP "rfc931 [ timeout_in_seconds ]" -Look up the client user name with the RFC 931 (TAP, IDENT, RFC 1413) -protocol. This option is silently ignored in case of services based on -transports other than TCP. It requires that the client system runs an -RFC 931 (IDENT, etc.) -compliant daemon, and may cause noticeable -delays with connections from non-UNIX clients. The timeout period is -optional. If no timeout is specified a compile-time defined default -value is taken. -.SH MISCELLANEOUS -.IP "banners /some/directory" -Look for a file in `/some/directory' with the same name as the daemon -process (for example in.telnetd for the telnet service), and copy its -contents to the client. Newline characters are replaced by -carriage-return newline, and %<letter> sequences are expanded (see -the hosts_access(4) manual page). -.sp -The tcp wrappers source code distribution provides a sample makefile -(Banners.Makefile) for convenient banner maintenance. -.sp -Warning: banners are supported for connection-oriented (TCP) network -services only. -.IP "nice [ number ]" -Change the nice value of the process (default 10). Specify a positive -value to spend more CPU resources on other processes. -.IP "setenv name value" -Place a (name, value) pair into the process environment. The value is -subjected to %<letter> expansions and may contain whitespace (but -leading and trailing blanks are stripped off). -.sp -Warning: many network daemons reset their environment before spawning a -login or shell process. -.IP "umask 022" -Like the umask command that is built into the shell. An umask of 022 -prevents the creation of files with group and world write permission. -The umask argument should be an octal number. -.IP "user nobody" -.IP "user nobody.kmem" -Assume the privileges of the "nobody" userid (or user "nobody", group -"kmem"). The first form is useful with inetd implementations that run -all services with root privilege. The second form is useful for -services that need special group privileges only. -.SH DIAGNOSTICS -When a syntax error is found in an access control rule, the error -is reported to the syslog daemon; further options will be ignored, -and service is denied. -.SH SEE ALSO -hosts_access(4), the default access control language -.SH AUTHOR -.nf -Wietse Venema (wietse@wzv.win.tue.nl) -Department of Mathematics and Computing Science -Eindhoven University of Technology -Den Dolech 2, P.O. Box 513, -5600 MB Eindhoven, The Netherlands -\" @(#) hosts_options.5 1.10 94/12/28 17:42:28 -.\" Begin Sun update -.SH ATTRIBUTES -See -.BR attributes (5) -for descriptions of the following attributes: -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -= -Interface Stability Committed -.TE -.\" End Sun update diff --git a/usr/src/man/man4/ib.4 b/usr/src/man/man4/ib.4 deleted file mode 100644 index cd0f63353a..0000000000 --- a/usr/src/man/man4/ib.4 +++ /dev/null @@ -1,86 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 IB 4 "Feb 19, 2004" -.SH NAME -ib \- InfiniBand device driver configuration files -.SH DESCRIPTION -.sp -.LP -The InfiniBand (IB) bus is an I/O transport based on switched fabrics. IB -devices are managed by the \fBib\fR(7D) nexus driver. There are three -categories of InfiniBand devices: -.RS +4 -.TP -.ie t \(bu -.el o -IB port/IB VPPA/IB HCA_SVC devices -.RE -.RS +4 -.TP -.ie t \(bu -.el o -IB IOC devices -.RE -.RS +4 -.TP -.ie t \(bu -.el o -IB Pseudo devices -.RE -.sp -.LP -The IB port/IB VPPA/IB HCA_SVC devices are enumerated by way of the -\fBib.conf\fR file. See \fBib\fR(7D). -.sp -.LP -The IB IOC devices are enumerated using the InfiniBand Device management class. -See \fBibdm\fR(7D). -.sp -.LP -For devices not in these two categories, most notably IB Pseudo devices, the -driver must provide configuration files to inform the system of the IB devices -to be created. Configuration parameters are represented in the form of name -value pairs you can retrieve using the DDI property interfaces. See -\fBddi_prop_op\fR(9F) for details. -.sp -.LP -Configuration files for IB device drivers must identify the parent driver -explicitly as \fBib\fR, and must create a string array property called -\fBunit-address\fR which is unique to this entry in the configuration file. -Drivers name \fBibport\fR and \fBioc\fR are reserved by \fBib\fR(7D) and should -not be used. -.sp -.LP -Each entry in the configuration file creates a prototype \fBdevinfo\fR node. -Each node is assigned a unit address which is determined by the value of the -\fBunit-address\fR property. This property is only applicable to children of -the IB parent and is required. See \fBdriver.conf\fR(4) for further details on -configuration file syntax. -.SH EXAMPLES -.sp -.LP -Example 1: Sample configuration file -.sp -.LP -Here is a configuration file called \fBibgen.conf\fR for an IB device driver -that implements a generic IB driver. This file creates a node called -\fBibgen\fR. -.sp -.in +2 -.nf - # - # Copyright 2002-2003 Sun Microsystems, Inc. All rights reserved. - # Use is subject to license terms. - # - #ident "@(#)ibgen.conf 1.3 03/05/01 SMI" - name="ibgen" parent="ib" unit-address="0"; -.fi -.in -2 - -.SH SEE ALSO -.sp -.LP -\fBdriver.conf\fR(4), \fBib\fR(7D), \fBibtl\fR(7D), \fBddi_prop_op\fR(9F) diff --git a/usr/src/man/man4/ibmf.4 b/usr/src/man/man4/ibmf.4 new file mode 100644 index 0000000000..04e688cf19 --- /dev/null +++ b/usr/src/man/man4/ibmf.4 @@ -0,0 +1,47 @@ +.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 2020 Joyent, Inc. +.\" +.\" 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] +.\" +.Dd January 12, 2020 +.Dt IBMF 4 +.Os +.Sh NAME +.Nm ibmf +.Nd InfiniBand Management Transport Framework +.Sh DESCRIPTION +The InfiniBand (IB) Management Transport Framework provides the mechanisms for +IB management modules to communicate with other InfiniBand management modules +such as the Subnet Administration process. +It also provides helper functions +such as Subnet Administration Access (SAA) for commonly performed operations. +.Sh FILES +.Bl -tag -width Pa +.It Pa /kernel/misc/amd64/ibmf +Device driver (x86). +.It Pa /kernel/misc/sparcv9/ibmf +Device driver (SPARC) +.El +.Sh ARCHITECTURE +PCI-based systems +.Sh INTERFACE STABILITY +Private +.Sh SEE ALSO +.Xr ibtl 4D +.Pp +.%T InfiniBand Architecture Specification, Version 1\&.1 +.Pp +.%U www.infinibandta.org diff --git a/usr/src/man/man4/ike.config.4 b/usr/src/man/man4/ike.config.4 deleted file mode 100644 index 1e9140a5ce..0000000000 --- a/usr/src/man/man4/ike.config.4 +++ /dev/null @@ -1,1194 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright (c) 2015, Circonus, Inc. All Rights Reserved. -.\" 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 IKE.CONFIG 4 "November 22, 2021" -.SH NAME -ike.config \- configuration file for IKE policy -.SH SYNOPSIS -.nf -\fB/etc/inet/ike/config\fR -.fi - -.SH DESCRIPTION -The \fB/etc/inet/ike/config\fR file contains rules for matching inbound IKE -requests. It also contains rules for preparing outbound \fBIKE\fR requests. -.sp -.LP -You can test the syntactic correctness of an \fB/etc/inet/ike/config\fR file by -using the \fB-c\fR or \fB-f\fR options of \fBin.iked\fR(1M). You must use the -\fB-c\fR option to test a \fBconfig\fR file. You might need to use the \fB-f\fR -option if it is not in \fB/etc/inet/ike/config\fR. -.SS "Lexical Components" -On any line, an unquoted \fB#\fR character introduces a comment. The remainder -of that line is ignored. Additionally, on any line, an unquoted \fB//\fR -sequence introduces a comment. The remainder of that line is ignored. -.sp -.LP -There are several types of lexical tokens in the \fBike.config\fR file: -.sp -.ne 2 -.na -\fB\fInum\fR\fR -.ad -.sp .6 -.RS 4n -A decimal, hex, or octal number representation is as in 'C'. -.RE - -.sp -.ne 2 -.na -\fB\fIIPaddr\fR/\fIprefix\fR/\fIrange\fR\fR -.ad -.sp .6 -.RS 4n -An IPv4 or IPv6 address with an optional /\fINNN\fR suffix, (where \fINNN\fR is -a \fInum\fR) that indicates an address (\fBCIDR\fR) prefix (for example, -\fB10.1.2.0/24\fR). An optional /\fIADDR\fR suffix (where \fIADDR\fR is a -second IP address) indicates an address/mask pair (for example, -\fB10.1.2.0/255.255.255.0\fR). An optional -\fIADDR\fR suffix (where \fIADDR\fR -is a second IPv4 address) indicates an inclusive range of addresses (for -example, \fB10.1.2.0-10.1.2.255\fR). The \fB/\fR or \fB-\fR can be surrounded -by an arbitrary amount of white space. -.RE - -.sp -.ne 2 -.na -\fB\fBXXX\fR | \fBYYY\fR | \fBZZZ\fR\fR -.ad -.sp .6 -.RS 4n -Either the words \fBXX\fRX, \fBYYY\fR, or \fBZZZ\fR, for example, {yes,no}. -.RE - -.sp -.ne 2 -.na -\fBp1-id-type\fR -.ad -.sp .6 -.RS 4n -An IKE phase 1 identity type. IKE phase 1 identity types include: -.br -.in +2 -\fBdn, DN\fR -.in -2 -.br -.in +2 -\fBdns, DNS\fR -.in -2 -.br -.in +2 -\fBfqdn, FQDN\fR -.in -2 -.br -.in +2 -\fBgn, GN\fR -.in -2 -.br -.in +2 -\fBip, IP\fR -.in -2 -.br -.in +2 -\fBipv4\fR -.in -2 -.br -.in +2 -\fBipv4_prefix\fR -.in -2 -.br -.in +2 -\fBipv4_range\fR -.in -2 -.br -.in +2 -\fBipv6\fR -.in -2 -.br -.in +2 -\fBipv6_prefix\fR -.in -2 -.br -.in +2 -\fBipv6_range\fR -.in -2 -.br -.in +2 -\fBmbox, MBOX\fR -.in -2 -.br -.in +2 -\fBuser_fqdn\fR -.in -2 -.RE - -.sp -.ne 2 -.na -\fB\fB"\fR\fIstring\fR\fB"\fR\fR -.ad -.sp .6 -.RS 4n -A quoted string. -.sp -Examples include:\fB"Label foo"\fR, or \fB"C=US, OU=Sun Microsystems\e, Inc., -N=olemcd@eng.example.com"\fR -.sp -A backslash (\fB\e\fR) is an escape character. If the string needs an actual -backslash, two must be specified. -.RE - -.sp -.ne 2 -.na -\fB\fIcert-sel\fR\fR -.ad -.sp .6 -.RS 4n -A certificate selector, a \fIstring\fR which specifies the identities of zero -or more certificates. The specifiers can conform to \fBX.509\fR naming -conventions. -.sp -A \fIcert-sel\fR can also use various shortcuts to match either subject -alternative names, the filename or \fBslot\fR of a certificate in -\fB/etc/inet/ike/publickeys\fR, or even the \fBISSUER\fR. For example: -.sp -.in +2 -.nf -"SLOT=0" -"EMAIL=postmaster@example.org" -"webmaster@example.org" # Some just work w/o TYPE= -"IP=10.0.0.1" -"10.21.11.11" # Some just work w/o TYPE= -"DNS=www.example.org" -"mailhost.example.org" # Some just work w/o TYPE= -"ISSUER=C=US, O=Sun Microsystems\\, Inc., CN=Sun CA" -.fi -.in -2 -.sp - -Any \fIcert-sel\fR preceded by the character \fB!\fR indicates a negative -match, that is, not matching this specifier. These are the same kind of strings -used in \fBikecert\fR(1M). -.RE - -.sp -.ne 2 -.na -\fB\fIldap-list\fR\fR -.ad -.sp .6 -.RS 4n -A quoted, comma-separated list of LDAP servers and ports. -.sp -For example, \fB"ldap1.example.com"\fR, \fB"ldap1.example.com:389"\fR, -\fB"ldap1.example.com:389,ldap2.example.com"\fR. -.sp -The default port for LDAP is \fB389\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIparameter-list\fR\fR -.ad -.sp .6 -.RS 4n -A list of parameters. -.RE - -.SS "File Body Entries" -There are four main types of entries: -.RS +4 -.TP -.ie t \(bu -.el o -global parameters -.RE -.RS +4 -.TP -.ie t \(bu -.el o -IKE phase 1 transform defaults -.RE -.RS +4 -.TP -.ie t \(bu -.el o -IKE rule defaults -.RE -.RS +4 -.TP -.ie t \(bu -.el o -IKE rules -.RE -.sp -.LP -The global parameter entries are as follows: -.sp -.ne 2 -.na -\fBcert_root \fIcert-sel\fR\fR -.ad -.sp .6 -.RS 4n -The X.509 distinguished name of a certificate that is a trusted root CA -certificate. It must be encoded in a file in the \fB/etc/inet/ike/publickeys\fR -directory. It must have a CRL in \fB/etc/inet/ike/crl\fRs. Multiple -\fBcert_root\fR parameters aggregate. -.RE - -.sp -.ne 2 -.na -\fBcert_trust \fIcert-sel\fR\fR -.ad -.sp .6 -.RS 4n -Specifies an X.509 distinguished name of a certificate that is self-signed, or -has otherwise been verified as trustworthy for signing IKE exchanges. It must -be encoded in a file in \fB/etc/inet/ike/publickeys\fR. Multiple -\fBcert_trust\fR parameters aggregate. -.RE - -.sp -.ne 2 -.na -\fBexpire_timer \fIinteger\fR\fR -.ad -.sp .6 -.RS 4n -The number of seconds to let a not-yet-complete IKE Phase I (Main Mode) -negotiation linger before deleting it. Default value: 300 seconds. -.RE - -.sp -.ne 2 -.na -\fBignore_crls\fR -.ad -.sp .6 -.RS 4n -If this keyword is present in the file, \fBin.iked\fR(1M) ignores Certificate -Revocation Lists (\fBCRL\fRs) for root \fBCA\fRs (as given in \fBcert_root\fR) -.RE - -.sp -.ne 2 -.na -\fBldap_server \fIldap-list\fR\fR -.ad -.sp .6 -.RS 4n -A list of LDAP servers to query for certificates. The list can be additive. -.RE - -.sp -.ne 2 -.na -\fBpkcs11_path \fIstring\fR\fR -.ad -.sp .6 -.RS 4n -The string that follows is a name of a shared object (\fB\&.so\fR) that -implements the PKCS#11 standard. The name is passed directly into -\fBdlopen\fR(3C) for linking, with all of the semantics of that library call. -By default, \fBin.iked\fR(1M) runs the same ISA as the running kernel, so a -library specified using \fBpkcs11_path\fR and an absolute pathname \fBmust\fR -match the same ISA as the kernel. One can use the start/exec SMF property (see -\fBsvccfg\fR(1M)) to change \fBin.iked\fR's ISA, but it is not recommended. -.sp -If this setting is not present, the default value is set to \fBlibpkcs11.so\fR. -Most cryptographic providers go through the default library, and this parameter -should only be used if a specialized provider of IKE-useful cryptographic -services cannot interface with the Solaris Cryptographic Framework. See -\fBcryptoadm\fR(1M). -.sp -This option is now deprecated, and may be removed in a future release. -.RE - -.sp -.ne 2 -.na -\fBretry_limit \fIinteger\fR\fR -.ad -.sp .6 -.RS 4n -The number of retransmits before any IKE negotiation is aborted. Default value: -5 times. -.RE - -.sp -.ne 2 -.na -\fBretry_timer_init \fIinteger\fR or \fIfloat\fR\fR -.ad -.sp .6 -.RS 4n -The initial interval (in seconds) between retransmits. This interval is doubled -until the \fBretry_timer_max\fR value (see below) is reached. Default value: -0.5 seconds. -.RE - -.sp -.ne 2 -.na -\fBretry_timer_max \fIinteger\fR or \fIfloat\fR\fR -.ad -.sp .6 -.RS 4n -The maximum interval (in seconds) between retransmits. The doubling retransmit -interval stops growing at this limit. Default value: 30 seconds. -.LP -Note - -.sp -.RS 2 -This value is never reached with the default configuration. The longest -interval is 8 (0.5 * 2 ^ (5 - 1)) seconds. -.RE -.RE - -.sp -.ne 2 -.na -\fBproxy \fIstring\fR\fR -.ad -.sp .6 -.RS 4n -The string following this keyword must be a URL for an HTTP proxy, for example, -\fBhttp://proxy:8080\fR. -.RE - -.sp -.ne 2 -.na -\fBsocks \fIstring\fR\fR -.ad -.sp .6 -.RS 4n -The string following this keyword must be a URL for a SOCKS proxy, for example, -\fBsocks://socks-proxy\fR. -.RE - -.sp -.ne 2 -.na -\fBuse_http\fR -.ad -.sp .6 -.RS 4n -If this keyword is present in the file, \fBin.iked\fR(1M) uses HTTP to retrieve -Certificate Revocation Lists (\fBCRL\fRs). -.RE - -.sp -.LP -The following IKE phase 1 transform parameters can be prefigured using -file-level defaults. Values specified within any given transform override these -defaults. -.sp -.LP -The IKE phase 1 transform defaults are as follows: -.sp -.ne 2 -.na -\fBp1_lifetime_secs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -The proposed default lifetime, in seconds, of an IKE phase 1 security -association (\fBSA\fR). -.RE - -.sp -.ne 2 -.na -\fBp1_nonce_len \fInum\fR\fR -.ad -.sp .6 -.RS 4n -The length in bytes of the phase 1 (quick mode) nonce data. This cannot be -specified on a per-rule basis. -.RE - -.sp -.LP -The following IKE rule parameters can be prefigured using file-level defaults. -Values specified within any given rule override these defaults, unless a rule -cannot. -.sp -.ne 2 -.na -\fBp2_lifetime_secs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -The proposed default lifetime, in seconds, of an IKE phase 2 security -association (SA). This value is optional. If omitted, a default value is used. -.RE - -.sp -.ne 2 -.na -\fBp2_softlife_secs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -The soft lifetime of a phase 2 SA, in seconds. If this value is specified, the -SA soft expires after the number of seconds specified by -\fBp2_softlife_secs\fR. This causes \fBin.iked\fR to renegotiate a new phase 2 -SA before the original SA expires. -.sp -This value is optional, if omitted soft expiry occurs after 90% of the lifetime -specified by \fBp2_lifetime_secs\fR. The value specified by -\fBp2_softlife_secs\fR is ignored if \fBp2_lifetime_secs\fR is not specified. -.sp -Setting \fBp2_softlife_secs\fR to the same value as \fBp2_lifetime_secs\fR -disables soft expires. -.RE - -.sp -.ne 2 -.na -\fBp2_idletime_secs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -The idle lifetime of a phase 2 SA, in seconds. If the value is specified, the -value specifies the lifetime of the SA, if the security association is not used -before the SA is revalidated. -.RE - -.sp -.ne 2 -.na -\fBp2_lifetime_kb \fInum\fR\fR -.ad -.sp .6 -.RS 4n -The lifetime of an SA can optionally be specified in kilobytes. This parameter -specifies the default value. If lifetimes are specified in both seconds and -kilobytes, the SA expires when either the seconds or kilobyte thresholds are -passed. -.RE - -.sp -.ne 2 -.na -\fBp2_softlife_kb \fInum\fR\fR -.ad -.sp .6 -.RS 4n -This value is the number of kilobytes that can be protected by an SA before a -soft expire occurs (see \fBp2_softlife_secs\fR, above). -.sp -This value is optional. If omitted, soft expiry occurs after 90% of the -lifetime specified by \fBp2_lifetime_kb\fR. The value specified by -\fBp2_softlife_kb\fR is ignored if \fBp2_lifetime_kb\fR is not specified. -.RE - -.sp -.ne 2 -.na -\fBp2_nonce_len \fInum\fR\fR -.ad -.sp .6 -.RS 4n -The length in bytes of the phase 2 (quick mode) nonce data. This cannot be -specified on a per-rule basis. -.RE - -.sp -.ne 2 -.na -\fBlocal_id_type \fIp1-id-type\fR\fR -.ad -.sp .6 -.RS 4n -The local identity for IKE requires a type. This identity type is reflected in -the IKE exchange. The type can be one of the following: -.RS +4 -.TP -.ie t \(bu -.el o -an IP address (for example, \fB10.1.1.2\fR) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -DNS name (for example, \fBtest.example.com\fR) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -MBOX RFC 822 name (for example, \fBroot@example.com\fR) -.RE -.RS +4 -.TP -.ie t \(bu -.el o -DNX.509 distinguished name (for example, \fBC=US, O=Sun Microsystems\, Inc., -CN=Sun Test cert\fR) -.RE -.RE - -.sp -.ne 2 -.na -\fBp1_xform '{' parameter-list '}\fR -.ad -.sp .6 -.RS 4n -A phase 1 transform specifies a method for protecting an IKE phase 1 exchange. -An initiator offers up lists of phase 1 transforms, and a receiver is expected -to only accept such an entry if it matches one in a phase 1 rule. There can be -several of these, and they are additive. There must be either at least one -phase 1 transform in a rule or a global default phase 1 transform list. In a -configuration file without a global default phase 1 transform list \fBand\fR a -rule without a phase, transform list is an invalid file. Unless specified as -optional, elements in the parameter-list must occur exactly once within a given -transform's parameter-list: -.sp -.ne 2 -.na -\fBoakley_group \fInumber\fR\fR -.ad -.sp .6 -.RS 4n -The Oakley Diffie-Hellman group used for IKE SA key derivation. The group -numbers are defined in RFC 2409, Appendix A, RFC 3526, and RFC 5114, section -3.2. Acceptable values are currently: -.br -.in +2 -1 (MODP 768-bit) -.in -2 -.br -.in +2 -2 (MODP 1024-bit) -.in -2 -.br -.in +2 -3 (EC2N 155-bit) -.in -2 -.br -.in +2 -4 (EC2N 185-bit) -.in -2 -.br -.in +2 -5 (MODP 1536-bit) -.in -2 -.br -.in +2 -14 (MODP 2048-bit) -.in -2 -.br -.in +2 -15 (MODP 3072-bit) -.in -2 -.br -.in +2 -16 (MODP 4096-bit) -.in -2 -.br -.in +2 -17 (MODP 6144-bit) -.in -2 -.br -.in +2 -18 (MODP 8192-bit) -.in -2 -.br -.in +2 -19 (ECP 256-bit) -.in -2 -.br -.in +2 -20 (ECP 384-bit) -.in -2 -.br -.in +2 -21 (ECP 521-bit) -.in -2 -.br -.in +2 -22 (MODP 1024-bit, with 160-bit Prime Order Subgroup) -.in -2 -.br -.in +2 -23 (MODP 2048-bit, with 224-bit Prime Order Subgroup) -.in -2 -.br -.in +2 -24 (MODP 2048-bit, with 256-bit Prime Order Subgroup) -.in -2 -.br -.in +2 -25 (ECP 192-bit) -.in -2 -.br -.in +2 -26 (ECP 224-bit) -.in -2 -.RE - -.sp -.ne 2 -.na -\fBencr_alg {3des, 3des-cbc, blowfish, blowfish-cdc, des, des-cbc, aes, -aes-cbc}\fR -.ad -.sp .6 -.RS 4n -An encryption algorithm, as in \fBipsecconf\fR(1M). However, of the ciphers -listed above, only \fBaes\fR and \fBaes-cbc\fR allow optional key-size setting, -using the "low value-to-high value" syntax. To specify a single AES key size, -the low value must equal the high value. If no range is specified, all three -AES key sizes are allowed. -.RE - -.sp -.ne 2 -.na -\fBauth_alg {md5, sha, sha1, sha256, sha384, sha512}\fR -.ad -.sp .6 -.RS 4n -An authentication algorithm. -.sp -Use \fBipsecalgs\fR(1M) with the \fB-l\fR option to list the IPsec protocols -and algorithms currently defined on a system. The \fBcryptoadm list\fR command -displays a list of installed providers and their mechanisms. See -\fBcryptoadm\fR(1M). -.RE - -.sp -.ne 2 -.na -\fBauth_method {preshared, rsa_sig, rsa_encrypt, dss_sig}\fR -.ad -.sp .6 -.RS 4n -The authentication method used for IKE phase 1. -.RE - -.sp -.ne 2 -.na -\fBp1_lifetime_secs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -Optional. The lifetime for a phase 1 SA. -.RE - -.RE - -.sp -.ne 2 -.na -\fBp2_lifetime_secs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -If configuring the kernel defaults is not sufficient for different tasks, this -parameter can be used on a per-rule basis to set the IPsec \fBSA\fR lifetimes -in seconds. -.RE - -.sp -.ne 2 -.na -\fBp2_pfs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -Use perfect forward secrecy for phase 2 (quick mode). If selected, the oakley -group specified is used for phase 2 PFS. Acceptable values are: -.br -.in +2 -0 (do not use Perfect Forward Secrecy for IPsec SAs) -.in -2 -.br -.in +2 -1 (768-bit) -.in -2 -.br -.in +2 -2 (1024-bit) -.in -2 -.br -.in +2 -5 (1536-bit) -.in -2 -.br -.in +2 -14 (2048-bit) -.in -2 -.br -.in +2 -15 (3072-bit) -.in -2 -.br -.in +2 -16 (4096-bit) -.in -2 -.RE - -.sp -.LP -An IKE rule starts with a right-curly-brace (\fB{\fR), ends with a -left-curly-brace (\fB}\fR), and has the following parameters in between: -.sp -.ne 2 -.na -\fBlabel \fIstring\fR\fR -.ad -.sp .6 -.RS 4n -Required parameter. The administrative interface to \fBin.iked\fR looks up -phase 1 policy rules with the label as the search string. The administrative -interface also converts the label into an index, suitable for an extended -ACQUIRE message from PF_KEY - effectively tying IPsec policy to IKE policy in -the case of a node initiating traffic. Only one \fBlabel\fR parameter is -allowed per rule. -.RE - -.sp -.ne 2 -.na -\fBlocal_addr <\fIIPaddr\fR/\fIprefix\fR/\fIrange\fR>\fR -.ad -.sp .6 -.RS 4n -Required parameter. The local address, address prefix, or address range for -this phase 1 rule. Multiple \fBlocal_addr\fR parameters accumulate within a -given rule. -.RE - -.sp -.ne 2 -.na -\fBremote_addr <\fIIPaddr\fR/\fIprefix\fR/\fIrang\fRe>\fR -.ad -.sp .6 -.RS 4n -Required parameter. The remote address, address prefix, or address range for -this phase 1 rule. Multiple \fBremote_addr\fR parameters accumulate within a -given rule. -.RE - -.sp -.ne 2 -.na -\fBlocal_id_type \fIp1-id-type\fR\fR -.ad -.sp .6 -.RS 4n -Which phase 1 identity type I uses. This is needed because a single certificate -can contain multiple values for use in IKE phase 1. Within a given rule, all -phase 1 transforms must either use preshared or non-preshared authentication -(they cannot be mixed). For rules with preshared authentication, the -\fBlocal_id_type\fR parameter is optional, and defaults to \fBIP\fR. For rules -which use non-preshared authentication, the 'local_id_type' parameter is -required. Multiple 'local_id_type' parameters within a rule are not allowed. -.RE - -.sp -.ne 2 -.na -\fBlocal_id \fIcert-sel\fR\fR -.ad -.sp .6 -.RS 4n -Disallowed for preshared authentication method; required parameter for -non-preshared authentication method. The local identity string or certificate -selector. Only one local identity per rule is used, the first one stated. -.RE - -.sp -.ne 2 -.na -\fBremote_id \fIcert-sel\fR\fR -.ad -.sp .6 -.RS 4n -Disallowed for preshared authentication method; required parameter for -non-preshared authentication method. Selector for which remote phase 1 -identities are allowed by this rule. Multiple \fBremote_id\fR parameters -accumulate within a given rule. If a single empty string (\fB""\fR) is given, -then this accepts any remote \fBID\fR for phase 1. It is recommended that -certificate trust chains or address enforcement be configured strictly to -prevent a breakdown in security if this value for \fBremote_id\fR is used. -.RE - -.sp -.ne 2 -.na -\fBp2_lifetime_secs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -If configuring the kernel defaults is not sufficient for different tasks, this -parameter can be used on a per-rule basis to set the IPsec \fBSA\fR lifetimes -in seconds. -.RE - -.sp -.ne 2 -.na -\fBp2_pfs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -Use perfect forward secrecy for phase 2 (quick mode). If selected, the oakley -group specified is used for phase 2 PFS. Acceptable values are: -.br -.in +2 -0 (do not use Perfect Forward Secrecy for IPsec SAs) -.in -2 -.br -.in +2 -1 (768-bit) -.in -2 -.br -.in +2 -2 (1024-bit) -.in -2 -.br -.in +2 -5 (1536-bit) -.in -2 -.br -.in +2 -14 (2048-bit) -.in -2 -.br -.in +2 -15 (3072-bit) -.in -2 -.br -.in +2 -16 (4096-bit) -.in -2 -.RE - -.sp -.ne 2 -.na -\fBp1_xform \fB{\fR \fIparameter-list\fR \fB}\fR\fR -.ad -.sp .6 -.RS 4n -A phase 1 transform specifies a method for protecting an IKE phase 1 exchange. -An initiator offers up lists of phase 1 transforms, and a receiver is expected -to only accept such an entry if it matches one in a phase 1 rule. There can be -several of these, and they are additive. There must be either at least one -phase 1 transform in a rule or a global default phase 1 transform list. A -\fBike.config\fR file without a global default phase 1 transform list \fBand\fR -a rule without a phase 1 transform list is an invalid file. Elements within the -parameter-list; unless specified as optional, must occur exactly once within a -given transform's parameter-list: -.sp -.ne 2 -.na -\fBoakley_group \fInumber\fR\fR -.ad -.sp .6 -.RS 4n -The Oakley Diffie-Hellman group used for \fBIKE SA\fR key derivation. -Acceptable values are currently: -.br -.in +2 -1 (768-bit) -.in -2 -.br -.in +2 -2 (1024-bit) -.in -2 -.br -.in +2 -5 (1536-bit) -.in -2 -.br -.in +2 -14 (2048-bit) -.in -2 -.br -.in +2 -15 (3072-bit) -.in -2 -.br -.in +2 -16 (4096-bit) -.in -2 -.RE - -.sp -.ne 2 -.na -\fBencr_alg {3des, 3des-cbc, blowfish, blowfish-cdc, des, des-cbc, aes, -aes-cbc}\fR -.ad -.sp .6 -.RS 4n -An encryption algorithm, as in \fBipsecconf\fR(1M). However, of the ciphers -listed above, only \fBaes\fR and \fBaes-cbc\fR allow optional key-size setting, -using the "low value-to-high value" syntax. To specify a single AES key size, -the low value must equal the high value. If no range is specified, all three -AES key sizes are allowed. -.RE - -.sp -.ne 2 -.na -\fBauth_alg {md5, sha, sha1}\fR -.ad -.sp .6 -.RS 4n -An authentication algorithm, as specified in \fBipseckey\fR(1M). -.RE - -.sp -.ne 2 -.na -\fBauth_method {preshared, rsa_sig, rsa_encrypt, dss_sig}\fR -.ad -.sp .6 -.RS 4n -The authentication method used for IKE phase 1. -.RE - -.sp -.ne 2 -.na -\fBp1_lifetime_secs \fInum\fR\fR -.ad -.sp .6 -.RS 4n -Optional. The lifetime for a phase 1 SA. -.RE - -.RE - -.SH EXAMPLES -\fBExample 1 \fRA Sample \fBike.config\fR File -.sp -.LP -The following is an example of an \fBike.config\fR file: - -.sp -.in +2 -.nf - -### BEGINNING OF FILE - -### First some global parameters... - -### certificate parameters... - -# Root certificates. I SHOULD use a full Distinguished Name. -# I must have this certificate in my local filesystem, see ikecert(1m). -cert_root "C=US, O=Sun Microsystems\\, Inc., CN=Sun CA" - -# Explicitly trusted certs that need no signatures, or perhaps -# self-signed ones. Like root certificates, use full DNs for them -# for now. -cert_trust "EMAIL=root@example.org" - -# Where do I send LDAP requests? -ldap_server "ldap1.example.org,ldap2.example.org:389" - -## phase 1 transform defaults... - -p1_lifetime_secs 14400 -p1_nonce_len 20 - -## Parameters that might also show up in rules. - -p1_xform { auth_method preshared oakley_group 5 auth_alg sha - encr_alg 3des } -p2_pfs 2 - - - -### Now some rules... - -{ - label "simple inheritor" - local_id_type ip - local_addr 10.1.1.1 - remote_addr 10.1.1.2 -} -{ - label "simple inheritor IPv6" - local_id_type ipv6 - local_addr fe80::a00:20ff:fe7d:6 - remote_addr fe80::a00:20ff:fefb:3780 -} - -{ - # an index-only rule. If I'm a receiver, and all I - # have are index-only rules, what do I do about inbound IKE requests? - # Answer: Take them all! - - label "default rule" - # Use whatever "host" (e.g. IP address) identity is appropriate - local_id_type ipv4 - - local_addr 0.0.0.0/0 - remote_addr 0.0.0.0/0 - - p2_pfs 5 - - # Now I'm going to have the p1_xforms - p1_xform - {auth_method preshared oakley_group 5 auth_alg md5 encr_alg \e - blowfish } p1_xform - {auth_method preshared oakley_group 5 auth_alg md5 encr_alg 3des } - - # After said list, another keyword (or a '}') stops xform - # parsing. -} - -{ - # Let's try something a little more conventional. - - label "host to .80 subnet" - local_id_type ip - local_id "10.1.86.51" - - remote_id "" # Take any, use remote_addr for access control. - - local_addr 10.1.86.51 - remote_addr 10.1.80.0/24 - - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg md5 encr_alg 3des } - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg md5 encr_alg \e - blowfish } - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg sha1 encr_alg 3des } - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg sha1 encr_alg \e - blowfish } -} - -{ - # Let's try something a little more conventional, but with ipv6. - - label "host to fe80::/10 subnet" - local_id_type ip - local_id "fe80::a00:20ff:fe7d:6" - - remote_id "" # Take any, use remote_addr for access control. - - local_addr fe80::a00:20ff:fe7d:6 - remote_addr fe80::/10 - - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg md5 encr_alg 3des } - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg md5 encr_alg \e - blowfish } - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg sha1 encr_alg \e - 3des } - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg sha1 encr_alg \e - blowfish } -} - -{ - # How 'bout something with a different cert type and name? - - label "punchin-point" - local_id_type mbox - local_id "ipsec-wizard@example.org" - - remote_id "10.5.5.128" - - local_addr 0.0.0.0/0 - remote_addr 10.5.5.128 - - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg md5 encr_alg \e - blowfish } -} - -{ - label "receiver side" - - remote_id "ipsec-wizard@example.org" - - local_id_type ip - local_id "10.5.5.128" - - local_addr 10.5.5.128 - remote_addr 0.0.0.0/0 - - p1_xform - { auth_method rsa_sig oakley_group 5 auth_alg md5 encr_alg blowfish } - # NOTE: Specifying preshared null-and-voids the remote_id/local_id - # fields. - p1_xform - { auth_method preshared oakley_group 5 auth_alg md5 encr_alg \e - blowfish} - -} -.fi -.in -2 - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -\fBcryptoadm\fR(1M), \fBikeadm\fR(1M), \fBin.iked\fR(1M), \fBikecert\fR(1M), -\fBipseckey\fR(1M), \fBipsecalgs\fR(1M), \fBipsecconf\fR(1M), \fBsvccfg\fR(1M), -\fBdlopen\fR(3C), \fBattributes\fR(5), \fBrandom\fR(7D) -.sp -.LP -Harkins, Dan and Carrel, Dave. \fIRFC 2409, Internet Key Exchange (IKE)\fR. -Cisco Systems, November 1998. -.sp -.LP -Maughan, Douglas et. al. \fIRFC 2408, Internet Security Association and Key -Management Protocol (ISAKMP)\fR. National Security Agency, Ft. Meade, MD. -November 1998. -.sp -.LP -Piper, Derrell. \fIRFC 2407, The Internet IP Security Domain of Interpretation -for ISAKMP\fR. Network Alchemy. Santa Cruz, California. November 1998. -.sp -.LP -Kivinen, T. \fIRFC 3526, More Modular Exponential (MODP) Diffie-Hellman Groups -for Internet Key Exchange (IKE)\fR. The Internet Society, Network Working -Group. May 2003. -.sp -.LP -Lepinksi, M. and Kent, S. \fIRFC 5114, Additional Diffie-Hellman Groups for Use -with IETF Standards\fR. BBN Technologies, January 2008. -.sp -.LP -Fu, D. and Solinas, J. \fIRFC 5903, Elliptic Curve Groups modulo a Prime (ECP -Groups) for IKE and IKEv2\fR. NSA, June 2010. diff --git a/usr/src/man/man4/ike.preshared.4 b/usr/src/man/man4/ike.preshared.4 deleted file mode 100644 index 2d525f2cbf..0000000000 --- a/usr/src/man/man4/ike.preshared.4 +++ /dev/null @@ -1,95 +0,0 @@ -'\" te -.\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 IKE.PRESHARED 4 "Oct 15, 2001" -.SH NAME -ike.preshared \- pre-shared keys file for IKE -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/secret/ike.preshared\fR -.fi - -.SH DESCRIPTION -.sp -.LP - The \fB/etc/inet/secret/ike.preshared\fR file contains secret keying material -that two \fBIKE\fR instances can use to authenticate each other. Because of the -sensitive nature of this data, it is kept in the \fB/etc/inet/secret\fR -directory, which is only accessible by root. -.sp -.LP -Pre-shared keys are delimited by open-curly-brace (\fB{\fR) and -close-curly-brace (\fB}\fR) characters. There are five name-value pairs -required inside a pre-shared key: -.sp - -.sp -.TS -c c c -l l l . -Name Value Example -localidtype IP localidtype IP -remoteidtype IP remoteidtype IP -localid IP-address localid 10.1.1.2 -remoteid IP-address remoteid 10.1.1.3 -key hex-string 1234567890abcdef -.TE - -.sp -.LP -Comment lines with \fB#\fR appearing in the first column are also legal. -.sp -.LP -Files in this format can also be used by the \fBikeadm\fR(1M) command to load -additional pre-shared keys into a running an \fBin.iked\fR(1M) process. -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample ike.preshared File -.sp -.LP -The following is an example of an \fBike.preshared\fR file: - -.sp -.in +2 -.nf - -# -# Two pre-shared keys between myself, 10.1.1.2, and two remote -# hosts. Note that names are not allowed for IP addresses. -# -# A decent hex string can be obtained by performing: -# od -x </dev/random | head -# - -{ - localidtype IP - localid 10.1.1.2 - remoteidtype IP - remoteid 10.21.12.4 - key 4b656265207761732068657265210c0a -} - -{ - localidtype IP - localid 10.1.1.2 - remoteidtype IP - remoteid 10.9.1.25 - key 536f20776572652042696c6c2c2052656e65652c20616e642043687269732e0a -} -.fi -.in -2 - -.SH SECURITY -.sp -.LP -If this file is compromised, all \fBIPsec\fR security associations derived from -secrets in this file will be compromised as well. The default permissions on -\fBike.preshared\fR are \fB0600\fR. They should stay this way. -.SH SEE ALSO -.sp -.LP -\fBod\fR(1), \fBikeadm\fR(1M), \fBin.iked\fR(1M), \fBipseckey\fR(1M), -\fBattributes\fR(5), \fBrandom\fR(7D) diff --git a/usr/src/man/man4/inet_type.4 b/usr/src/man/man4/inet_type.4 deleted file mode 100644 index c9d68008d6..0000000000 --- a/usr/src/man/man4/inet_type.4 +++ /dev/null @@ -1,101 +0,0 @@ -'\" te -.\" Copyright (C) 1999, Sun Microsystems, Inc. All Rights Reserved -.\" 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 INET_TYPE 4 "Jun 16, 1999" -.SH NAME -inet_type \- default Internet protocol type -.SH SYNOPSIS -.LP -.nf -\fB/etc/default/inet_type\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBinet_type\fR file defines the default \fBIP\fR protocol to use. -Currently this file is only used by the \fBifconfig\fR(1M) and -\fBnetstat\fR(1M) commands. -.sp -.LP -The \fBinet_type\fR file can contain a number of \fB<variable>=<value>\fR -lines. Currently, the only variable defined is \fBDEFAULT_IP\fR, which can be -assigned a value of \fBIP_VERSION4\fR, \fBIP_VERSION6\fR, or \fBBOTH\fR. -.sp -.LP -The output displayed by the \fBifconfig\fR and \fBnetstat\fR commands can be -controlled by the value of \fBDEFAULT_IP\fR set in \fBinet_type\fR file. By -default, both commands display the IPv4 and IPv6 information available on the -system. The user can choose to suppress display of IPv6 information by setting -the value of \fBDEFAULT_IP\fR. The following shows the possible values for -\fBDEFAULT_IP\fR and the resulting \fBifconfig\fR and \fBnetstat\fR output that -will be displayed: -.sp -.ne 2 -.na -\fB\fBIP_VERSION4\fR\fR -.ad -.RS 15n -Displays only IPv4 related information. The output displayed is backward -compatible with older versions of the \fBifconfig\fR(1M) and \fBnetstat\fR(1M) -commands. -.RE - -.sp -.ne 2 -.na -\fB\fBIP_VERSION6\fR\fR -.ad -.RS 15n -Displays both IPv4 and IPv6 related information for \fBifconfig\fR and -\fBnetstat\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBBOTH\fR\fR -.ad -.RS 15n -Displays both IPv4 and IPv6 related information for \fBifconfig\fR and -\fBnetstat\fR. -.RE - -.sp -.LP -The command-line options to the \fBifconfig\fR and \fBnetstat\fR commands -override the effect of \fBDEFAULT_IP\fR as set in the \fBinet_type\fR file. For -example, even if the value of \fBDEFAULT_IP\fR is \fBIP_VERSION4\fR, the -command -.sp -.in +2 -.nf -example% \fBifconfig -a6\fR -.fi -.in -2 -.sp - -.sp -.LP -will display all IPv6 interfaces. -.SH EXAMPLES -.LP -\fBExample 1 \fRSuppressing IPv6 Related Output -.sp -.LP -This is what the \fBinet_type\fR file must contain if you want to suppress IPv6 -related output: - -.sp -.in +2 -.nf -DEFAULT_IP=IP_VERSION4 -.fi -.in -2 - -.SH SEE ALSO -.sp -.LP -\fBifconfig\fR(1M), \fBnetstat\fR(1M) diff --git a/usr/src/man/man4/inetd.conf.4 b/usr/src/man/man4/inetd.conf.4 deleted file mode 100644 index 1b272d6b28..0000000000 --- a/usr/src/man/man4/inetd.conf.4 +++ /dev/null @@ -1,250 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1985 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. -.\" Copyright (C) 2004, Sun Microsystems, Inc. All Rights Reserved -.TH INETD.CONF 4 "April 9, 2016" -.SH NAME -inetd.conf \- Internet servers database -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/inetd.conf\fR -.fi - -.LP -.nf -\fB/etc/inetd.conf\fR -.fi - -.SH DESCRIPTION -.LP -In the current release of the Solaris operating system, the \fBinetd.conf\fR -file is no longer directly used to configure \fBinetd\fR. The Solaris services -which were formerly configured using this file are now configured in the -Service Management Facility (see \fBsmf\fR(5)) using \fBinetadm\fR(1M). Any -records remaining in this file after installation or upgrade, or later created -by installing additional software, must be converted to \fBsmf\fR(5) services -and imported into the SMF repository using \fBinetconv\fR(1M), otherwise the -service will not be available. -.sp -.LP -For Solaris operating system releases prior to the current release (such as -Solaris 9), the \fBinetd.conf\fR file contains the list of servers that -\fBinetd\fR(1M) invokes when it receives an Internet request over a socket. -Each server entry is composed of a single line of the form: -.sp -.in +2 -.nf -\fIservice-name\fR \fIendpoint-type\fR \fIprotocol \fR\fIwait-status\fR \fIuid\fR \fIserver-program\fR \e -\fIserver-arguments\fR -.fi -.in -2 -.sp - -.sp -.LP -Fields are separated by either SPACE or TAB characters. A `\fB#\fR' (number -sign) indicates the beginning of a comment; characters up to the end of the -line are not interpreted by routines that search this file. -.sp -.ne 2 -.na -\fB\fIservice-name\fR\fR -.ad -.RS 20n -The name of a valid service listed in the \fBservices\fR file. For \fBRPC\fR -services, the value of the \fIservice-name\fR field consists of the \fBRPC\fR -service name or program number, followed by a '\fB/\fR' (slash) and either a -version number or a range of version numbers, for example, \fBrstatd/2-4\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIendpoint-type\fR\fR -.ad -.RS 20n -Can be one of: -.sp -.ne 2 -.na -\fB\fBstream\fR\fR -.ad -.RS 13n -for a stream socket -.RE - -.sp -.ne 2 -.na -\fB\fBdgram\fR\fR -.ad -.RS 13n -for a datagram socket -.RE - -.sp -.ne 2 -.na -\fB\fBraw\fR\fR -.ad -.RS 13n -for a raw socket -.RE - -.sp -.ne 2 -.na -\fB\fBseqpacket\fR\fR -.ad -.RS 13n -for a sequenced packet socket -.RE - -.sp -.ne 2 -.na -\fB\fBtli\fR\fR -.ad -.RS 13n -for all \fBTLI\fR endpoints -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIprotocol\fR\fR -.ad -.RS 20n -A recognized protocol listed in the file \fB/etc/inet/protocols\fR. For servers -capable of supporting \fBTCP\fR and \fBUDP\fR over IPv6, the following protocol -types are also recognized: -.RS +4 -.TP -.ie t \(bu -.el o -\fBtcp6\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBudp6\fR -.RE -\fB\fR\fBtcp6\fR and \fBudp6\fR are not official protocols; accordingly, they -are not listed in the \fB/etc/inet/protocols\fR file. -.sp -Here the \fBinetd\fR program uses an \fBAF_INET6\fR type socket endpoint. These -servers can also handle incoming IPv4 client requests in addition to IPv6 -client requests. -.sp -For \fBRPC\fR services, the field consists of the string \fBrpc\fR followed by -a '/' (slash) and either a '*' (asterisk), one or more nettypes, one or more -netids, or a combination of nettypes and netids. Whatever the value, it is -first treated as a nettype. If it is not a valid nettype, then it is treated as -a netid. For example, \fBrpc/*\fR for an \fBRPC\fR service using all the -transports supported by the system (the list can be found in the -\fB/etc/netconfig\fR file), equivalent to saying \fBrpc/visible rpc/ticots\fR -for an \fBRPC\fR service using the Connection-Oriented Transport Service. -.RE - -.sp -.ne 2 -.na -\fB\fIwait-status\fR\fR -.ad -.RS 20n -This field has values \fBwait\fR or \fBnowait\fR. This entry specifies whether -the server that is invoked by \fBinetd\fR will take over the listening socket -associated with the service, and whether once launched, \fBinetd\fR will -\fBwait\fR for that server to exit, if ever, before it resumes listening for -new service requests. The \fIwait-status\fR for datagram servers must be set to -\fBwait\fR, as they are always invoked with the original datagram socket that -will participate in delivering the service bound to the specified service. They -do not have separate "listening" and "accepting" sockets. Accordingly, do not -configure \fBUDP\fR services as \fBnowait\fR. This causes a race condition by -which the \fBinetd\fR program selects on the socket and the server program -reads from the socket. Many server programs will be forked, and performance -will be severely compromised. Connection-oriented services such as \fBTCP\fR -stream services can be designed to be either \fBwait\fR or \fBnowait\fR status. -.RE - -.sp -.ne 2 -.na -\fB\fIuid\fR\fR -.ad -.RS 20n -The user \fBID\fR under which the server should run. This allows servers to run -with access privileges other than those for root. -.RE - -.sp -.ne 2 -.na -\fB\fIserver-program\fR\fR -.ad -.RS 20n -Either the pathname of a server program to be invoked by \fBinetd\fR to perform -the requested service, or the value \fBinternal\fR if \fBinetd\fR itself -provides the service. -.RE - -.sp -.ne 2 -.na -\fB\fIserver-arguments\fR\fR -.ad -.RS 20n -If a server must be invoked with command line arguments, the entire command -line (including argument 0) must appear in this field (which consists of all -remaining words in the entry). If the server expects \fBinetd\fR to pass it the -address of its peer, for compatibility with 4.2BSD executable daemons, then the -first argument to the command should be specified as \fB%A\fR. No more than 20 -arguments are allowed in this field. The \fB%A\fR argument is implemented only -for services whose \fIwait-status\fR value is \fBnowait\fR. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/etc/netconfig\fR\fR -.ad -.RS 23n -network configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/inet/protocols\fR\fR -.ad -.RS 23n -Internet protocols -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/inet/services\fR\fR -.ad -.RS 23n -Internet network services -.RE - -.SH SEE ALSO -.LP -\fBrlogin\fR(1), \fBrsh\fR(1), \fBin.tftpd\fR(1M), \fBinetadm\fR(1M), -\fBinetconv\fR(1M), \fBinetd\fR(1M), \fBservices\fR(4), \fBsmf\fR(5) -.SH NOTES -.LP -\fB/etc/inet/inetd.conf\fR is the official SVR4 name of the \fBinetd.conf\fR -file. The symbolic link \fB/etc/inetd.conf\fR exists for \fBBSD\fR -compatibility. -.sp -.LP -This man page describes \fBinetd.conf\fR as it was supported in Solaris -operating system releases prior to the current release. The services that were -configured by means of \fBinetd.conf\fR are now configured in the Service -Management Facility (see \fBsmf\fR(5)) using \fBinetadm\fR(1M). diff --git a/usr/src/man/man4/init.4 b/usr/src/man/man4/init.4 deleted file mode 100644 index be72691a62..0000000000 --- a/usr/src/man/man4/init.4 +++ /dev/null @@ -1,141 +0,0 @@ -'\" -.\" Copyright 2021 OmniOS Community Edition (OmniOSce) Association. -.\" Copyright 2014 Garrett D'Amore -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" -.\" 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] -.\" -.Dd November 7, 2021 -.Dt INIT 4 -.Os -.Sh NAME -.Nm init , -.Nm TIMEZONE -.Nd set default system time zone and locale -.Sh SYNOPSIS -.Pa /etc/default/init -.Pp -.Pa /etc/TIMEZONE -.Sh DESCRIPTION -This file sets the time zone environment variable -.Ev TZ , -and the locale-related environment variables -.Ev LANG , -.Ev LC_COLLATE , -.Ev LC_CTYPE , -.Ev LC_MESSAGES , -.Ev LC_MONETARY , -.Ev LC_NUMERIC -and -.Ev LC_TIME . -.Pp -It can also be used to set any additional environment variables which should be -present in all processes started by -.Xr init 1M -or -.Xr svc.startd 1M , -and in any -.Xr zoneadmd 1M -daemons started automatically to support zone operations. -.Pp -The format of the file is a set of tokens of the form: -.Pp -.Dl Ar VAR Ns No \&= Ns Ar value -.Pp -where -.Ar VAR -is an environment variable and -.Ar value -is the value assigned to the variable. -.Ar value -can be enclosed in double quotes -.Pq \&" -or single quotes -.Pq \&' , -however, these quotes cannot be part of the value. -Neither -.Ar VAR -nor -.Ar value -may contain whitespace. -Multiple -.Ar VAR Ns No \&= Ns Ar value -pairs can occur on the same line, separated by whitespace or a semicolon -.Pq \&; , -but, for compatibility with existing software, the -.Ev TZ -variable -.Em must -appear on its own line with no leading whitespace. -Comments are supported; each comment must be on its own line and begin with a -hash -.Pq # -character. -.Pp -If the -.Ev CMASK -variable is specified, it is not passed to the environment but the value is -used to set the initial umask that -.Xr init 1M -uses and that every other process inherits. -The -.Ev CMASK -value is specified in octal and must be between 000 and 077 to be accepted; the -value is silently ignored otherwise. -If the value is missing or cannot be parsed as an octal number, then a value -of 0 is assumed. -A sequence of valid octal digits followed by other trailing characters will be -treated as if the trailing characters were not present. -.Pp -For -.Xr init 1M , -the number of environment variables that can be set is limited to 20. -.Pp -.Pa /etc/TIMEZONE -is a symbolic link to -.Pa /etc/default/init . -This link exists for compatibility with legacy software, is obsolete, and may -be removed in a future release. -.Sh SEE ALSO -.Xr init 1M , -.Xr rtc 1M , -.Xr svc.startd 1M , -.Xr zoneadmd 1M , -.Xr ctime 3C , -.Xr environ 5 -.Sh NOTES -When changing the -.Ev TZ -setting on x86 systems, you must make a corresponding change to the -.Pa /etc/rtc_config -file to account for the new timezone setting. -This can be accomplished by executing the following commands, followed by a -reboot, to make the changes take effect: -.Bd -literal -offset indent -# rtc -z zone-name -# rtc -c -.Ed -.Pp -where -.Ar zone-name -is the same name as the -.Ev TZ -variable setting. -.Pp -See -.Xr rtc 1M -for more information. diff --git a/usr/src/man/man4/init.d.4 b/usr/src/man/man4/init.d.4 deleted file mode 100644 index c0ae9654c0..0000000000 --- a/usr/src/man/man4/init.d.4 +++ /dev/null @@ -1,107 +0,0 @@ -'\" te -.\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved -.\" 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 INIT.D 4 "May 13, 2017" -.SH NAME -init.d \- initialization and termination scripts for changing init states -.SH SYNOPSIS -.LP -.nf -\fB/etc/init.d\fR -.fi - -.SH DESCRIPTION -.LP -\fB/etc/init.d\fR is a directory containing initialization and termination -scripts for changing init states. These scripts are linked when appropriate to -files in the \fBrc?.d\fR directories, where `\fB?\fR' is a single character -corresponding to the init state. See \fBinit\fR(1M) for definitions of the -states. -.sp -.LP -The service management facility (see \fBsmf\fR(5)) is the preferred mechanism -for service initiation and termination. The \fBinit.d\fR and \fBrc?.d\fR -directories are obsolete, and are provided for compatibility purposes only. -Applications launched from these directories by \fBsvc.startd\fR(1M) are -incomplete services, and will not be restarted on failure. -.sp -.LP -File names in \fBrc?.d\fR directories are of the form \fB[SK]nn\fI<init.d -filename>\fR\fR, where \fBS\fR means start this job, \fBK\fR means kill this -job, and \fBnn\fR is the relative sequence number for killing or starting the -job. -.sp -.LP -When entering a state (init S,0,2,3,etc.) the \fBrc[S0-6]\fR script executes -those scripts in \fB/etc/rc[S0-6].d\fR that are prefixed with \fBK\fR followed -by those scripts prefixed with \fBS\fR. When executing each script in one of -the \fB/etc/rc[S0-6] directories, the /sbin/rc[S0-6]\fR script passes a single -argument. It passes the argument 'stop' for scripts prefixed with \fBK\fR and -the argument 'start' for scripts prefixed with \fBS\fR. There is no harm in -applying the same sequence number to multiple scripts. In this case the order -of execution is deterministic but unspecified. -.sp -.LP -Guidelines for selecting sequence numbers are provided in \fBREADME\fR files -located in the directory associated with that target state. For example, -\fB/etc/rc[S0-6].d/README\fR. Absence of a \fBREADME\fR file indicates that -there are currently no established guidelines. -.sp -.LP -Do not put \fB/etc/init.d\fR in your \fB$PATH\fR. Having this directory in your -\fB$PATH\fR can cause unexpected behavior. The programs in \fB/etc/init.d\fR -are associated with \fBinit\fR state changes and, under normal circumstances, -are not intended to be invoked from a command line. -.SH EXAMPLES -.LP -\fBExample 1 \fRExample of \fB/sbin/rc2\fR. -.sp -.LP -When changing to init state 2 (multi-user mode, network resources not -exported), \fB/sbin/rc2\fR is initiated by the \fBsvc.startd\fR(1M) process. -The following steps are performed by \fB/sbin/rc2\fR. - -.RS +4 -.TP -1. -In the directory \fB/etc/rc2.d\fR are files used to stop processes that -should not be running in state 2. The filenames are prefixed with \fBK\fR. Each -\fBK\fR file in the directory is executed (by \fB/sbin/rc2\fR) in alphanumeric -order when the system enters init state 2. See example below. -.RE -.RS +4 -.TP -2. -Also in the \fBrc2.d\fR directory are files used to start processes that -should be running in state 2. As in Step 1, each \fBS\fR file is executed. -.RE -.sp -.LP -Assume the file \fB/etc/init.d/netdaemon\fR is a script that will initiate -networking daemons when given the argument 'start', and will terminate the -daemons if given the argument 'stop'. It is linked to -\fB/etc/rc2.d/S68netdaemon\fR, and to \fB/etc/rc0.d/K67netdaemon\fR. The file -is executed by \fB/etc/rc2.d/S68netdaemon start\fR when init state 2 is entered -and by \fB/etc/rc0.d/K67netdaemon stop\fR when shutting the system down. - -.SH SEE ALSO -.LP -\fBsvcs\fR(1), \fBinit\fR(1M), \fBsvc.startd\fR(1M), \fBsvccfg\fR(1M), -\fBsmf\fR(5) -.SH NOTES -.LP -Solaris now provides an expanded mechanism, which includes automated restart, -for applications historically started via the init script mechanism. The -Service Management Facility (introduced in \fBsmf\fR(5)) is the preferred -delivery mechanism for persistently running applications. Existing \fBinit.d\fR -scripts will, however, continue to be executed according to the rules in this -manual page. The details of execution in relation to managed services are -available in \fBsvc.startd\fR(1M). -.sp -.LP -On earlier Solaris releases, a script named with a suffix of '.sh' would be -sourced, allowing scripts to modify the environment of other scripts executed -later. This behavior is no longer supported; for altering the environment in -which services are run, see the \fBsetenv\fR subcommand in \fBsvccfg\fR(1M). diff --git a/usr/src/man/man4/inittab.4 b/usr/src/man/man4/inittab.4 deleted file mode 100644 index 97d7a4c869..0000000000 --- a/usr/src/man/man4/inittab.4 +++ /dev/null @@ -1,250 +0,0 @@ -'\" te -.\" Copyright (c) 2001 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 INITTAB 4 "Dec 9, 2004" -.SH NAME -inittab \- script for init -.SH DESCRIPTION -.sp -.LP -The \fB/etc/inittab\fR file controls process dispatching by \fBinit\fR. The -processes most typically dispatched by \fBinit\fR are daemons. -.sp -.LP -It is no longer necessary to edit the \fB/etc/inittab\fR file directly. -Administrators should use the Solaris Service Management Facility (SMF) to -define services instead. Refer to \fBsmf\fR(5) and the \fISystem Administration -Guide: Basic Administration\fR for more information on SMF. -.sp -.LP -To modify parameters passed to \fBttymon\fR(1M), use \fBsvccfg\fR(1M) to modify -the SMF repository. See \fBttymon\fR(1M) for details on the available SMF -properties. -.sp -.LP -The \fBinittab\fR file is composed of entries that are position dependent and -have the following format: -.sp -.LP -\fIid\fR\fB:\fR\fIrstate\fR\fB:\fR\fIaction\fR\fB:\fR\fIprocess\fR -.sp -.LP -Each entry is delimited by a newline; however, a backslash (\e) preceding a -newline indicates a continuation of the entry. Up to 512 characters for each -entry are permitted. Comments may be inserted in the \fIprocess\fR field using -the convention for comments described in \fBsh\fR(1). There are no limits -(other than maximum entry size) imposed on the number of entries in the -\fBinittab\fR file. The entry fields are: -.sp -.ne 2 -.na -\fB\fIid\fR\fR -.ad -.RS 11n -One to four characters used to uniquely identify an entry. Do not use the -characters "r" or "t" as the first or only character in this field. These -characters are reserved for the use of \fBrlogin\fR(1) and \fBtelnet\fR(1). -.RE - -.sp -.ne 2 -.na -\fB\fIrstate\fR\fR -.ad -.RS 11n -Define the run level in which this entry is to be processed. Run-levels -effectively correspond to a configuration of processes in the system. That is, -each process spawned by \fBinit\fR is assigned a run level(s) in which it is -allowed to exist. The run levels are represented by a number ranging from -\fB0\fR through \fB6\fR. For example, if the system is in run level \fB1\fR, -only those entries having a \fB1\fR in the \fIrstate\fR field are processed. -.sp -When \fBinit\fR is requested to change run levels, all processes that do not -have an entry in the \fIrstate\fR field for the target run level are sent the -warning signal \fBSIGTERM\fR and allowed a 5-second grace period before being -forcibly terminated by the kill signal \fBSIGKILL\fR. The \fIrstate\fR field -can define multiple run levels for a process by selecting more than one run -level in any combination from \fB0\fR through \fB6\fR. If no run level is -specified, then the process is assumed to be valid at all run levels \fB0\fR -through \fB6\fR. -.sp -There are three other values, \fBa\fR, \fBb\fR and \fBc\fR, which can appear in -the \fIrstate\fR field, even though they are not true run levels. Entries which -have these characters in the \fIrstate\fR field are processed only when an -\fBinit\fR or \fBtelinit\fR process requests them to be run (regardless of the -current run level of the system). See \fBinit\fR(1M). These differ from run -levels in that \fBinit\fR can never enter run level \fBa\fR, \fBb\fR or -\fBc\fR. Also, a request for the execution of any of these processes does not -change the current run level. Furthermore, a process started by an \fBa\fR, -\fBb\fR or \fBc\fR command is not killed when \fBinit\fR changes levels. They -are killed only if their line in \fBinittab\fR is marked \fBoff\fR in the -\fIaction\fR field, their line is deleted entirely from \fBinittab\fR, or -\fBinit\fR goes into single-user state. -.RE - -.sp -.ne 2 -.na -\fB\fIaction\fR\fR -.ad -.RS 11n -Key words in this field tell \fBinit\fR how to treat the process specified in -the \fIprocess\fR field. The actions recognized by \fBinit\fR are as follows: -.sp -.ne 2 -.na -\fB\fBrespawn\fR\fR -.ad -.RS 13n -If the process does not exist, then start the process; do not wait for its -termination (continue scanning the \fBinittab\fR file), and when the process -dies, restart the process. If the process currently exists, do nothing and -continue scanning the \fBinittab\fR file. -.RE - -.sp -.ne 2 -.na -\fB\fBwait\fR\fR -.ad -.RS 13n -When \fBinit\fR enters the run level that matches the entry's \fIrstate\fR, -start the process and wait for its termination. All subsequent reads of the -\fBinittab\fR file while \fBinit\fR is in the same run level cause \fBinit\fR -to ignore this entry. -.RE - -.sp -.ne 2 -.na -\fB\fBonce\fR\fR -.ad -.RS 13n -When \fBinit\fR enters a run level that matches the entry's \fIrstate\fR, start -the process, do not wait for its termination. When it dies, do not restart the -process. If \fBinit\fR enters a new run level and the process is still running -from a previous run level change, the program is not restarted. -.RE - -.sp -.ne 2 -.na -\fB\fBboot\fR\fR -.ad -.RS 13n -The entry is to be processed only at \fBinit\fR's boot-time read of the -\fBinittab\fR file. \fBinit\fR is to start the process and not wait for its -termination; when it dies, it does not restart the process. In order for this -instruction to be meaningful, the \fIrstate\fR should be the default or it must -match \fBinit\fR's run level at boot time. This action is useful for an -initialization function following a hardware reboot of the system. -.RE - -.sp -.ne 2 -.na -\fB\fBbootwait\fR\fR -.ad -.RS 13n -The entry is to be processed the first time \fBinit\fR goes from single-user to -multi-user state after the system is booted. \fBinit\fR starts the process, -waits for its termination and, when it dies, does not restart the process. -.RE - -.sp -.ne 2 -.na -\fB\fBpowerfail\fR\fR -.ad -.RS 13n -Execute the process associated with this entry only when \fBinit\fR receives a -power fail signal, \fBSIGPWR\fR (see \fBsignal\fR(3C)). -.RE - -.sp -.ne 2 -.na -\fB\fBpowerwait\fR\fR -.ad -.RS 13n -Execute the process associated with this entry only when \fBinit\fR receives a -power fail signal, \fBSIGPWR\fR, and wait until it terminates before continuing -any processing of \fBinittab\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBoff\fR\fR -.ad -.RS 13n -If the process associated with this entry is currently running, send the -warning signal \fBSIGTERM\fR and wait 5 seconds before forcibly terminating the -process with the kill signal \fBSIGKILL\fR. If the process is nonexistent, -ignore the entry. -.RE - -.sp -.ne 2 -.na -\fB\fBondemand\fR\fR -.ad -.RS 13n -This instruction is really a synonym for the \fBrespawn\fR action. It is -functionally identical to \fBrespawn\fR but is given a different keyword in -order to divorce its association with run levels. This instruction is used only -with the \fBa\fR, \fBb\fR or \fBc\fR values described in the \fIrstate\fR -field. -.RE - -.sp -.ne 2 -.na -\fB\fBsysinit\fR\fR -.ad -.RS 13n -Entries of this type are executed before \fBinit\fR tries to access the console -(that is, before the \fBConsole Login:\fR prompt). It is expected that this -entry will be used only to initialize devices that \fBinit\fR might try to ask -the run level question. These entries are executed and \fBinit\fR waits for -their completion before continuing. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIprocess\fR\fR -.ad -.RS 11n -Specify a command to be executed. The entire \fBprocess\fR field is prefixed -with \fBexec\fR and passed to a forked \fBsh\fR as \fBsh \(mic 'exec\fR -\fBcommand\fR'. For this reason, any legal \fBsh\fR syntax can appear in the -\fIprocess\fR field. -.RE - -.SH SEE ALSO -.sp -.LP -\fBsh\fR(1), \fBwho\fR(1), \fBinit\fR(1M), \fBsvcadm\fR(1M), -\fBsvc.startd\fR(1M), \fBttymon\fR(1M), \fBexec\fR(2), \fBopen\fR(2), -\fBsignal\fR(3C), \fBsmf\fR(5) -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.SH NOTES -.sp -.LP -With the introduction of the service management facility, the system-provided -\fB/etc/inittab\fR file is greatly reduced from previous releases. -.sp -.LP -The \fBinitdefault\fR entry is not recognized in Solaris 10. See \fBsmf\fR(5) -for information on \fBSMF\fR milestones, and \fBsvcadm\fR(1M), which describes -the "\fBsvcadm\fR \fBmilestone\fR \fB-d\fR" command; this provides similar -functionality to modifying the \fBinitdefault\fR entry in previous versions of -the Solaris OS. diff --git a/usr/src/man/man4/ipaddrsel.conf.4 b/usr/src/man/man4/ipaddrsel.conf.4 deleted file mode 100644 index 070a64395e..0000000000 --- a/usr/src/man/man4/ipaddrsel.conf.4 +++ /dev/null @@ -1,67 +0,0 @@ -'\" te -.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved -.\" 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 IPADDRSEL.CONF 4 "Mar 6, 2003" -.SH NAME -ipaddrsel.conf \- IPv6 default address selection policy -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/ipaddrsel.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBipaddrsel.conf\fR file contains the IPv6 default address selection -policy table used for IPv6 source address selection and the sorting of -\fBAF_INET6\fR addresses returned from name to address resolution. The -mechanism for loading the file, the file format, and the meaning of the -contents are described in \fBipaddrsel\fR(1M). -.SH EXAMPLES -.LP -\fBExample 1 \fRDefault \fB/etc/inet/ipaddrsel.conf\fR File -.sp -.LP -The following is the default \fB/etc/inet/ipaddrsel.conf\fR file: - -.sp -.in +2 -.nf -# -#ident "@(#)ipv6das.conf 1.1 02/07/28 SMI" -# -# Copyright 2002 Sun Microsystems, Inc. All rights reserved. -# Use is subject to license terms. -# -# Prefix Precedence Label -::1/128 50 0 -::/0 40 1 -2002::/16 30 2 -::/96 20 3 -::ffff:0.0.0.0/96 10 4 -.fi -.in -2 - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBipaddrsel\fR(1M), \fBattributes\fR(5) diff --git a/usr/src/man/man4/ipf.4 b/usr/src/man/man4/ipf.4 deleted file mode 100644 index 9fde984978..0000000000 --- a/usr/src/man/man4/ipf.4 +++ /dev/null @@ -1,550 +0,0 @@ -'\" te -.\" To view license terms, attribution, and copyright for IP Filter, the -.\" default path is /usr/lib/ipf/IPFILTER.LICENCE. If the illumos operating -.\" environment has been installed anywhere other than the default, modify the -.\" given path to access the file at the installed location. -.\" Portions Copyright (c) 2015, Joyent, Inc. -.TH IPF 4 "Mar 18, 2015" -.SH NAME -ipf, ipf.conf, ipf6.conf \- IP packet filter rule syntax -.SH DESCRIPTION -A rule file for \fBipf\fP may have any name or even be stdin. As -\fBipfstat\fP produces parsable rules as output when displaying the internal -kernel filter lists, it is quite plausible to use its output to feed back -into \fBipf\fP. Thus, to remove all filters on input packets, the following -could be done: -.nf - -# ipfstat \-i | ipf \-rf \-\fP -.fi -.SH GRAMMAR -The format used by \fBipf\fP for construction of filtering rules can be -described using the following grammar in BNF: -.nf -filter-rule = [ insert ] action in-out [ options ] [ tos ] [ ttl ] - [ proto ] ip [ group ]. - -insert = "@" decnumber . -action = block | "pass" | log | "count" | skip | auth | call . -in-out = "in" | "out" . -options = [ log ] [ tag ] [ "quick" ] [ "on" interface-name [ dup ] - [ froute ] [ replyto ] ] . -tos = "tos" decnumber | "tos" hexnumber . -ttl = "ttl" decnumber . -proto = "proto" protocol . -ip = srcdst [ flags ] [ with withopt ] [ icmp ] [ keep ] . -group = [ "head" decnumber ] [ "group" decnumber ] . - -block = "block" [ return-icmp[return-code] | "return-rst" ] . -log = "log" [ "body" ] [ "first" ] [ "or-block" ] [ "level" loglevel ] . -tag = "tag" tagid . -skip = "skip" decnumber . -auth = "auth" | "preauth" . -call = "call" [ "now" ] function-name . -dup = "dup-to" interface-name [ ":" ipaddr ] . -froute = "fastroute" | "to" interface-name [ ":" ipaddr ] . -replyto = "reply-to" interface-name [ ":" ipaddr ] . -protocol = "tcp/udp" | "udp" | "tcp" | "icmp" | decnumber . -srcdst = "all" | fromto . -fromto = "from" [ "!" ] object "to" [ "!" ] object . - -return-icmp = "return-icmp" | "return-icmp-as-dest" . -return-code = "(" icmp-code ")" . -object = addr [ port-comp | port-range ] . -addr = "any" | nummask | host-name [ "mask" ipaddr | "mask" hexnumber ] . -addr = "any" | "<thishost>" | nummask | - host-name [ "mask" ipaddr | "mask" hexnumber ] . -port-comp = "port" compare port-num . -port-range = "port" port-num range port-num . -flags = "flags" flag { flag } [ "/" flag { flag } ] . -with = "with" | "and" . -icmp = "icmp-type" icmp-type [ "code" decnumber ] . -return-code = "(" icmp-code ")" . -keep = "keep" "state" [ "(" state-options ")" ] | "keep" "frags" . -loglevel = facility"."priority | priority . - -nummask = host-name [ "/" decnumber ] . -host-name = ipaddr | hostname | "any" . -ipaddr = host-num "." host-num "." host-num "." host-num . -host-num = digit [ digit [ digit ] ] . -port-num = service-name | decnumber . -state-options = state-opts [ "," state-options ] . - -state-opts = "age" decnumber [ "/" decnumber ] | "strict" | - "no-icmp-err" | "limit" decnumber | "newisn" | "sync" . -withopt = [ "not" | "no" ] opttype [ withopt ] . -opttype = "ipopts" | "short" | "frag" | "opt" optname . -optname = ipopts [ "," optname ] . -ipopts = optlist | "sec-class" [ secname ] . -secname = seclvl [ "," secname ] . -seclvl = "unclass" | "confid" | "reserv-1" | "reserv-2" | "reserv-3" | - "reserv-4" | "secret" | "topsecret" . -icmp-type = "unreach" | "echo" | "echorep" | "squench" | "redir" | - "timex" | "paramprob" | "timest" | "timestrep" | "inforeq" | - "inforep" | "maskreq" | "maskrep" | decnumber . -icmp-code = decumber | "net-unr" | "host-unr" | "proto-unr" | "port-unr" | - "needfrag" | "srcfail" | "net-unk" | "host-unk" | "isolate" | - "net-prohib" | "host-prohib" | "net-tos" | "host-tos" | - "filter-prohib" | "host-preced" | "cutoff-preced" . -optlist = "nop" | "rr" | "zsu" | "mtup" | "mtur" | "encode" | "ts" | - "tr" | "sec" | "lsrr" | "e-sec" | "cipso" | "satid" | "ssrr" | - "addext" | "visa" | "imitd" | "eip" | "finn" . -facility = "kern" | "user" | "mail" | "daemon" | "auth" | "syslog" | - "lpr" | "news" | "uucp" | "cron" | "ftp" | "authpriv" | - "audit" | "logalert" | "local0" | "local1" | "local2" | - "local3" | "local4" | "local5" | "local6" | "local7" . -priority = "emerg" | "alert" | "crit" | "err" | "warn" | "notice" | - "info" | "debug" . - -hexnumber = "0" "x" hexstring . -hexstring = hexdigit [ hexstring ] . -decnumber = digit [ decnumber ] . - -compare = "=" | "!=" | "<" | ">" | "<=" | ">=" | "eq" | "ne" | "lt" | - "gt" | "le" | "ge" . -range = "<>" | "><" . -hexdigit = digit | "a" | "b" | "c" | "d" | "e" | "f" . -digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" . -flag = "F" | "S" | "R" | "P" | "A" | "U" . -.fi -.PP -This syntax is somewhat simplified for readability, some combinations -that match this grammar are disallowed by the software because they do -not make sense (such as tcp \fBflags\fP for non-TCP packets). -.SH FILTER RULES -The "briefest" valid rules are (currently) no-ops and are of the form: -.nf - block in all - pass in all - log out all - count in all -.fi -.PP -Filter rules are checked in order, with the last matching rule -determining the fate of the packet (but see the \fBquick\fP option, -below). -.PP -Filters are installed by default at the end of the kernel's filter -lists, prepending the rule with \fB@n\fP will cause it to be inserted -as the n'th entry in the current list. This is especially useful when -modifying and testing active filter rulesets. See \fBipf\fP(1M) for more -information. -.SH ACTIONS -The action indicates what to do with the packet if it matches the rest -of the filter rule. Each rule MUST have an action. The following -actions are recognised: -.TP -.B block -indicates that the packet should be flagged to be dropped. In response -to blocking a packet, the filter may be instructed to send a reply -packet, either an ICMP packet (\fBreturn-icmp\fP), an ICMP packet -masquerading as being from the original packet's destination -(\fBreturn-icmp-as-dest\fP), or a TCP "reset" (\fBreturn-rst\fP). An -ICMP packet may be generated in response to any IP packet, and its -type may optionally be specified, but a TCP reset may only be used -with a rule which is being applied to TCP packets. When using -\fBreturn-icmp\fP or \fBreturn-icmp-as-dest\fP, it is possible to specify -the actual unreachable `type'. That is, whether it is a network -unreachable, port unreachable or even administratively -prohibited. This is done by enclosing the ICMP code associated with -it in parenthesis directly following \fBreturn-icmp\fP or -\fBreturn-icmp-as-dest\fP as follows: -.nf - block return-icmp(11) ... -.fi -.PP -Would return a Type-Of-Service (TOS) ICMP unreachable error. -.TP -.B pass -will flag the packet to be let through the filter. -.TP -.B log -causes the packet to be logged (as described in the LOGGING section -below) and has no effect on whether the packet will be allowed through -the filter. -.TP -.B count -causes the packet to be included in the accounting statistics kept by -the filter, and has no effect on whether the packet will be allowed through -the filter. These statistics are viewable with ipfstat(1M). -.TP -.B call -this action is used to invoke the named function in the kernel, which -must conform to a specific calling interface. Customised actions and -semantics can thus be implemented to supplement those available. This -feature is for use by knowledgeable hackers, and is not currently -documented. -.TP -.B "skip <n>" -causes the filter to skip over the next \fIn\fP filter rules. If a rule is -inserted or deleted inside the region being skipped over, then the value of -\fIn\fP is adjusted appropriately. -.TP -.B auth -this allows authentication to be performed by a user-space program running -and waiting for packet information to validate. The packet is held for a -period of time in an internal buffer whilst it waits for the program to return -to the kernel the \fIreal\fP flags for whether it should be allowed through -or not. Such a program might look at the source address and request some sort -of authentication from the user (such as a password) before allowing the -packet through or telling the kernel to drop it if from an unrecognised source. -.TP -.B preauth -tells the filter that for packets of this class, it should look in the -pre-authenticated list for further clarification. If no further matching -rule is found, the packet will be dropped (the FR_PREAUTH is not the same -as FR_PASS). If a further matching rule is found, the result from that is -used in its instead. This might be used in a situation where a person -\fIlogs in\fP to the firewall and it sets up some temporary rules defining -the access for that person. -.PP -The next word must be either \fBin\fP or \fBout\fP. Each packet -moving through the kernel is either inbound (just been received on an -interface, and moving towards the kernel's protocol processing) or -outbound (transmitted or forwarded by the stack, and on its way to an -interface). There is a requirement that each filter rule explicitly -state which side of the I/O it is to be used on. -.SH OPTIONS -The list of options is brief, and all are indeed optional. Where -options are used, they must be present in the order shown here. These -are the currently supported options: -.TP -.B log -indicates that, should this be the last matching rule, the packet -header will be written to the \fBipl\fP log (as described in the -LOGGING section below). -.TP -.B tag tagid -indicates that, if this rule causes the packet to be logged or entered -in the state table, the tagid will be logged as part of the log entry. -This can be used to quickly match "similar" rules in scripts that post -process the log files for e.g. generation of security reports or accounting -purposes. The tagid is a 32 bit unsigned integer. -.TP -.B quick -allows "short-cut" rules in order to speed up the filter or override -later rules. If a packet matches a filter rule which is marked as -\fBquick\fP, this rule will be the last rule checked, allowing a -"short-circuit" path to avoid processing later rules for this -packet. The current status of the packet (after any effects of the -current rule) will determine whether it is passed or blocked. -.IP -If this option is missing, the rule is taken to be a "fall-through" -rule, meaning that the result of the match (block/pass) is saved and -that processing will continue to see if there are any more matches. -.TP -.B on -allows an interface name to be incorporated into the matching -procedure. Interface names are as printed by "netstat \-i". If this -option is used, the rule will only match if the packet is going -through that interface in the specified direction (in/out). If this -option is absent, the rule is taken to be applied to a packet -regardless of the interface it is present on (i.e. on all interfaces). -Filter rulesets are common to all interfaces, rather than having a -filter list for each interface. -.IP -This option is especially useful for simple IP-spoofing protection: -packets should only be allowed to pass inbound on the interface from -which the specified source address would be expected, others may be -logged and/or dropped. -.TP -.B dup-to -causes the packet to be copied, and the duplicate packet to be sent -outbound on the specified interface, optionally with the destination -IP address changed to that specified. This is useful for off-host -logging, using a network sniffer. -.TP -.B to -causes the packet to be moved to the outbound queue on the -specified interface. This can be used to circumvent kernel routing -decisions, and even to bypass the rest of the kernel processing of the -packet (if applied to an inbound rule). It is thus possible to -construct a firewall that behaves transparently, like a filtering hub -or switch, rather than a router. The \fBfastroute\fP keyword is a -synonym for this option. -.SH MATCHING PARAMETERS -The keywords described in this section are used to describe attributes -of the packet to be used when determining whether rules match or don't -match. The following general-purpose attributes are provided for -matching, and must be used in this order: -.TP -.B tos -packets with different Type-Of-Service values can be filtered. -Individual service levels or combinations can be filtered upon. The -value for the TOS mask can either be represented as a hex number or a -decimal integer value. -.TP -.B ttl -packets may also be selected by their Time-To-Live value. The value given in -the filter rule must exactly match that in the packet for a match to occur. -This value can only be given as a decimal integer value. -.TP -.B proto -allows a specific protocol to be matched against. All protocol names -found in \fB/etc/protocols\fP are recognised and may be used. -However, the protocol may also be given as a DECIMAL number, allowing -for rules to match your own protocols, or new ones which would -out-date any attempted listing. -.IP -The special protocol keyword \fBtcp/udp\fP may be used to match either -a TCP or a UDP packet, and has been added as a convenience to save -duplication of otherwise-identical rules. -.\" XXX grammar should reflect this (/etc/protocols) -.PP -The \fBfrom\fP and \fBto\fP keywords are used to match against IP -addresses (and optionally port numbers). Rules must specify BOTH -source and destination parameters. -.PP -IP addresses may be specified in one of two ways: as a numerical -address\fB/\fPmask, or as a hostname \fBmask\fP netmask. The hostname -may either be a valid hostname, from either the hosts file or DNS -(depending on your configuration and library) or of the dotted numeric -form. There is no special designation for networks but network names -are recognised. Note that having your filter rules depend on DNS -results can introduce an avenue of attack, and is discouraged. -.PP -There is a special case for the hostname \fBany\fP which is taken to -be 0.0.0.0/0 (see below for mask syntax) and matches all IP addresses. -Only the presence of "any" has an implied mask, in all other -situations, a hostname MUST be accompanied by a mask. It is possible -to give "any" a hostmask, but in the context of this language, it is -non-sensical. -.PP -The numerical format "x\fB/\fPy" indicates that a mask of y -consecutive 1 bits set is generated, starting with the MSB, so a y value -of 16 would give 0xffff0000. The symbolic "x \fBmask\fP y" indicates -that the mask y is in dotted IP notation or a hexadecimal number of -the form 0x12345678. Note that all the bits of the IP address -indicated by the bitmask must match the address on the packet exactly; -there isn't currently a way to invert the sense of the match, or to -match ranges of IP addresses which do not express themselves easily as -bitmasks (anthropomorphization; it's not just for breakfast anymore). -.PP -If a \fBport\fP match is included, for either or both of source and -destination, then it is only applied to -.\" XXX - "may only be" ? how does this apply to other protocols? will it not match, or will it be ignored? -TCP and UDP packets. If there is no \fBproto\fP match parameter, -packets from both protocols are compared. This is equivalent to "proto -tcp/udp". When composing \fBport\fP comparisons, either the service -name or an integer port number may be used. Port comparisons may be -done in a number of forms, with a number of comparison operators, or -port ranges may be specified. When the port appears as part of the -\fBfrom\fP object, it matches the source port number, when it appears -as part of the \fBto\fP object, it matches the destination port number. -See the examples for more information. -.PP -The \fBall\fP keyword is essentially a synonym for "from any to any" -with no other match parameters. -.PP -Following the source and destination matching parameters, the -following additional parameters may be used: -.TP -.B with -is used to match irregular attributes that some packets may have -associated with them. To match the presence of IP options in general, -use \fBwith ipopts\fP. To match packets that are too short to contain -a complete header, use \fBwith short\fP. To match fragmented packets, -use \fBwith frag\fP. For more specific filtering on IP options, -individual options can be listed. -.IP -Before any parameter used after the \fBwith\fP keyword, the word -\fBnot\fP or \fBno\fP may be inserted to cause the filter rule to only -match if the option(s) is not present. -.IP -Multiple consecutive \fBwith\fP clauses are allowed. Alternatively, -the keyword \fBand\fP may be used in place of \fBwith\fP, this is -provided purely to make the rules more readable ("with ... and ..."). -When multiple clauses are listed, all those must match to cause a -match of the rule. -.\" XXX describe the options more specifically in a separate section -.TP -.B flags -is only effective for TCP filtering. Each of the letters possible -represents one of the possible flags that can be set in the TCP -header. The association is as follows: -.LP -.nf - F - FIN - S - SYN - R - RST - P - PUSH - A - ACK - U - URG -.fi -.IP -The various flag symbols may be used in combination, so that "SA" -would represent a SYN-ACK combination present in a packet. There is -nothing preventing the specification of combinations, such as "SFR", -that would not normally be generated by law-abiding TCP -implementations. However, to guard against weird aberrations, it is -necessary to state which flags you are filtering against. To allow -this, it is possible to set a mask indicating which TCP flags you wish -to compare (i.e., those you deem significant). This is done by -appending "/<flags>" to the set of TCP flags you wish to match -against, e.g.: -.LP -.nf - ... flags S - # becomes "flags S/AUPRFS" and will match - # packets with ONLY the SYN flag set. - - ... flags SA - # becomes "flags SA/AUPRFS" and will match any - # packet with only the SYN and ACK flags set. - - ... flags S/SA - # will match any packet with just the SYN flag set - # out of the SYN-ACK pair; the common "establish" - # keyword action. "S/SA" will NOT match a packet - # with BOTH SYN and ACK set, but WILL match "SFP". -.fi -.TP -.B icmp-type -is only effective when used with \fBproto icmp\fP and must NOT be used -in conjunction with \fBflags\fP. There are a number of types, which can be -referred to by an abbreviation recognised by this language, or the numbers -with which they are associated can be used. The most important from -a security point of view is the ICMP redirect. -.SH KEEP HISTORY -The second last parameter which can be set for a filter rule is whether or not -to record historical information for that packet, and what sort to keep. The -following information can be kept: -.TP -.B state -keeps information about the flow of a communication session. State can -be kept for TCP, UDP, and ICMP packets. -.TP -.B frags -keeps information on fragmented packets, to be applied to later -fragments. -.PP -allowing packets which match these to flow straight through, rather -than going through the access control list. -.SH GROUPS -The last pair of parameters control filter rule "grouping". By default, all -filter rules are placed in group 0 if no other group is specified. To add a -rule to a non-default group, the group must first be started by creating a -group \fIhead\fP. If a packet matches a rule which is the \fIhead\fP of a -group, the filter processing then switches to the group, using that rule as -the default for the group. If \fBquick\fP is used with a \fBhead\fP rule, rule -processing isn't stopped until it has returned from processing the group. -.PP -A rule may be both the head for a new group and a member of a non-default -group (\fBhead\fP and \fBgroup\fP may be used together in a rule). -.TP -.B "head <n>" -indicates that a new group (number n) should be created. -.TP -.B "group <n>" -indicates that the rule should be put in group (number n) rather than group 0. -.SH LOGGING -When a packet is logged, with either the \fBlog\fP action or option, -the headers of the packet are written to the \fBipl\fP packet logging -pseudo-device. Immediately following the \fBlog\fP keyword, the -following qualifiers may be used (in order): -.TP -.B body -indicates that the first 128 bytes of the packet contents will be -logged after the headers. -.TP -.B first -If log is being used in conjunction with a "keep" option, it is recommended -that this option is also applied so that only the triggering packet is logged -and not every packet which thereafter matches state information. -.TP -.B or-block -indicates that, if for some reason the filter is unable to log the -packet (such as the log reader being too slow) then the rule should be -interpreted as if the action was \fBblock\fP for this packet. -.TP -.B "level <loglevel>" -indicates what logging facility and priority, or just priority with -the default facility being used, will be used to log information about -this packet using ipmon's -s option. -.PP -See ipl(4) for the format of records written -to this device. The ipmon(1M) program can be used to read and format -this log. -.SH EXAMPLES -The \fBquick\fP option is good for rules such as: -.nf -block in quick from any to any with ipopts -.fi -.PP -which will match any packet with a non-standard header length (IP -options present) and abort further processing of later rules, -recording a match and also that the packet should be blocked. -.PP -The "fall-through" rule parsing allows for effects such as this: -.LP -.nf - block in from any to any port < 6000 - pass in from any to any port >= 6000 - block in from any to any port > 6003 -.fi -.PP -which sets up the range 6000-6003 as being permitted and all others being -denied. Note that the effect of the first rule is overridden by subsequent -rules. Another (easier) way to do the same is: -.LP -.nf - block in from any to any port 6000 <> 6003 - pass in from any to any port 5999 >< 6004 -.fi -.PP -Note that both the "block" and "pass" are needed here to effect a -result as a failed match on the "block" action does not imply a pass, -only that the rule hasn't taken effect. To then allow ports < 1024, a -rule such as: -.LP -.nf - pass in quick from any to any port < 1024 -.fi -.PP -would be needed before the first block. To create a new group for -processing all inbound packets on le0/le1/lo0, with the default being to block -all inbound packets, we would do something like: -.LP -.nf - block in all - block in quick on le0 all head 100 - block in quick on le1 all head 200 - block in quick on lo0 all head 300 -.fi -.PP -and to then allow ICMP packets in on le0, only, we would do: -.LP -.nf - pass in proto icmp all group 100 -.fi -.PP -Note that because only inbound packets on le0 are used processed by group 100, -there is no need to respecify the interface name. Likewise, we could further -breakup processing of TCP, etc, as follows: -.LP -.nf - block in proto tcp all head 110 group 100 - pass in from any to any port = 23 group 110 -.fi -.PP -and so on. The last line, if written without the groups would be: -.LP -.nf - pass in on le0 proto tcp from any to any port = telnet -.fi -.PP -Note, that if we wanted to say "port = telnet", "proto tcp" would -need to be specified as the parser interprets each rule on its own and -qualifies all service/port names with the protocol specified. -.SH FILES -/dev/ipauth -.br -/dev/ipl -.br -/dev/ipstate -.br -/etc/hosts -.br -/etc/services -.SH SEE ALSO -\fBipnat\fR(4), \fBipf\fR(1M), \fBipfstat\fR(1M), \fBipfilter\fR(5) diff --git a/usr/src/man/man4/ipmon.4 b/usr/src/man/man4/ipmon.4 deleted file mode 100644 index 22b46ee3e8..0000000000 --- a/usr/src/man/man4/ipmon.4 +++ /dev/null @@ -1,72 +0,0 @@ -'\" te -.\" To view license terms, attribution, and copyright for IP Filter, the -.\" default path is /usr/lib/ipf/IPFILTER.LICENCE. If the Illumos operating -.\" environment has been installed anywhere other than the default, modify the -.\" given path to access the file at the installed location. -.\" Portions Copyright (c) 2015, Joyent, Inc. -.TH IPMON 4 "Mar 18, 2015" -.SH NAME -ipmon, ipmon.conf \- ipmon configuration file format -.SH DESCRIPTION -The format for files accepted by ipmon is described by the following grammar: -.LP -.nf -"match" "{" matchlist "}" "do" "{" doing "}" ";" - -matchlist ::= matching [ "," matching ] . -matching ::= direction | dstip | dstport | every | group | interface | - logtag | nattag | protocol | result | rule | srcip | srcport . - -dolist ::= doing [ "," doing ] . -doing ::= execute | save | syslog . - -direction ::= "in" | "out" . -dstip ::= "dstip" "=" ipv4 "/" number . -dstport ::= "dstport" "=" number . -every ::= "every" every-options . -execute ::= "execute" "=" string . -group ::= "group" "=" string | "group" "=" number . -interface ::= "interface" "=" string . -logtag ::= "logtag" "=" string | "logtag" "=" number . -nattag ::= "nattag" "=" string . -protocol ::= "protocol" "=" string | "protocol" "=" number . -result ::= "result" "=" result-option . -rule ::= "rule" "=" number . -srcip ::= "srcip" "=" ipv4 "/" number . -srcport ::= "srcport" "=" number . -type ::= "type" "=" ipftype . -ipv4 ::= number "." number "." number "." number . - -every-options ::= "second" | number "seconds" | "packet" | number "packets" . -result-option ::= "pass" | "block" | "short" | "nomatch" | "log" . -ipftype ::= "ipf" | "nat" | "state" . - -.fi -.PP -In addition, lines that start with a # are considered to be comments. -.SH OVERVIEW -.PP -The ipmon configuration file is used for defining rules to be executed when -logging records are read from -.B /dev/ipl. -.PP -At present, only IPv4 matching is available for source/destination address -matching. -.SH MATCHING -.PP -Each rule for ipmon consists of two primary segments: the first describes how -the log record is to be matched, the second defines what action to take if -there is a positive match. All entries of the rules present in the file are -compared for matches - there is no first or last rule match. -.SH FILES -/dev/ipl -.br -/dev/ipf -.br -/dev/ipnat -.br -/dev/ipstate -.br -/etc/ipmon.conf -.SH SEE ALSO -\fBipmon\fR(1M), \fBipfilter\fR(5) diff --git a/usr/src/man/man4/ipnat.4 b/usr/src/man/man4/ipnat.4 deleted file mode 100644 index 6c3f0f85cf..0000000000 --- a/usr/src/man/man4/ipnat.4 +++ /dev/null @@ -1,295 +0,0 @@ -'\" te -.\" To view license terms, attribution, and copyright for IP Filter, the -.\" default path is /usr/lib/ipf/IPFILTER.LICENCE. If the Illumos operating -.\" environment has been installed anywhere other than the default, modify the -.\" given path to access the file at the installed location. -.\" Portions Copyright (c) 2015, Joyent, Inc. -.TH IPNAT 4 "Mar 18, 2015" -.SH NAME -ipnat, ipnat.conf \- IP NAT file format -.SH DESCRIPTION -The format for files accepted by ipnat is described by the following grammar: -.LP -.nf -ipmap :: = mapblock | redir | map . - -map ::= mapit ifname lhs "->" dstipmask [ mapicmp | mapport | mapproxy ] - mapoptions . -mapblock ::= "map-block" ifname lhs "->" ipmask [ ports ] mapoptions . -redir ::= "rdr" ifname rlhs "->" ip [ "," ip ] rdrport rdroptions . - -lhs ::= ipmask | fromto . -rlhs ::= ipmask dport | fromto . -dport ::= "port" portnum [ "-" portnum ] . -ports ::= "ports" numports | "auto" . -rdrport ::= "port" portnum . -mapit ::= "map" | "bimap" . -fromto ::= "from" object "to" object . -ipmask ::= ip "/" bits | ip "/" mask | ip "netmask" mask . -dstipmask ::= ipmask | "range" ip "-" ip . -mapicmp ::= "icmpidmap" "icmp" number ":" number . -mapport ::= "portmap" tcpudp portspec . -mapoptions ::= [ tcpudp ] [ "frag" ] [ age ] [ clamp ] . -rdroptions ::= rdrproto [ rr ] [ "frag" ] [ age ] [ clamp ] [ rdrproxy ] . - -object :: = addr [ port-comp | port-range ] . -addr :: = "any" | nummask | host-name [ "mask" ipaddr | "mask" hexnumber ] . -port-comp :: = "port" compare port-num . -port-range :: = "port" port-num range port-num . -rdrproto ::= tcpudp | protocol . - -rr ::= "round-robin" . -age ::= "age" decnumber [ "/" decnumber ] . -clamp ::= "mssclamp" decnumber . -tcpudp ::= "tcp/udp" | protocol . -mapproxy ::= "proxy" "port" port proxy-name '/' protocol -rdrproxy ::= "proxy" proxy-name . - -protocol ::= protocol-name | decnumber . -nummask ::= host-name [ "/" decnumber ] . -portspec ::= "auto" | portnumber ":" portnumber . -port ::= portnumber | port-name . -portnumber ::= number { numbers } . -ifname ::= 'A' - 'Z' { 'A' - 'Z' } numbers . - -numbers ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' . -.fi -.PP -For standard NAT functionality, a rule should start with \fBmap\fP and then -proceeds to specify the interface for which outgoing packets will have their -source address rewritten. -.PP -Packets which will be rewritten can only be selected by matching the original -source address. A netmask must be specified with the IP address. -.PP -The address selected for replacing the original is chosen from an IP#/netmask -pair. A netmask of all 1's indicating a hostname is valid. A netmask of -31 1's (255.255.255.254) is considered invalid as there is no space for -allocating host IP#'s after consideration for broadcast and network -addresses. -.PP -When remapping TCP and UDP packets, it is also possible to change the source -port number. Either TCP or UDP or both can be selected by each rule, with a -range of port numbers to remap into given as \fBport-number:port-number\fP. -.SH COMMANDS -There are four commands recognised by IP Filter's NAT code: -.TP -.B map -that is used for mapping one address or network to another in an unregulated -round robin fashion; -.TP -.B rdr -that is used for redirecting packets to one IP address and port pair to -another; -.TP -.B bimap -for setting up bidirectional NAT between an external IP address and an internal -IP address and -.TP -.B map-block -which sets up static IP address based translation, based on a algorithm to -squeeze the addresses to be translated into the destination range. -.SH MATCHING -.PP -For basic NAT and redirection of packets, the address subject to change is used -along with its protocol to check if a packet should be altered. The packet -\fImatching\fP part of the rule is to the left of the "->" in each rule. -.PP -Matching of packets has now been extended to allow more complex compares. -In place of the address which is to be translated, an IP address and port -number comparison can be made using the same expressions available with -\fBipf\fP. A simple NAT rule could be written as: -.LP -.nf -map de0 10.1.0.0/16 -> 201.2.3.4/32 -.fi -.LP -or as -.LP -.nf -map de0 from 10.1.0.0/16 to any -> 201.2.3.4/32 -.fi -.LP -Only IP address and port numbers can be compared against. This is available -with all NAT rules. -.SH TRANSLATION -.PP -To the right of the "->" is the address and port specification which will be -written into the packet providing it has already successfully matched the -prior constraints. The case of redirections (\fBrdr\fP) is the simplest: -the new destination address is that specified in the rule. For \fBmap\fP -rules, the destination address will be one for which the tuple combining -the new source and destination is known to be unique. If the packet is -either a TCP or UDP packet, the destination and source ports come into the -equation too. If the tuple already exists, IP Filter will increment the -port number first, within the available range specified with \fBportmap\fP -and if there exists no unique tuple, the source address will be incremented -within the specified netmask. If a unique tuple cannot be determined, then -the packet will not be translated. The \fBmap-block\fP is more limited in -how it searches for a new, free and unique tuple, in that it will used an -algorithm to determine what the new source address should be, along with the -range of available ports - the IP address is never changed and nor does the -port number ever exceed its allotted range. -.SH ICMPIDMAP -.PP -ICMP messages can be divided into two groups: "errors" and "queries". ICMP -errors are generated as a response of another IP packet. IP Filter will take -care that ICMP errors that are the response of a NAT-ed IP packet are -handled properly. -.PP -For 4 types of ICMP queries (echo request, timestamp request, information -request and address mask request) IP Filter supports an additional mapping -called "ICMP id mapping". All these 4 types of ICMP queries use a unique -identifier called the ICMP id. This id is set by the process sending the -ICMP query and it is usually equal to the process id. The receiver of the -ICMP query will use the same id in its response, thus enabling the -sender to recognize that the incoming ICMP reply is intended for him and is -an answer to a query that he made. The "ICMP id mapping" feature modifies -these ICMP id in a way identical to \fBportmap\fP for TCP or UDP. -.PP -The reason that you might want this, is that using this feature you don't -need an IP address per host behind the NAT box, that wants to do ICMP queries. -The two numbers behind the \fBicmpidmap\fP keyword are the first and the -last icmp id number that can be used. There is one important caveat: if you -map to an IP address that belongs to the NAT box itself (notably if you have -only a single public IP address), then you must ensure that the NAT box does -not use the \fBicmpidmap\fP range that you specified in the \fBmap\fP rule. -.SH KERNEL PROXIES -.PP -IP Filter comes with a few, simple, proxies built into the code that is loaded -into the kernel to allow secondary channels to be opened without forcing the -packets through a user program. The current state of the proxies is listed -below, as one of three states: -.HP -Aging - protocol is roughly understood from -the time at which the proxy was written but it is not well tested or -maintained; -.HP -Developmental - basic functionality exists, works most of the time but -may be problematic in extended real use; -.HP -Experimental - rough support for the protocol at best, may or may not -work as testing has been at best sporadic, possible large scale changes -to the code in order to properly support the protocol. -.HP -Mature - well tested, protocol is properly -understood by the proxy; -.PP -The currently compiled in proxy list is as follows: -.HP -FTP - Mature -.HP -IRC - Experimental -.HP -rpcbind - Experimental -.HP -H.323 - Experimental -.HP -Real Audio (PNA) - Aging -.HP -IPsec - Developmental -.HP -netbios - Experimental -.HP -R-command - Mature - -.SH TRANSPARENT PROXIES -.PP -True transparent proxying should be performed using the redirect (\fBrdr\fP) -rules directing ports to localhost (127.0.0.1) with the proxy program doing -a lookup through \fB/dev/ipnat\fP to determine the real source and address -of the connection. -.SH LOAD-BALANCING -.PP -Two options for use with \fBrdr\fP are available to support primitive, -\fIround-robin\fP based load balancing. The first option allows for a -\fBrdr\fP to specify a second destination, as follows: -.LP -.nf -rdr le0 203.1.2.3/32 port 80 -> 203.1.2.3,203.1.2.4 port 80 tcp -.fi -.LP -This would send alternate connections to either 203.1.2.3 or 203.1.2.4. -In scenarios where the load is being spread amongst a larger set of -servers, you can use: -.LP -.nf -rdr le0 203.1.2.3/32 port 80 -> 203.1.2.3,203.1.2.4 port 80 tcp round-robin -rdr le0 203.1.2.3/32 port 80 -> 203.1.2.5 port 80 tcp round-robin -.fi -.LP -In this case, a connection will be redirected to 203.1.2.3, then 203.1.2.4 -and then 203.1.2.5 before going back to 203.1.2.3. In accomplishing this, -the rule is removed from the top of the list and added to the end, -automatically, as required. This will not effect the display of rules -using "ipnat -l", only the internal application order. -.SH EXAMPLES -.PP -This section deals with the \fBmap\fP command and its variations. -.PP -To change IP#'s used internally from network 10 into an ISP provided 8 bit -subnet at 209.1.2.0 through the ppp0 interface, the following would be used: -.LP -.nf -map ppp0 10.0.0.0/8 -> 209.1.2.0/24 -.fi -.PP -The obvious problem here is we're trying to squeeze over 16,000,000 IP -addresses into a 254 address space. To increase the scope, remapping for TCP -and/or UDP, port remapping can be used; -.LP -.nf -map ppp0 10.0.0.0/8 -> 209.1.2.0/24 portmap tcp/udp 1025:65000 -.fi -.PP -which falls only 527,566 `addresses' short of the space available in network -10. If we were to combine these rules, they would need to be specified as -follows: -.LP -.nf -map ppp0 10.0.0.0/8 -> 209.1.2.0/24 portmap tcp/udp 1025:65000 -map ppp0 10.0.0.0/8 -> 209.1.2.0/24 -.fi -.PP -so that all TCP/UDP packets were port mapped and only other protocols, such as -ICMP, only have their IP# changed. In some instances, it is more appropriate -to use the keyword \fBauto\fP in place of an actual range of port numbers if -you want to guarantee simultaneous access to all within the given range. -However, in the above case, it would default to 1 port per IP address, since -we need to squeeze 24 bits of address space into 8. A good example of how -this is used might be: -.LP -.nf -map ppp0 172.192.0.0/16 -> 209.1.2.0/24 portmap tcp/udp auto -.fi -.PP -which would result in each IP address being given a small range of ports to -use (252). In all cases, the new port number that is used is deterministic. -That is, port X will always map to port Y. -WARNING: It is not advisable to use the \fBauto\fP feature if you are map'ing -to a /32 (i.e. 0/32) because the NAT code will try to map multiple hosts to -the same port number, outgoing and ultimately this will only succeed for one -of them. -The problem here is that the \fBmap\fP directive tells the NAT -code to use the next address/port pair available for an outgoing connection, -resulting in no easily discernible relation between external addresses/ports -and internal ones. This is overcome by using \fBmap-block\fP as follows: -.LP -.nf -map-block ppp0 172.192.0.0/16 -> 209.1.2.0/24 ports auto -.fi -.PP -For example, this would result in 172.192.0.0/24 being mapped to 209.1.2.0/32 -with each address, from 172.192.0.0 to 172.192.0.255 having 252 ports of its -own. As opposed to the above use of \fBmap\fP, if for some reason the user -of (say) 172.192.0.2 wanted 260 simultaneous connections going out, they would -be limited to 252 with \fBmap-block\fP but would just \fImove on\fP to the next -IP address with the \fBmap\fP command. -/dev/ipnat -.br -/etc/services -.br -/etc/hosts -.SH SEE ALSO -\fBhosts\fR(4), \fBipf\fR(4), \fBservices\fR(4), \fBipf\fR(1M), -\fBipnat\fR(1M), \fBipfilter\fR(5) diff --git a/usr/src/man/man4/ipnodes.4 b/usr/src/man/man4/ipnodes.4 deleted file mode 100644 index 413a5cdcf9..0000000000 --- a/usr/src/man/man4/ipnodes.4 +++ /dev/null @@ -1,25 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 IPNODES 4 "Aug 15, 2006" -.SH NAME -ipnodes \- symbolic link to hosts database -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/ipnodes\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBipnodes\fR file is now a symbolic link to the \fB/etc/hosts\fR file. See -\fBhosts\fR(4). In prior releases of the Solaris operating system, -\fBipnodes\fR was a local database distinct from \fBhosts\fR. The man page for -a given Solaris release describes the \fBipnodes\fR file for that release. -.SH SEE ALSO -.sp -.LP -\fBhosts\fR(4) diff --git a/usr/src/man/man4/ippool.4 b/usr/src/man/man4/ippool.4 deleted file mode 100644 index 1b6586a4b0..0000000000 --- a/usr/src/man/man4/ippool.4 +++ /dev/null @@ -1,156 +0,0 @@ -'\" te -.\" To view license terms, attribution, and copyright for IP Filter, the -.\" default path is /usr/lib/ipf/IPFILTER.LICENCE. If the illumos operating -.\" environment has been installed anywhere other than the default, modify the -.\" given path to access the file at the installed location. -.\" Portions Copyright (c) 2015, Joyent, Inc. -.TH IPPOOL 4 "May 16, 2020" -.SH NAME -ippool, ippool.conf \- IP Pool file format -.SH DESCRIPTION -The format for files accepted by ippool is described by the following grammar: -.LP -.nf -line ::= table | groupmap . -table ::= "table" role tabletype . -groupmap ::= "group-map" inout role number ipfgroup -tabletype ::= ipftree | ipfhash . - -role ::= "role" "=" "ipf" . -inout ::= "in" | "out" . - -ipftree ::= "type" "=" "tree" number "{" addrlist "}" . -ipfhash ::= "type" "=" "hash" number hashopts "{" hashlist "}" . - -ipfgroup ::= setgroup hashopts "{" grouplist "}" | - hashopts "{" setgrouplist "}" . -setgroup ::= "group" "=" groupname . - -hashopts ::= size [ seed ] | seed . - -size ::= "size" number . -seed ::= "seed" number . - -addrlist ::= [ "!" ] addrmask ";" [ addrlist ] . -grouplist ::= groupentry ";" [ grouplist ] | addrmask ";" [ grouplist ] . - -setgrouplist ::= groupentry ";" [ setgrouplist ] . - -groupentry ::= addrmask "," setgroup . - -hashlist ::= hashentry ";" [ hashlist ] . -hashentry ::= addrmask . - -addrmask ::= ipaddr | ipaddr "/" mask . - -mask ::= number | ipaddr . - -groupname ::= number | name . - -number ::= digit { digit } . - -ipaddr = host-num "." host-num "." host-num "." host-num . -host-num = digit [ digit [ digit ] ] . - -digit ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" . -name ::= letter { letter | digit } . -.fi -.PP -The IP pool configuration file is used for defining a single object that -contains a reference to multiple IP address/netmask pairs. A pool may consist -of a mixture of netmask sizes, from 0 to 32. -.PP -At this point in time, only IPv4 addressing is supported. -.SH OVERVIEW -The IP pool configuration file provides for defining two different mechanisms -for improving speed in matching IP addresses with rules. -The first, -.B table -, defines a lookup -.I table -to provide a single reference in a -filter rule to multiple targets and the second, -.B group-map -, provides a mechanism to target multiple groups from a single filter line. -.PP -The -.B group-map -command can only be used with filter rules that use the -.B call -command to invoke either -.B fr_srcgrpmap -or -.B fr_dstgrpmap -, to use the source or destination address, -respectively, for determining which filter group to jump to next for -continuation of filter packet processing. -.SH POOL TYPES -Two storage formats are provided: hash tables and tree structure. The hash -table is intended for use with objects all containing the same netmask or a -few different sized netmasks of non-overlapping address space and the tree -is designed for being able to support exceptions to a covering mask, in -addition to normal searching as you would do with a table. It is not possible -to use the tree data storage type with -.B group-map -configuration entries. -.SH POOL ROLES -When a pool is defined in the configuration file, it must have an associated -role. At present the only supported role is -.B ipf. -Future development will see further expansion of their use by other sections -of IPFilter code. -.SH EXAMPLES -The following examples show how the pool configuration file is used with -the ipf configuration file to enhance the ability for the ipf configuration -file to be succinct in meaning. -.TP -1 -The first example shows how a filter rule makes reference to a specific -pool for matching of the source address. -.nf -pass in from pool/100 to any -.fi -.PP -The pool configuration, which matches IP addresses 1.1.1.1 and any -in 2.2.0.0/16, except for those in 2.2.2.0/24. -.PP -.nf -table role = ipf type = tree number = 100 - { 1.1.1.1/32; 2.2.0.0/16; !2.2.2.0/24 }; -.fi -.TP -2 -The following ipf.conf extract uses the -fr_srcgrpmap/fr_dstgrpmap lookups to use the -.B group-map -facility to lookup the next group to use for filter processing, providing -the -.B call -filter rule is matched. -.nf -call now fr_srcgrpmap/1010 in all -call now fr_dstgrpmap/2010 out all -pass in all group 1020 -block in all group 1030 -pass out all group 2020 -block out all group 2040 -.fi -.PP -A ippool configuration to work with the above ipf.conf file might -look like this: -.PP -.nf -group-map in role = ipf number = 1010 - { 1.1.1.1/32, group = 1020; 3.3.0.0/16, group = 1030; }; -group-map out role = ipf number = 2010 group = 2020 - { 2.2.2.2/32; 4.4.0.0/16; 5.0.0.0/8, group = 2040; }; -.fi -.SH FILES -/dev/iplookup -.br -/etc/ippool.conf -.br -/etc/hosts -.SH SEE ALSO -\fBippool\fR(1M), \fBhosts\fR(4), \fBipf\fR(4), \fBipf\fR(1M), \fBipnat\fR(1M), -\fBipfilter\fR(5) diff --git a/usr/src/man/man4/issue.4 b/usr/src/man/man4/issue.4 deleted file mode 100644 index e927815312..0000000000 --- a/usr/src/man/man4/issue.4 +++ /dev/null @@ -1,29 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T, Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 ISSUE 4 "Jan 2, 2002" -.SH NAME -issue \- issue identification file -.SH DESCRIPTION -.sp -.LP -The file \fB/etc/issue\fR contains the issue or project identification to be -printed as a login prompt. \fBissue\fR is an ASCII file that is read by program -\fBttymon\fR and then written to any terminal spawned or respawned, prior to -the normal prompt. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/issue\fR\fR -.ad -.RS 14n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBlogin\fR(1), \fBttymon\fR(1M) diff --git a/usr/src/man/man4/kadm5.acl.4 b/usr/src/man/man4/kadm5.acl.4 deleted file mode 100644 index 25e8a76e22..0000000000 --- a/usr/src/man/man4/kadm5.acl.4 +++ /dev/null @@ -1,395 +0,0 @@ -'\" te -.\" Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved -.\" 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 KADM5.ACL 4 "Oct 29, 2015" -.SH NAME -kadm5.acl \- Kerberos access control list (ACL) file -.SH SYNOPSIS -.LP -.nf -\fB/etc/krb5/kadm5.acl\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBACL\fR file is used by the \fBkadmind\fR(1M) command to determine which -principals are allowed to perform Kerberos administration actions. For -operations that affect principals, the \fBACL\fR file also controls which -principals can operate on which other principals. The location of the \fBACL\fR -file is determined by the \fBacl_file\fR configuration variable in the -\fBkdc.conf\fR(4) file. The default location is \fB/etc/krb5/kadm5.acl\fR. -.sp -.LP -For incremental propagation, see \fBkadmind\fR(1M). The ACL file must contain -the \fBkiprop\fR service principal with propagation privileges in order for the -slave KDC to pull updates from the master's principal database. Refer to the -EXAMPLES section for this case. -.sp -.LP -The \fBACL\fR file can contain comment lines, null lines, or lines that contain -\fBACL\fR entries. Comment lines start with the pound sign (\fB#\fR) and -continue until the end of the line. -.sp -.LP -The order of entries is significant. The first matching entry specifies the -principal on which the control access applies, whether it is on just the -principal or on the principal when it operates on a target principal. -.sp -.LP -Lines containing \fBACL\fR entries must have the following format: -.sp -.in +2 -.nf -\fIprincipal\fR \fIoperation-mask\fR [\fIoperation-target\fR] -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fB\fIprincipal\fR\fR -.ad -.RS 20n -Specifies the principal on which the \fIoperation-mask\fR applies. Can specify -either a partially or fully qualified Kerberos principal name. Each component -of the name can be substituted with a wildcard, using the asterisk ( \fB*\fR ) -character. -.RE - -.sp -.ne 2 -.na -\fB\fIoperation-mask\fR\fR -.ad -.RS 20n -Specifies what operations can or cannot be performed by a principal matching a -particular entry. Specify \fIoperation-mask\fR as one or more \fIprivilege\fRs. -.sp -A \fIprivilege\fR is a string of one or more of the following characters: -\fBa\fR, \fBA\fR, \fBc\fR, \fBC\fR, \fBd\fR, \fBD\fR, \fBi\fR, \fBI\fR, -\fBl\fR, \fBL\fR, \fBm\fR, \fBM\fR, \fBp\fR, \fBP\fR, \fBu\fR, \fBU\fR, -\fBx\fR, or \fB*\fR. Generally, if the character is lowercase, the privilege is -allowed and if the character is uppercase, the operation is disallowed. The -\fBx\fR and \fB*\fR characters are exceptions to the uppercase convention. -.sp -The following \fIprivilege\fRs are supported: -.sp -.ne 2 -.na -\fB\fBa\fR\fR -.ad -.RS 5n -Allows the addition of principals or policies in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBA\fR\fR -.ad -.RS 5n -Disallows the addition of principals or policies in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBc\fR\fR -.ad -.RS 5n -Allows the changing of passwords for principals in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBC\fR\fR -.ad -.RS 5n -Disallows the changing of passwords for principals in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBd\fR\fR -.ad -.RS 5n -Allows the deletion of principals or policies in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBD\fR\fR -.ad -.RS 5n -Disallows the deletion of principals or policies in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBi\fR\fR -.ad -.RS 5n -Allows inquiries to the database. -.RE - -.sp -.ne 2 -.na -\fB\fBI\fR\fR -.ad -.RS 5n -Disallows inquiries to the database. -.RE - -.sp -.ne 2 -.na -\fB\fBl\fR\fR -.ad -.RS 5n -Allows the listing of principals or policies in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBL\fR\fR -.ad -.RS 5n -Disallows the listing of principals or policies in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBm\fR\fR -.ad -.RS 5n -Allows the modification of principals or policies in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBM\fR\fR -.ad -.RS 5n -Disallows the modification of principals or policies in the database. -.RE - -.sp -.ne 2 -.na -\fB\fBp\fR\fR -.ad -.RS 5n -Allow the propagation of the principal database. -.RE - -.sp -.ne 2 -.na -\fB\fBP\fR\fR -.ad -.RS 5n -Disallow the propagation of the principal database. -.RE - -.sp -.ne 2 -.na -\fB\fBu\fR\fR -.ad -.RS 5n -Allows the creation of one-component user principals whose password can be -validated with PAM. -.RE - -.sp -.ne 2 -.na -\fB\fBU\fR\fR -.ad -.RS 5n -Negates the \fBu\fR privilege. -.RE - -.sp -.ne 2 -.na -\fB\fBx\fR\fR -.ad -.RS 5n -Short for specifying privileges \fBa\fR, \fBd\fR,\fBm\fR,\fBc\fR,\fBi\fR, and -\fBl\fR. The same as \fB*\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB*\fR\fR -.ad -.RS 5n -Short for specifying privileges \fBa\fR, \fBd\fR,\fBm\fR,\fBc\fR,\fBi\fR, and -\fBl\fR. The same as \fBx\fR. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIoperation-target\fR\fR -.ad -.RS 20n -Optional. When specified, the \fIprivileges\fR apply to the \fIprincipal\fR -when it operates on the \fIoperation-target\fR. For the \fIoperation-target\fR, -you can specify a partially or fully qualified Kerberos principal name. Each -component of the name can be substituted by a wildcard, using the asterisk ( -\fB*\fR ) character. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRSpecifying a Standard, Fully Qualified Name -.sp -.LP -The following ACL entry specifies a standard, fully qualified name: - -.sp -.in +2 -.nf -user/instance@realm adm -.fi -.in -2 -.sp - -.sp -.LP -The \fIoperation-mask\fR applies only to the \fBuser/instance@realm\fR -principal and specifies that the principal can add, delete, or modify -principals and policies, but it cannot change passwords. - -.LP -\fBExample 2 \fRSpecifying a Standard Fully Qualified Name and Target -.sp -.LP -The following ACL entry specifies a standard, fully qualified name: - -.sp -.in +2 -.nf -user/instance@realm cim service/instance@realm -.fi -.in -2 -.sp - -.sp -.LP -The \fIoperation-mask\fR applies only to the \fBuser/instance@realm\fR -principal operating on the \fBservice/instance@realm\fR target, and specifies -that the principal can change the target's password, request information about -the target, and modify it. - -.LP -\fBExample 3 \fRSpecifying a Name Using a Wildcard -.sp -.LP -The following ACL entry specifies a name using a wildcard: - -.sp -.in +2 -.nf -user/*@realm ac -.fi -.in -2 -.sp - -.sp -.LP -The \fIoperation-mask\fR applies to all principals in realm \fBrealm\fR whose -first component is \fBuser\fR and specifies that the principals can add -principals and change passwords. - -.LP -\fBExample 4 \fRSpecifying a Name Using a Wildcard and a Target -.sp -.LP -The following ACL entry specifies a name using a wildcard and a target: - -.sp -.in +2 -.nf -user/*@realm i */instance@realm -.fi -.in -2 -.sp - -.sp -.LP -The \fIoperation-mask\fR applies to all principals in realm \fBrealm\fR whose -first component is \fBuser\fR and specifies that the principals can perform -inquiries on principals whose second component is \fBinstance\fR and realm is -\fBrealm\fR. - -.LP -\fBExample 5 \fRSpecifying Incremental Propagation Privileges -.sp -.LP -The following ACL entry specifies propagation privileges for the \fBkiprop\fR -service principal: - -.sp -.in +2 -.nf -kiprop/slavehost@realm p -.fi -.in -2 - -.sp -.LP -The operation-mask applies to the \fBkiprop\fR service principal for the -specified slave host \fBslavehost\fR in realm \fBrealm\fR. This specifies that -the associated \fBkiprop\fR service principal can receive incremental principal -updates. - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/krb5/kdc.conf\fR\fR -.ad -.RS 22n -KDC configuration information. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBkpasswd\fR(1), \fBkadmind\fR(1M), \fBkadmin.local\fR(1M), -\fBkdb5_util\fR(1M), \fBkdc.conf\fR(4), \fBattributes\fR(5), \fBkerberos\fR(5), -\fBpam_krb5_migrate\fR(5) diff --git a/usr/src/man/man4/kdc.conf.4 b/usr/src/man/man4/kdc.conf.4 deleted file mode 100644 index b463abdbe9..0000000000 --- a/usr/src/man/man4/kdc.conf.4 +++ /dev/null @@ -1,1079 +0,0 @@ -'\" te -.\" Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved. -.\" 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 KDC.CONF 4 "Oct 29, 2015" -.SH NAME -kdc.conf \- Key Distribution Center (KDC) configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/krb5/kdc.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBkdc.conf\fR file contains \fBKDC\fR configuration information, including -defaults used when issuing Kerberos tickets. This file must reside on all -\fBKDC\fR servers. After you make any changes to the \fBkdc.conf\fR file, stop -and restart the \fBkrb5kdc\fR daemon on the \fBKDC\fR for the changes to take -effect. -.sp -.LP -The format of the \fBkdc.conf\fR consists of section headings in square -brackets (\fB[]\fR). Each section contains zero or more configuration variables -(called relations), of the form of: -.sp -.in +2 -.nf -\fIrelation\fR = \fIrelation-value\fR -.fi -.in -2 -.sp - -.sp -.LP -or -.sp -.in +2 -.nf -\fIrelation-subsection\fR = { - \fIrelation\fR = \fIrelation-value\fR - \fIrelation\fR = \fIrelation-value\fR - } -.fi -.in -2 -.sp - -.sp -.LP -The \fBkdc.conf\fR file contains one of more of the following three sections: -.sp -.ne 2 -.na -\fB\fBkdcdefaults\fR\fR -.ad -.sp .6 -.RS 4n -Contains default values for overall behavior of the \fBKDC\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBrealms\fR\fR -.ad -.sp .6 -.RS 4n -Contains subsections for Kerberos realms, where \fIrelation-subsection\fR is -the name of a realm. Each subsection contains relations that define \fBKDC\fR -properties for that particular realm, including where to find the Kerberos -servers for that realm. -.RE - -.sp -.ne 2 -.na -\fB\fBlogging\fR\fR -.ad -.sp .6 -.RS 4n -Contains relations that determine how Kerberos programs perform logging. -.RE - -.SS "The \fBkdcdefaults\fR Section" -.sp -.LP -The following relation can be defined in the \fB[kdcdefaults]\fR section: -.sp -.ne 2 -.na -\fB\fBkdc_ports\fR\fR -.ad -.sp .6 -.RS 4n -This relation lists the UDP ports on which the Kerberos server should listen by -default. This list is a comma-separated list of integers. If the assigned value -is 0, the Kerberos server does not listen on any UDP port. If this relation is -not specified, the Kerberos server listens on port \fB750\fR and port \fB88\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBkdc_tcp_ports\fR\fR -.ad -.sp .6 -.RS 4n -This relation lists the TCP ports on which the Kerberos server should listen by -default. This list is a comma-separated list of integers. If the assigned value -is 0, the Kerberos server does not listen on any TCP port. If this relation is -not specified, the Kerberos server listens on the \fBkdc\fR TCP port specified -in \fB/etc/services\fR. If this port is not found in \fB/etc/services\fR the -Kerberos server defaults to listen on TCP port 88. -.RE - -.sp -.ne 2 -.na -\fB\fBkdc_max_tcp_connections\fR\fR -.ad -.sp .6 -.RS 4n -This relation controls the maximum number of TCP connections the KDC allows. -The minimum value is 10. If this relation is not specified, the Kerberos server -allows a maximum of 30 TCP connections. -.RE - -.SS "The \fBrealms\fR Section" -.sp -.LP -This section contains subsections for Kerberos realms, where -\fIrelation-subsection\fR is the name of a realm. Each subsection contains -relations that define \fBKDC\fR properties for that particular realm. -.sp -.LP -The following relations can be specified in each subsection: -.sp -.ne 2 -.na -\fB\fBacl_file\fR\fR -.ad -.sp .6 -.RS 4n -(string) Location of the Kerberos V5 access control list (\fBACL\fR) file that -\fBkadmin\fR uses to determine the privileges allowed to each principal on the -database. The default location is \fB\fR\fB/etc/krb5/kadm5.acl\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBadmin_keytab\fR\fR -.ad -.sp .6 -.RS 4n -(string) Location of the \fBkeytab\fR file that \fBkadmin\fR uses to -authenticate to the database. The default location is -\fB/etc/krb5/kadm5.keytab\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdatabase_name\fR\fR -.ad -.sp .6 -.RS 4n -(string) Location of the Kerberos database for this realm. The default location -is \fB/var/krb5/principal\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault_principal_expiration\fR\fR -.ad -.sp .6 -.RS 4n -(absolute time string) The default expiration date of principals created in -this realm. See the \fBTime Format\fR section in \fBkinit\fR(1) for the valid -absolute time formats you can use for \fBdefault_principal_expiration\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault_principal_flags\fR\fR -.ad -.sp .6 -.RS 4n -(flag string) The default attributes of principals created in this realm. Some -of these flags are better to set on an individual principal basis through the -use of the attribute modifiers when using the \fBkadmin\fR command to create -and modify principals. However, some of these options can be applied to all -principals in the realm by adding them to the list of flags associated with -this relation. -.sp -A "flag string" is a list of one or more of the flags listed below preceded by -a minus (\fB-\fR) or a plus (\fB+\fR) character, indicating that the option -that follows should be enabled or disabled. -.sp -Flags below marked with an asterisk (\fB*\fR) are flags that are best applied -on an individual principal basis through the \fBkadmin\fR interface rather -than as a blanket attribute to be applied to all principals. -.sp -.ne 2 -.na -\fB\fBpostdateable\fR\fR -.ad -.sp .6 -.RS 4n -Create postdatable tickets. -.RE - -.sp -.ne 2 -.na -\fB\fBforwardable\fR\fR -.ad -.sp .6 -.RS 4n -Create forwardable tickets. -.RE - -.sp -.ne 2 -.na -\fB\fBtgt-based\fR\fR -.ad -.sp .6 -.RS 4n -Allow TGT-based requests. -.RE - -.sp -.ne 2 -.na -\fB\fBrenewable\fR\fR -.ad -.sp .6 -.RS 4n -Create Renewable tickets. -.RE - -.sp -.ne 2 -.na -\fB\fBproxiable\fR\fR -.ad -.sp .6 -.RS 4n -Create Proxiable tickets. -.RE - -.sp -.ne 2 -.na -\fB\fBdup-skey\fR\fR -.ad -.sp .6 -.RS 4n -Allow DUP_SKEY requests, this enables user-to-user authentication. -.RE - -.sp -.ne 2 -.na -\fB\fBpreauth\fR\fR -.ad -.sp .6 -.RS 4n -Require the use of pre-authentication data whenever principals request TGTs. -.RE - -.sp -.ne 2 -.na -\fB\fBhwauth\fR\fR -.ad -.sp .6 -.RS 4n -Require the use of hardware-based pre-authentication data whenever principals -request TGTs. -.RE - -.sp -.ne 2 -.na -\fB\fB* allow-tickets\fR\fR -.ad -.sp .6 -.RS 4n -Allow tickets to be issued for all principals. -.RE - -.sp -.ne 2 -.na -\fB\fB* pwdchange\fR\fR -.ad -.sp .6 -.RS 4n -Require principal's to change their password. -.RE - -.sp -.ne 2 -.na -\fB\fB* service\fR\fR -.ad -.sp .6 -.RS 4n -Enable or disable a service. -.RE - -.sp -.ne 2 -.na -\fB\fB* pwservice\fR\fR -.ad -.sp .6 -.RS 4n -Mark principals as password changing principals. -.RE - -An example of \fBdefault_principal_flags\fR is shown in EXAMPLES, below. -.RE - -.sp -.ne 2 -.na -\fB\fBdict_file\fR\fR -.ad -.sp .6 -.RS 4n -(string) Location of the dictionary file containing strings that are not -allowed as passwords. A principal with any password policy is not allowed to -select a password in the dictionary. The default location is -\fB/var/krb5/kadm5.dict\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBkadmind_port\fR\fR -.ad -.sp .6 -.RS 4n -(port number) The port that the \fBkadmind\fR daemon is to listen on for this -realm. The assigned port for \fBkadmind\fR is 749. -.RE - -.sp -.ne 2 -.na -\fB\fBkey_stash_file\fR\fR -.ad -.sp .6 -.RS 4n -(string) Location where the master key has been stored (by \fBkdb5_util -stash\fR). The default location is \fB/var/krb5/.k5.\fR\fIrealm\fR, where -\fIrealm\fR is the Kerberos realm. -.RE - -.sp -.ne 2 -.na -\fB\fBkdc_ports\fR\fR -.ad -.sp .6 -.RS 4n -(string) The list of UDP ports that the \fBKDC\fR listens on for this realm. By -default, the value of \fBkdc_ports\fR as specified in the \fB[kdcdefaults]\fR -section is used. -.RE - -.sp -.ne 2 -.na -\fB\fBkdc_tcp_ports\fR\fR -.ad -.sp .6 -.RS 4n -(string) The list of TCP ports that the KDC listens on (in addition to the UDP -ports specified by \fBkdc_ports\fR) for this realm. By default, the value of -\fBkdc_tcp_ports\fR as specified in the \fB[kdcdefaults]\fR section is used. -.RE - -.sp -.ne 2 -.na -\fB\fBmaster_key_name\fR\fR -.ad -.sp .6 -.RS 4n -(string) The name of the master key. -.RE - -.sp -.ne 2 -.na -\fB\fBmaster_key_type\fR\fR -.ad -.sp .6 -.RS 4n -(key type string) The master key's key type. This is used to determine the type -of encryption that encrypts the entries in the principal db. \fBdes-cbc-crc\fR, -\fBdes3-cbc-md5\fR, \fBdes3-cbc-sha1-kd\fR, \fBarcfour-hmac-md5\fR, -\fBarcfour-hmac-md5-exp\fR, \fBaes128-cts-hmac-sha1-96\fR, and -\fBaes256-cts-hmac-sha1-96\fR are supported at this time (\fBdes-cbc-crc\fR is -the default). If you set this to \fBdes3-cbc-sha1-kd\fR all systems that -receive copies of the principal db, such as those running slave KDC's, must -support \fBdes3-cbc-sha1-kd\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBmax_life\fR\fR -.ad -.sp .6 -.RS 4n -(delta time string) The maximum time period for which a ticket is valid in this -realm. See the \fBTime\fR \fBFormat\fR section in \fBkinit\fR(1) for the valid -time duration formats you can use for \fBmax_life\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBmax_renewable_life\fR\fR -.ad -.sp .6 -.RS 4n -(delta time string) The maximum time period during which a valid ticket can be -renewed in this realm. See the \fBTime\fR \fBFormat\fR section in -\fBkinit\fR(1) for the valid time duration formats you can use for -\fBmax_renewable_life\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBsunw_dbprop_enable = [true | false]\fR\fR -.ad -.sp .6 -.RS 4n -Enable or disable incremental database propagation. Default is \fBfalse\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBsunw_dbprop_master_ulogsize = N\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the maximum number of log entries available for incremental -propagation to the slave KDC servers. The maximum value that this can be is -2500 entries. Default value is 1000 entries. -.RE - -.sp -.ne 2 -.na -\fB\fBsunw_dbprop_slave_poll = N[s, m, h]\fR\fR -.ad -.sp .6 -.RS 4n -Specifies how often the slave KDC polls for new updates that the master might -have. Default is \fB2m\fR (two minutes). -.RE - -.sp -.ne 2 -.na -\fB\fBsupported_enctypes\fR\fR -.ad -.sp .6 -.RS 4n -List of \fBkey\fR/\fBsalt\fR strings. The default \fBkey\fR/\fBsalt\fR -combinations of principals for this realm. The \fBkey\fR is separated from the -\fBsalt\fR by a colon (\fB:\fR) or period (\fB\&.\fR). Multiple -\fBkey\fR/\fBsalt\fR strings can be used by separating each string with a -space. The \fBsalt\fR is additional information encoded within the key that -tells what kind of key it is. Only the \fBnormal\fR \fBsalt\fR is supported at -this time, for example, \fBdes-cbc-crc:normal\fR. If this relation is not -specified, the default setting is: -.sp -.in +2 -.nf -aes256-cts-hmac-sha1-96:normal \e \fI(see note below)\fR -aes128-cts-hmac-sha1-96:normal \e -des3-cbc-sha1-kd:normal \e -arcfour-hmac-md5:normal \e -des-cbc-md5:normal -.fi -.in -2 - -.LP -Note - -.sp -.RS 2 -The unbundled Strong Cryptographic packages must be installed for the -\fBaes256-cts-hmac-sha1-96:normal\fR \fBenctype\fR to be available for -Kerberos. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBreject_bad_transit\fR\fR -.ad -.sp .6 -.RS 4n -This boolean specifies whether the list of transited realms for cross-realm -tickets should be checked against the transit path computed from the realm -names and the \fB[capaths]\fR section of its \fBkrb5.conf\fR(4) file. -.sp -The default for \fBreject_bad_transit\fR is \fBtrue\fR. -.RE - -.SS "The \fBlogging\fR Section" -.sp -.LP -This section indicates how Kerberos programs perform logging. The same relation -can be repeated if you want to assign it multiple logging methods. The -following relations can be defined in the \fB[logging]\fR section: -.sp -.ne 2 -.na -\fB\fBkdc\fR\fR -.ad -.sp .6 -.RS 4n -Specifies how the \fBKDC\fR is to perform its logging. The default is -\fBFILE:/var/krb5/kdc.log\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBadmin_server\fR\fR -.ad -.sp .6 -.RS 4n -Specifies how the administration server is to perform its logging. The default -is \fBFILE:/var/krb5/kadmin.log\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault\fR\fR -.ad -.sp .6 -.RS 4n -Specifies how to perform logging in the absence of explicit specifications. -.RE - -.sp -.LP -The \fB[logging]\fR relations can have the following values: -.sp -.LP -\fBFILE:\fR\fIfilename\fR -.sp -.LP -or -.sp -.ne 2 -.na -\fB\fBFILE=\fR\fIfilename\fR\fR -.ad -.sp .6 -.RS 4n -This value causes the entity's logging messages to go to the specified file. If -the `=' form is used, the file is overwritten. If the `:' form is used, the -file is appended to. -.RE - -.sp -.ne 2 -.na -\fB\fBSTDERR\fR\fR -.ad -.sp .6 -.RS 4n -This value sends the entity's logging messages to its standard error stream. -.RE - -.sp -.ne 2 -.na -\fB\fBCONSOLE\fR\fR -.ad -.sp .6 -.RS 4n -This value sends the entity's logging messages to the console, if the system -supports it. -.RE - -.sp -.ne 2 -.na -\fB\fBDEVICE=\fR\fIdevicename\fR\fR -.ad -.sp .6 -.RS 4n -This sends the entity's logging messages to the specified device. -.RE - -.sp -.ne 2 -.na -\fB\fBSYSLOG[:\fR\fIseverity\fR\fB[:\fR\fIfacility\fR\fB]]\fR\fR -.ad -.sp .6 -.RS 4n -This sends the entity's logging messages to the system log. -.sp -The \fIseverity\fR argument specifies the default severity of system log -messages. This default can be any of the following severities supported by the -\fBsyslog\fR(3C) call, minus the \fBLOG_\fR prefix: \fBLOG_EMERG\fR, -\fBLOG_ALERT\fR, \fBLOG_CRIT\fR, \fBLOG_ERR\fR, \fBLOG_WARNING\fR, -\fBLOG_NOTICE\fR, \fBLOG_INFO\fR, and \fBLOG_DEBUG\fR. For example, a value of -\fBCRIT\fR would specify \fBLOG_CRIT\fR severity. -.sp -The \fIfacility\fR argument specifies the facility under which the messages are -logged. This can be any of the following facilities supported by the -\fBsyslog\fR(3C) call minus the \fBLOG_\fR prefix: \fBLOG_KERN\fR, -\fBLOG_USER\fR, \fBLOG_MAIL\fR, \fBLOG_DAEMON\fR, \fBLOG_AUTH\fR, -\fBLOG_LPR\fR, \fBLOG_NEWS\fR, \fBLOG_UUCP\fR, \fBLOG_CRON\fR, and -\fBLOG_LOCAL0\fR through \fBLOG_LOCAL7\fR. -.sp -If no severity is specified, the default is \fBERR\fR. If no facility is -specified, the default is \fBAUTH\fR. -.sp -In the following example, the logging messages from the \fBKDC\fR go to the -console and to the system log under the facility \fBLOG_DAEMON\fR with default -severity of \fBLOG_INFO\fR; the logging messages from the administration server -are appended to the \fB/var/krb5/kadmin.log\fR file and sent to the -\fB/dev/tty04\fR device. -.sp -.in +2 -.nf -[logging] -kdc = CONSOLE -kdc = SYSLOG:INFO:DAEMON -admin_server = FILE:/export/logging/kadmin.log -admin_server = DEVICE=/dev/tty04 -.fi -.in -2 -.sp - -.RE - -.SS "PKINIT-specific Options" -.sp -.LP -The following are \fBpkinit-specific\fR options. These values can be specified -in \fB[kdcdefaults]\fR as global defaults, or within a realm-specific -subsection of \fB[realms]\fR. A realm-specific value overrides, does not add -to, a generic \fB[kdcdefaults]\fR specification. The search order is -.RS +4 -.TP -1. -realm-specific subsection of \fB[realms]\fR -.sp -.ne 2 -.na -\fB[realms]\fR -.ad -.RS 12n -.sp -.in +2 -.nf -[realms] - EXAMPLE.COM = { - pkinit_anchors = FILE:/usr/local/example.com.crt - } -.fi -.in -2 - -.RE - -.RE -.RS +4 -.TP -2. -generic value in the \fB[kdcdefaults]\fR section -.sp -.in +2 -.nf -[kdcdefaults] - pkinit_anchors = DIR:/usr/local/generic_trusted_cas/ -.fi -.in -2 - -.RE -.sp -.ne 2 -.na -\fB\fBpkinit_identity\fR \fB=\fR \fIURI\fR\fR -.ad -.RS 25n -Specifies the location of the KDC's X.509 identity information. This option is -required if \fBpkinit\fR is supported by the KDC. Valid \fIURI\fR types are -\fBFILE\fR, \fBDIR\fR, \fBPKCS11\fR, \fBPKCS12\fR, and \fBENV\fR. See the -\fBPKINIT URI Types\fR section for more details. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_anchors\fR \fB=\fR \fIURI\fR\fR -.ad -.RS 25n -Specifies the location of trusted anchor (root) certificates which the KDC -trusts to sign client certificates. This option is required if \fBpkinit\fR is -supported by the KDC. This option can be specified multiple times. Valid -\fIURI\fR types are \fBFILE\fR and \fBDIR\fR. See the \fBPKINIT URI Types\fR -section for details. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_pool\fR\fR -.ad -.RS 25n -Specifies the location of intermediate certificates which can be used by the -KDC to complete the trust chain between a client's certificate and a trusted -anchor. This option can be specified multiple times. Valid \fIURI\fR types are -\fBFILE\fR and \fBDIR\fR. See the \fBPKINIT URI Types\fR section for more -details. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_revoke\fR\fR -.ad -.RS 25n -Specifies the location of Certificate Revocation List (CRL) information to be -used by the KDC when verifying the validity of client certificates. This option -can be specified multiple times. The default certificate verification process -always checks the available revocation information to see if a certificate has -been revoked. If a match is found for the certificate in a CRL, verification -fails. If the certificate being verified is not listed in a CRL, or there is no -CRL present for its issuing CA, and \fBpkinit_require_crl_checking\fR is -\fBfalse\fR, then verification succeeds. The only valid \fIURI\fR types is -\fBDIR\fR. See the \fBPKINIT URI Types\fR section for more details. If -\fBpkinit_require_crl_checking\fR is \fBtrue\fR and there is no CRL information -available for the issuing CA, verification fails. -\fBpkinit_require_crl_checking\fR should be set to \fBtrue\fR if the policy is -such that up-to-date CRLs must be present for every CA. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_dh_min_bits\fR\fR -.ad -.RS 25n -Specifies the minimum number of bits the KDC is willing to accept for a -client's Diffie-Hellman key. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_allow_upn\fR\fR -.ad -.RS 25n -Specifies that the KDC is willing to accept client certificates with the -Microsoft UserPrincipalName (UPN) Subject Alternative Name (SAN). This means -the KDC accepts the binding of the UPN in the certificate to the Kerberos -principal name. -.sp -The default is \fBfalse\fR. -.sp -Without this option, the KDC only accepts certificates with the -\fBid-pkinit-san\fR as defined in RFC4556. There is currently no option to -disable SAN checking in the KDC. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_eku_checking\fR\fR -.ad -.RS 25n -This option specifies what Extended Key Usage (EKU) values the KDC is willing -to accept in client certificates. The values recognized in the \fBkdc.conf\fR -file are: -.sp -.ne 2 -.na -\fBkpClientAuth\fR -.ad -.RS 16n -This is the default value and specifies that client certificates must have the -\fBid-pkinit-KPClientAuth EKU\fR as defined in RFC4556. -.RE - -.sp -.ne 2 -.na -\fBscLogin\fR -.ad -.RS 16n -If \fBscLogin\fR is specified, client certificates with the Microsoft Smart -Card Login EKU (\fBid-ms-kp-sc-logon\fR) is accepted. -.RE - -.RE - -.SS "PKINIT URI Types" -.sp -.ne 2 -.na -\fBFILE:\fIfile-name\fR[\fI,key-file-name\fR]\fR -.ad -.sp .6 -.RS 4n -This option has context-specific behavior. -.sp -.ne 2 -.na -\fBpkinit_identity\fR -.ad -.RS 19n -\fIfile-name\fR specifies the name of a PEM-format file containing the user's -certificate. If \fIkey-file-name\fR is not specified, the user's private key is -expected to be in \fIfile-name\fR as well. Otherwise, \fIkey-file-name\fR is -the name of the file containing the private key. -.RE - -.sp -.ne 2 -.na -\fBpkinit_anchors\fR -.ad -.br -.na -\fBpkinit_pool\fR -.ad -.RS 19n -\fIfile-name\fR is assumed to be the name of an OpenSSL-style ca-bundle file. -The \fIca-bundle\fR file should be base-64 encoded. -.RE - -.RE - -.sp -.ne 2 -.na -\fBDIR:\fIdirectory-name\fR\fR -.ad -.sp .6 -.RS 4n -This option has context-specific behavior. -.sp -.ne 2 -.na -\fBpkinit_identity\fR -.ad -.RS 19n -\fIdirectory-name\fR specifies a directory with files named \fB*.crt\fR and -\fB*.key\fR, where the first part of the file name is the same for matching -pairs of certificate and private key files. When a file with a name ending with -\fB\&.crt\fR is found, a matching file ending with .\fBkey\fR is assumed to -contain the private key. If no such file is found, then the certificate in the -\fB\&.crt\fR is not used. -.RE - -.sp -.ne 2 -.na -\fBpkinit_anchors\fR -.ad -.br -.na -\fBpkinit_pool\fR -.ad -.RS 19n -\fIdirectory-name\fR is assumed to be an OpenSSL-style hashed CA directory -where each CA cert is stored in a file named \fBhash-of-ca-cert.\fR\fI#\fR. -This infrastructure is encouraged, but all files in the directory is examined -and if they contain certificates (in PEM format), they are used. -.RE - -.sp -.ne 2 -.na -\fBpkinit_revoke\fR -.ad -.RS 19n -\fIdirectory-name\fR is assumed to be an OpenSSL-style hashed CA directory -where each revocation list is stored in a file named -\fBhash-of-ca-cert.r\fR\fI#\fR. This infrastructure is encouraged, but all -files in the directory is examined and if they contain a revocation list (in -PEM format), they are used. -.RE - -.RE - -.sp -.ne 2 -.na -\fBPKCS12:pkcs12-file-name\fR -.ad -.sp .6 -.RS 4n -\fBpkcs12-file-name\fR is the name of a PKCS #12 format file, containing the -user's certificate and private key. -.RE - -.sp -.ne 2 -.na -\fBPKCS11:[slotid=\fIslot-id\fR][:token=\fItoken-label\fR][:certid=\fIcert-id\fR][:certlabel=\fIcert-label\fR]\fR -.ad -.sp .6 -.RS 4n -All keyword/values are optional. PKCS11 modules (for example, -\fBopensc-pkcs11.so\fR) must be installed as a crypto provider under -\fBlibpkcs11\fR(3LIB). \fBslotid=\fR and/or \fBtoken=\fR can be specified to -force the use of a particular smard card reader or token if there is more than -one available. \fBcertid=\fR and/or \fBcertlabel=\fR can be specified to force -the selection of a particular certificate on the device. See the -\fBpkinit_cert_match\fR configuration option for more ways to select a -particular certificate to use for \fBpkinit\fR. -.RE - -.sp -.ne 2 -.na -\fBENV:\fIenvironment-variable-name\fR\fR -.ad -.sp .6 -.RS 4n -\fIenvironment-variable-name\fR specifies the name of an environment variable -which has been set to a value conforming to one of the previous values. For -example, \fBENV:X509_PROXY\fR, where environment variable \fBX509_PROXY\fR has -been set to \fBFILE:/tmp/my_proxy.pem\fR. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRSample \fBkdc.conf\fR File -.sp -.LP -The following is an example of a \fBkdc.conf\fR file: - -.sp -.in +2 -.nf -[kdcdefaults] - kdc_ports = 88 - -[realms] - ATHENA.MIT.EDU = { - kadmind_port = 749 - max_life = 10h 0m 0s - max_renewable_life = 7d 0h 0m 0s - default_principal_flags = +preauth,+forwardable,-postdateable - master_key_type = des-cbc-crc - supported_enctypes = des-cbc-crc:normal - } - -[logging] - kdc = FILE:/export/logging/kdc.log - admin_server = FILE:/export/logging/kadmin.log -.fi -.in -2 - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/krb5/kadm5.acl\fR\fR -.ad -.sp .6 -.RS 4n -List of principals and their \fBkadmin\fR administrative privileges. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/krb5/kadm5.keytab\fR\fR -.ad -.sp .6 -.RS 4n -Keytab for \fBkadmind\fR principals: \fBkadmin\fR/\fIfqdn\fR, -\fBchangepw\fR/\fIfqdn\fR, and \fBkadmin\fR/\fBchangepw\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/krb5/principal\fR\fR -.ad -.sp .6 -.RS 4n -Kerberos principal database. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/krb5/principal.ulog\fR\fR -.ad -.sp .6 -.RS 4n -The update log file for incremental propagation. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/krb5/kadm5.dict\fR\fR -.ad -.sp .6 -.RS 4n -Dictionary of strings explicitly disallowed as passwords. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/krb5/kdc.log\fR\fR -.ad -.sp .6 -.RS 4n -\fBKDC\fR logging file. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/krb5/kadmin.log\fR\fR -.ad -.sp .6 -.RS 4n -Kerberos administration server logging file. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability See below. -.TE - -.sp -.LP -All of the keywords, except for the \fBPKINIT\fR keywords are Committed. The -\fBPKINIT\fR keywords are Volatile. -.SH SEE ALSO -.sp -.LP -\fBkpasswd\fR(1), \fBkadmind\fR(1M), \fBkadmin.local\fR(1M), -\fBkdb5_util\fR(1M), \fBkpropd\fR(1M), \fBlibpkcs11\fR(3LIB), \fBsyslog\fR(3C), -\fBkadm5.acl\fR(4), \fBkrb5.conf\fR(4), \fBattributes\fR(5), \fBkerberos\fR(5) diff --git a/usr/src/man/man4/keytables.4 b/usr/src/man/man4/keytables.4 deleted file mode 100644 index de6c0916e2..0000000000 --- a/usr/src/man/man4/keytables.4 +++ /dev/null @@ -1,964 +0,0 @@ -'\" te -.\" Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved. -.\" 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 KEYTABLES 4 "Feb 18, 2003" -.SH NAME -keytables \- keyboard table descriptions for loadkeys and dumpkeys -.SH DESCRIPTION -.sp -.LP -These files are used by \fBloadkeys\fR(1) to modify the translation tables used -by the keyboard streams module and generated from those translation tables. See -\fBloadkeys\fR(1). -.sp -.LP -Any line in the file beginning with \fB#\fR is a comment, and is ignored. -\fB#\fR is treated specially only at the beginning of a line. -.sp -.LP -Other lines specify the values to load into the tables for a particular -keystation. The format is either: -.sp -.in +2 -.nf -\fBkey\fR \fInumber list_of_entries\fR -.fi -.in -2 -.sp - -.sp -.LP -or -.sp -.in +2 -.nf -\fBswap\fR \fInumber1\fR \fBwith\fR \fInumber2\fR -.fi -.in -2 -.sp - -.sp -.LP -or -.sp -.in +2 -.nf -\fBkey\fR \fInumber1\fR \fBsame as\fR \fInumber2\fR -.fi -.in -2 -.sp - -.sp -.LP -or a blank line, which is ignored. -.sp -.in +2 -.nf -\fBkey\fR \fInumber list_of_entries\fR -.fi -.in -2 -.sp - -.sp -.LP -sets the entries for keystation \fInumber\fR from the list given. An entry in -that list is of the form -.sp -.in +2 -.nf -\fItablename\fR \fIcode\fR -.fi -.in -2 -.sp - -.sp -.LP -where \fItablename\fR is the name of a particular translation table, or -\fBall\fR. The translation tables are: -.sp -.ne 2 -.na -\fB\fBbase\fR\fR -.ad -.RS 9n -entry when no shifts are active -.RE - -.sp -.ne 2 -.na -\fB\fBshift\fR\fR -.ad -.RS 9n -entry when "Shift" key is down -.RE - -.sp -.ne 2 -.na -\fB\fBcaps\fR\fR -.ad -.RS 9n -entry when "Caps Lock" is in effect -.RE - -.sp -.ne 2 -.na -\fB\fBctrl\fR\fR -.ad -.RS 9n -entry when "Control" is down -.RE - -.sp -.ne 2 -.na -\fB\fBaltg\fR\fR -.ad -.RS 9n -entry when "Alt Graph" is down -.RE - -.sp -.ne 2 -.na -\fB\fBnuml\fR\fR -.ad -.RS 9n -entry when "Num Lock" is in effect -.RE - -.sp -.ne 2 -.na -\fB\fBup\fR\fR -.ad -.RS 9n -entry when a key goes up -.RE - -.sp -.LP -All tables other than \fBup\fR refer to the action generated when a key goes -down. Entries in the \fBup\fR table are used only for shift keys, since the -shift in question goes away when the key goes up, except for keys such as "Caps -Lock" or "Num Lock"; the keyboard streams module makes the key look as if it -were a latching key. -.sp -.LP -A table name of \fBall\fR indicates that the entry for all tables should be set -to the specified value, with the following exception: for entries with a value -other than \fBhole\fR, the entry for the \fBnuml\fR table should be set to -\fBnonl\fR, and the entry for the \fBup\fR table should be set to \fBnop\fR. -.sp -.LP -The \fIcode\fR specifies the effect of the key in question when the specified -shift key is down. A \fIcode\fR consists of either: -.RS +4 -.TP -.ie t \(bu -.el o -A character, which indicates that the key should generate the given character. -The character can either be a single character, a single character preceded by -\fB^\fR which refers to a "control character" (for instance, \fB^c\fR is -control-C), or a C-style character constant enclosed in single quote characters -(\fB\&'\fR), which can be expressed with C-style escape sequences such as \er -for \fBRETURN\fR or \e000 for the null character. Note that the single -character may be any character in an 8-bit character set, such as ISO 8859/1. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A string, consisting of a list of characters enclosed in double quote -characters (\fB"\fR). Note that the use of the double quote character means -that a \fIcode\fR of double quote must be enclosed in single quotes. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -One of the following expressions: -.RS - -.sp -.ne 2 -.na -\fB\fBshiftkeys+leftshift\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the left-hand "Shift" key -.RE - -.sp -.ne 2 -.na -\fB\fBshiftkeys+rightshift\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the right-hand "Shift" key -.RE - -.sp -.ne 2 -.na -\fB\fBshiftkeys+leftctrl\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the left-hand "Control" key -.RE - -.sp -.ne 2 -.na -\fB\fBshiftkeys+rightctrl\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the right-hand "Control" key -.RE - -.sp -.ne 2 -.na -\fB\fBshiftkeys+alt\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "Alt" shift key -.RE - -.sp -.ne 2 -.na -\fB\fBshiftkeys+altgraph\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "Alt Graph" shift key -.RE - -.sp -.ne 2 -.na -\fB\fBshiftkeys+capslock\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "Caps Lock" key -.RE - -.sp -.ne 2 -.na -\fB\fBshiftkeys+shiftlock\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "Shift Lock" key -.RE - -.sp -.ne 2 -.na -\fB\fBshiftkeys+numlock\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "Num Lock" key -.RE - -.sp -.ne 2 -.na -\fB\fBbuckybits+systembit\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "Stop" key in SunView; this is normally the L1 key, or the -SETUP key on the VT100 keyboard -.RE - -.sp -.ne 2 -.na -\fB\fBbuckybits+metabit\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "meta" key. That is, the "Left" or "Right" key on a Sun-2 -or Sun-3 keyboard or the "diamond" key on a Sun-4 keyboard -.RE - -.sp -.ne 2 -.na -\fB\fBcompose\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "Compose" key -.RE - -.sp -.ne 2 -.na -\fB\fBctrlq\fR\fR -.ad -.sp .6 -.RS 4n -on the "VT100" keyboard, the key is to transmit the control-Q character (this -would be the entry for the "Q" key in the \fBctrl\fR table) -.RE - -.sp -.ne 2 -.na -\fB\fBctrls\fR\fR -.ad -.sp .6 -.RS 4n -on the "VT100" keyboard, the key is to transmit the control-S character (this -would be the entry for the "S" key in the \fBctrl\fR table) -.RE - -.sp -.ne 2 -.na -\fB\fBnoscroll\fR\fR -.ad -.sp .6 -.RS 4n -on the "VT100" keyboard, the key is to be the "No Scroll" key -.RE - -.sp -.ne 2 -.na -\fB\fBstring+uparrow\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "up arrow" key -.RE - -.sp -.ne 2 -.na -\fB\fBstring+downarrow\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "down arrow" key -.RE - -.sp -.ne 2 -.na -\fB\fBstring+leftarrow\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "left arrow" key -.RE - -.sp -.ne 2 -.na -\fB\fBstring+rightarrow\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "right arrow" key -.RE - -.sp -.ne 2 -.na -\fB\fBstring+homearrow\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "home" key -.RE - -.sp -.ne 2 -.na -\fB\fBfa_acute\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the acute accent "floating accent" key -.RE - -.sp -.ne 2 -.na -\fB\fBfa_cedilla\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the cedilla "floating accent" key -.RE - -.sp -.ne 2 -.na -\fB\fBfa_cflex\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the circumflex "floating accent" key -.RE - -.sp -.ne 2 -.na -\fB\fBfa_grave\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the grave accent "floating accent" key -.RE - -.sp -.ne 2 -.na -\fB\fBfa_tilde\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the tilde "floating accent" key -.RE - -.sp -.ne 2 -.na -\fB\fBfa_umlaut\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the umlaut "floating accent" key -.RE - -.sp -.ne 2 -.na -\fB\fBnonl\fR\fR -.ad -.sp .6 -.RS 4n -this is used only in the Num Lock table; the key is not to be affected by the -state of Num Lock -.RE - -.sp -.ne 2 -.na -\fB\fBpad0\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "0" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpad1\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "1" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpad2\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "2" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpad3\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "3" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpad4\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "4" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpad5\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "5" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpad6\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "6" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpad7\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "7" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpad8\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "8" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpad9\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "9" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpaddot\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "." key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpadenter\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "Enter" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpadplus\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "+" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpadminus\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "\(mi" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpadstar\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "*" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpadslash\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "/" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpadequal\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "=" key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBpadsep\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "," (separator) key on the numeric keypad -.RE - -.sp -.ne 2 -.na -\fB\fBlf(\fIn\fR)\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the left-hand function key \fIn\fR -.RE - -.sp -.ne 2 -.na -\fB\fBrf(\fIn\fR)\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the right-hand function key \fIn\fR -.RE - -.sp -.ne 2 -.na -\fB\fBtf(\fIn\fR)\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the top function key \fIn\fR -.RE - -.sp -.ne 2 -.na -\fB\fBbf(\fIn\fR)\fR\fR -.ad -.sp .6 -.RS 4n -the key is to be the "bottom" function key \fIn\fR -.RE - -.sp -.ne 2 -.na -\fB\fBnop\fR\fR -.ad -.sp .6 -.RS 4n -the key is to do nothing -.RE - -.sp -.ne 2 -.na -\fB\fBerror\fR\fR -.ad -.sp .6 -.RS 4n -this code indicates an internal error; to be used only for keystation 126, and -must be used there -.RE - -.sp -.ne 2 -.na -\fB\fBidle\fR\fR -.ad -.sp .6 -.RS 4n -this code indicates that the keyboard is idle (that is, has no keys down); to -be used only for all entries other than the \fBnuml\fR and \fBup\fR table -entries for keystation 127, and must be used there -.RE - -.sp -.ne 2 -.na -\fB\fBoops\fR\fR -.ad -.sp .6 -.RS 4n -this key exists, but its action is not defined; it has the same effect as -\fBnop\fR -.RE - -.sp -.ne 2 -.na -\fB\fBreset\fR\fR -.ad -.sp .6 -.RS 4n -this code indicates that the keyboard has just been reset; to be used only for -the \fBup\fR table entry for keystation 127, and must be used there. -.RE - -.sp -.ne 2 -.na -\fB\fBswap\fR \fInumber1\fR with \fInumber2\fR\fR -.ad -.sp .6 -.RS 4n -exchanges the entries for keystations \fInumber1\fR and \fInumber2\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBkey \fInumber1\fR\fR same as \fInumber2\fR\fR -.ad -.sp .6 -.RS 4n -sets the entries for keystation \fInumber1\fR to be the same as those for -keystation \fInumber2\fR. If the file does not specify entries for keystation -\fInumber2\fR, the entries currently in the translation table are used; if the -file does specify entries for keystation \fInumber2\fR, those entries are used. -.RE - -.RE - -.RE -.SH EXAMPLES -.LP -\fBExample 1 \fRExample of setting multiple keystations. -.sp -.LP -The following entry sets keystation 15 to be a "hole" (that is, an entry -indicating that there is no keystation 15); sets keystation 30 to do nothing -when Alt Graph is down, generate "!" when Shift is down, and generate "1" under -all other circumstances; and sets keystation 76 to be the left-hand Control -key. - -.sp -.in +2 -.nf -key 15 all hole -key 30 base 1 shift ! caps 1 ctrl 1 altg nop -key 76 all shiftkeys+leftctrl up shiftkeys+leftctrl -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRExchange DELETE and BACKSPACE keys -.sp -.LP -The following entry exchanges the Delete and Back Space keys on the Type 4 -keyboard: - -.sp -.in +2 -.nf -swap 43 with 66 -.fi -.in -2 -.sp - -.sp -.LP -Keystation 43 is normally the Back Space key, and keystation 66 is normally the -Delete key. - -.LP -\fBExample 3 \fRDisable CAPS LOCK key -.sp -.LP -The following entry disables the Caps Lock key on the Type 3 and U.S. Type 4 -keyboards: - -.sp -.in +2 -.nf -key 119 all nop -.fi -.in -2 -.sp - -.LP -\fBExample 4 \fRStandard translation tables for the U.S. Type 4 keyboard -.sp -.LP -The following specifies the standard translation tables for the U.S. Type 4 -keyboard: - -.sp -.in +2 -.nf -key 0 all hole -key 1 all buckybits+systembit up buckybits+systembit -key 2 all hole -key 3 all lf(2) -key 4 all hole -key 5 all tf(1) -key 6 all tf(2) -key 7 all tf(10) -key 8 all tf(3) -key 9 all tf(11) -key 10 all tf(4) -key 11 all tf(12) -key 12 all tf(5) -key 13 all shiftkeys+altgraph up shiftkeys+altgraph -key 14 all tf(6) -key 15 all hole -key 16 all tf(7) -key 17 all tf(8) -key 18 all tf(9) -key 19 all shiftkeys+alt up shiftkeys+alt -key 20 all hole -key 21 all rf(1) -key 22 all rf(2) -key 23 all rf(3) -key 24 all hole -key 25 all lf(3) -key 26 all lf(4) -key 27 all hole -key 28 all hole -key 29 all ^[ -key 30 base 1 shift ! caps 1 ctrl 1 altg nop -key 31 base 2 shift @ caps 2 ctrl ^@ altg nop -key 32 base 3 shift # caps 3 ctrl 3 altg nop -key 33 base 4 shift $ caps 4 ctrl 4 altg nop -key 34 base 5 shift % caps 5 ctrl 5 altg nop -key 35 base 6 shift ^ caps 6 ctrl ^^ altg nop -key 36 base 7 shift & caps 7 ctrl 7 altg nop -key 37 base 8 shift * caps 8 ctrl 8 altg nop -key 38 base 9 shift ( caps 9 ctrl 9 altg nop -key 39 base 0 shift ) caps 0 ctrl 0 altg nop -key 40 base - shift _ caps - ctrl ^_ altg nop -key 41 base = shift + caps = ctrl = altg nop -key 42 base ` shift ~ caps ` ctrl ^^ altg nop -key 43 all '\eb' -key 44 all hole -key 45 all rf(4) numl padequal -key 46 all rf(5) numl padslash -key 47 all rf(6) numl padstar -key 48 all bf(13) -key 49 all lf(5) -key 50 all bf(10) numl padequal -key 51 all lf(6) -key 52 all hole -key 53 all '\et' -key 54 base q shift Q caps Q ctrl ^Q altg nop -key 55 base w shift W caps W ctrl ^W altg nop -key 56 base e shift E caps E ctrl ^E altg nop -key 57 base r shift R caps R ctrl ^R altg nop -key 58 base t shift T caps T ctrl ^T altg nop -key 59 base y shift Y caps Y ctrl ^Y altg nop -key 60 base u shift U caps U ctrl ^U altg nop -key 61 base i shift I caps I ctrl '\et' altg nop -key 62 base o shift O caps O ctrl ^O altg nop -key 63 base p shift P caps P ctrl ^P altg nop -key 64 base [ shift { caps [ ctrl ^[ altg nop -key 65 base ] shift } caps ] ctrl ^] altg nop -key 66 all '\e177' -key 67 all compose -key 68 all rf(7) numl pad7 -key 69 all rf(8) numl pad8 -key 70 all rf(9) numl pad9 -key 71 all bf(15) numl padminus -key 72 all lf(7) -key 73 all lf(8) -key 74 all hole -key 75 all hole -key 76 all shiftkeys+leftctrl up shiftkeys+leftctrl -key 77 base a shift A caps A ctrl ^A altg nop -key 78 base s shift S caps S ctrl ^S altg nop -key 79 base d shift D caps D ctrl ^D altg nop -key 80 base f shift F caps F ctrl ^F altg nop -key 81 base g shift G caps G ctrl ^G altg nop -key 82 base h shift H caps H ctrl '\eb' altg nop -key 83 base j shift J caps J ctrl '\en' altg nop -key 84 base k shift K caps K ctrl '\ev' altg nop -key 85 base l shift L caps L ctrl ^L altg nop -key 86 base ; shift : caps ; ctrl ; altg nop -key 87 base '\e'' shift '"' caps '\e'' ctrl '\e'' altg nop -key 88 base '\e\e' shift | caps '\e\e' ctrl ^\e altg nop -key 89 all '\er' -key 90 all bf(11) numl padenter -key 91 all rf(10) numl pad4 -key 92 all rf(11) numl pad5 -key 93 all rf(12) numl pad6 -key 94 all bf(8) numl pad0 -key 95 all lf(9) -key 96 all hole -key 97 all lf(10) -key 98 all shiftkeys+numlock -key 99 all shiftkeys+leftshift up shiftkeys+leftshift -key 100 base z shift Z caps Z ctrl ^Z altg nop -key 101 base x shift X caps X ctrl ^X altg nop -key 102 base c shift C caps C ctrl ^C altg nop -key 103 base v shift V caps V ctrl ^V altg nop -key 104 base b shift B caps B ctrl ^B altg nop -key 105 base n shift N caps N ctrl ^N altg nop -key 106 base m shift M caps M ctrl '\er' altg nop -key 107 base , shift < caps , ctrl , altg nop -key 108 base . shift > caps . ctrl . altg nop -key 109 base / shift ? caps / ctrl ^_ altg nop -key 110 all shiftkeys+rightshift up shiftkeys+rightshift -key 111 all '\en' -key 112 all rf(13) numl pad1 -key 113 all rf(14) numl pad2 -key 114 all rf(15) numl pad3 -key 115 all hole -key 116 all hole -key 117 all hole -key 118 all lf(16) -key 119 all shiftkeys+capslock -key 120 all buckybits+metabit up buckybits+metabit -key 121 base ' ' shift ' ' caps ' ' ctrl ^@ altg ' ' -key 122 all buckybits+metabit up buckybits+metabit -key 123 all hole -key 124 all hole -key 125 all bf(14) numl padplus -key 126 all error numl error up hole -key 127 all idle numl idle up reset -.fi -.in -2 -.sp - -.SH SEE ALSO -.sp -.LP -\fBloadkeys\fR(1) diff --git a/usr/src/man/man4/krb5.conf.4 b/usr/src/man/man4/krb5.conf.4 deleted file mode 100644 index 62dabd5445..0000000000 --- a/usr/src/man/man4/krb5.conf.4 +++ /dev/null @@ -1,1873 +0,0 @@ -'\" te -.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved. -.\" 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 KRB5.CONF 4 "November 22, 2021" -.SH NAME -krb5.conf \- Kerberos configuration file -.SH SYNOPSIS -.nf -/etc/krb5/krb5.conf -.fi - -.SH DESCRIPTION -The \fBkrb5.conf\fR file contains Kerberos configuration information, including -the locations of \fBKDC\fRs and administration daemons for the Kerberos realms -of interest, defaults for the current realm and for Kerberos applications, and -mappings of host names onto Kerberos realms. This file must reside on all -Kerberos clients. -.sp -.LP -The format of the \fBkrb5.conf\fR consists of sections headings in square -brackets. Each section can contain zero or more configuration variables (called -\fIrelations\fR), of the form: -.sp -.LP -\fIrelation\fR= \fIrelation-value\fR -.sp -.LP -or -.sp -.LP -\fIrelation-subsection\fR = { -.br -.in +2 -\fIrelation\fR= \fIrelation-value\fR -.in -2 -.br -.in +2 -\fIrelation\fR= \fIrelation-value\fR -.in -2 -.sp -.LP -} -.sp -.LP -The \fBkrb5.conf\fR file can contain any or all of the following sections: -.sp -.ne 2 -.na -\fB\fBlibdefaults\fR\fR -.ad -.sp .6 -.RS 4n -Contains default values used by the Kerberos V5 library. -.RE - -.sp -.ne 2 -.na -\fB\fBappdefaults\fR\fR -.ad -.sp .6 -.RS 4n -Contains subsections for Kerberos V5 applications, where -\fIrelation-subsection\fR is the name of an application. Each subsection -describes application-specific defaults. -.RE - -.sp -.ne 2 -.na -\fB\fBrealms\fR\fR -.ad -.sp .6 -.RS 4n -Contains subsections for Kerberos realms, where \fIrelation-subsection\fR is -the name of a realm. Each subsection contains relations that define the -properties for that particular realm. -.RE - -.sp -.ne 2 -.na -\fB\fBdomain_realm\fR\fR -.ad -.sp .6 -.RS 4n -Contains relations which map domain names and subdomains onto Kerberos realm -names. This is used by programs to determine what realm a host should be in, -given its fully qualified domain name. -.RE - -.sp -.ne 2 -.na -\fB\fBlogging\fR\fR -.ad -.sp .6 -.RS 4n -Contains relations which determine how Kerberos programs are to perform -logging. -.RE - -.sp -.ne 2 -.na -\fB\fBcapaths\fR\fR -.ad -.sp .6 -.RS 4n -Contains the authentication paths used with direct (nonhierarchical) -cross-realm authentication. Entries in this section are used by the client to -determine the intermediate realms which can be used in cross-realm -authentication. It is also used by the end-service when checking the transited -field for trusted intermediate realms. -.RE - -.sp -.ne 2 -.na -\fB\fBdbmodules\fR\fR -.ad -.sp .6 -.RS 4n -Contains relations for Kerberos database plug-in-specific configuration -information. -.RE - -.sp -.ne 2 -.na -\fB\fBkdc\fR\fR -.ad -.sp .6 -.RS 4n -For a Key Distribution Center (\fBKDC\fR), can contain the location of the -\fBkdc.conf\fR file. -.RE - -.SS "The \fB[libdefaults]\fR Section" -The \fB[libdefaults]\fR section can contain any of the following relations: -.sp -.ne 2 -.na -\fB\fBdatabase_module\fR\fR -.ad -.sp .6 -.RS 4n -Selects the \fBdbmodule\fR section entry to use to access the Kerberos -database. If this parameter is not present the code uses the standard -\fBdb2\fR-based Kerberos database. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault_keytab_name\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the default keytab name to be used by application servers such as -\fBtelnetd\fR and \fBrlogind\fR. The default is \fB/etc/krb5/krb5.keytab\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault_realm\fR\fR -.ad -.sp .6 -.RS 4n -Identifies the default Kerberos realm for the client. Set its value to your -Kerberos realm. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault_tgs_enctypes\fR\fR -.ad -.sp .6 -.RS 4n -Identifies the supported list of session key encryption types that should be -returned by the \fBKDC\fR. The list can be delimited with commas or whitespace. -The supported encryption types are \fBdes3-cbc-sha1-kd\fR, \fBdes-cbc-crc\fR, -\fBdes-cbc-md5\fR, \fBarcfour-hmac-md5\fR, \fBarcfour-hmac-md5-exp\fR, -\fBaes128-cts-hmac-sha1-96\fR, and \fBaes256-cts-hmac-sha1-96\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault_tkt_enctypes\fR\fR -.ad -.sp .6 -.RS 4n -Identifies the supported list of session key encryption types that should be -requested by the client. The format is the same as for -\fBdefault_tgs_enctypes\fR. The supported encryption types are -\fBdes3-cbc-sha1-kd\fR, \fBdes-cbc-crc\fR, \fBdes-cbc-md5\fR, -\fBarcfour-hmac-md5\fR, \fBarcfour-hmac-md5-exp\fR, -\fBaes128-cts-hmac-sha1-96\fR, and \fBaes256-cts-hmac-sha1-96\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBclockskew\fR\fR -.ad -.sp .6 -.RS 4n -Sets the maximum allowable amount of clock skew in seconds that the library -tolerates before assuming that a Kerberos message is invalid. The default value -is 300 seconds, or five minutes. -.RE - -.sp -.ne 2 -.na -\fB\fBforwardable =\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -Sets the "\fBforwardable\fR" flag in all tickets. This allows users to transfer -their credentials from one host to another without reauthenticating. This -option can also be set in the \fB[appdefaults]\fR or \fB[realms]\fR section -(see below) to limit its use in particular applications or just to a specific -realm. -.RE - -.sp -.ne 2 -.na -\fB\fBpermitted_enctypes\fR\fR -.ad -.sp .6 -.RS 4n -This relation controls the encryption types for session keys permitted by -server applications that use Kerberos for authentication. In addition, it -controls the encryption types of keys added to a \fBkeytab\fR by means of the -\fBkadmin\fR(1M) \fBktadd\fR command. The default is: -\fBaes256-cts-hmac-sha1-96\fR, \fBaes128-cts-hmac-sha1-96\fR, -\fBdes3-hmac-sha1-kd\fR, \fBarcfour-hmac-md5\fR, \fBarcfour-hmac-md5-exp\fR, -\fBdes-cbc-md5\fR, \fBdes-cbc-crc\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBproxiable =\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -Sets the \fBproxiable\fR flag in all tickets. This allows users to create a -proxy ticket that can be transferred to a kerberized service to allow that -service to perform some function on behalf of the original user. This option -can also be set in the \fB[appdefaults]\fR or \fB[realms]\fR section (see -below) to limit its use in particular applications or just to a specific realm. -.RE - -.sp -.ne 2 -.na -\fB\fBrenew_lifetime =\fR\fIlifetime\fR\fR -.ad -.sp .6 -.RS 4n -Requests renewable tickets, with a total lifetime of \fIlifetime\fR. The value -for \fIlifetime\fR must be followed immediately by one of the following -delimiters: -.sp -.ne 2 -.na -\fB\fBs\fR\fR -.ad -.sp .6 -.RS 4n -seconds -.RE - -.sp -.ne 2 -.na -\fB\fBm\fR\fR -.ad -.sp .6 -.RS 4n -minutes -.RE - -.sp -.ne 2 -.na -\fB\fBh\fR\fR -.ad -.sp .6 -.RS 4n -hours -.RE - -.sp -.ne 2 -.na -\fB\fBd\fR\fR -.ad -.sp .6 -.RS 4n -days -.RE - -Example: -.sp -.in +2 -.nf -\fBrenew_lifetime = 90m\fR -.fi -.in -2 -.sp - -Do not mix units. A value of "\fB3h30m\fR" results in an error. -.RE - -.sp -.ne 2 -.na -\fB\fBmax_lifetime =\fR\fIlifetime\fR\fR -.ad -.sp .6 -.RS 4n -Sets the requested maximum lifetime of the ticket. The values for -\fIlifetime\fR follow the format described for the \fBrenew_lifetime\fR option, -above. -.RE - -.sp -.ne 2 -.na -\fB\fBdns_lookup_kdc\fR\fR -.ad -.sp .6 -.RS 4n -Indicates whether DNS SRV records need to be used to locate the KDCs and the -other servers for a realm, if they have not already been listed in the -\fB[realms]\fR section. This option makes the machine vulnerable to a certain -type of DoS attack if someone spoofs the DNS records and does a redirect to -another server. This is, however, no worse than a DoS, since the bogus KDC is -unable to decode anything sent (excepting the initial ticket request, which has -no encrypted data). Also, anything the fake KDC sends out isl not trusted -without verification (the local machine is unaware of the secret key to be -used). If \fBdns_lookup_kdc\fR is not specified but \fBdns_fallback\fR is, then -that value is used instead. In either case, values (if present) in the -\fB[realms]\fR section override DNS. \fBdns_lookup_kdc\fR is enabled by -default. -.RE - -.sp -.ne 2 -.na -\fB\fBdns_lookup_realm\fR\fR -.ad -.sp .6 -.RS 4n -Indicates whether DNS TXT records need to be used to determine the Kerberos -realm information and/or the host/domain name-to-realm mapping of a host, if -this information is not already present in the \fBkrb5.conf\fR file. Enabling -this option might make the host vulnerable to a redirection attack, wherein -spoofed DNS replies persuade a client to authenticate to the wrong realm. In a -realm with no cross-realm trusts, this a DoS attack. If \fBdns_lookup_realm\fR -is not specified but \fBdns_fallback\fR is, then that value is used instead. In -either case, values (if present) in the \fB[libdefaults]\fR and -\fB[domain_realm]\fR sections override DNS. -.RE - -.sp -.ne 2 -.na -\fB\fBdns_fallback\fR\fR -.ad -.sp .6 -.RS 4n -Generic flag controlling the use of DNS for retrieval of information about -Kerberos servers and host/domain name-to-realm mapping. If both -\fBdns_lookup_kdc\fR and \fBdns_lookup_realm\fR have been specified, this -option has no effect. -.RE - -.sp -.ne 2 -.na -\fB\fBverify_ap_req_nofail [true | false]\fR\fR -.ad -.sp .6 -.RS 4n -If \fBtrue\fR, the local keytab file (\fB/etc/krb5/krb5.keytab\fR) must contain -an entry for the local \fBhost\fR principal, for example, -\fBhost/foo.example.net@EXAMPLE.COM\fR. This entry is needed to verify that the -\fBTGT\fR requested was issued by the same \fBKDC\fR that issued the key for -the host principal. If undefined, the behavior is as if this option were set to -\fBtrue\fR. Setting this value to \fBfalse\fR leaves the system vulnerable to -\fBDNS\fR spoofing attacks. This parameter can be in the \fB[realms]\fR section -to set it on a per-realm basis, or it can be in the \fB[libdefaults]\fR section -to make it a network-wide setting for all realms. -.RE - -.SS "The \fB[appdefaults]\fR Section" -This section contains subsections for Kerberos V5 applications, where -\fIrelation-subsection\fR is the name of an application. Each subsection -contains relations that define the default behaviors for that application. -.sp -.LP -The following relations can be found in the \fB[appdefaults]\fR section, though -not all relations are recognized by all kerberized applications. Some are -specific to particular applications. -.sp -.ne 2 -.na -\fB\fBautologin =\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -Forces the application to attempt automatic login by presenting Kerberos -credentials. This is valid for the following applications: \fBrlogin\fR, -\fBrsh\fR, \fBrcp\fR, \fBrdist\fR, and \fBtelnet\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBencrypt =\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -Forces applications to use encryption by default (after authentication) to -protect the privacy of the sessions. This is valid for the following -applications: \fBrlogin\fR, \fBrsh\fR, \fBrcp\fR, \fBrdist\fR, and -\fBtelnet\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBforward =\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -Forces applications to forward the user'ss credentials (after authentication) -to the remote server. This is valid for the following applications: -\fBrlogin\fR, \fBrsh\fR, \fBrcp\fR, \fBrdist\fR, and \fBtelnet\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBforwardable =\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -See the description in the \fB[libdefaults]\fR section above. This is used by -any application that creates a ticket granting ticket and also by applications -that can forward tickets to a remote server. -.RE - -.sp -.ne 2 -.na -\fB\fBproxiable =\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -See the description in the \fB[libdefaults]\fR section above. This is used by -any application that creates a ticket granting ticket. -.RE - -.sp -.ne 2 -.na -\fB\fBrenewable =\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -Creates a TGT that can be renewed (prior to the ticket expiration time). This -is used by any application that creates a ticket granting ticket. -.RE - -.sp -.ne 2 -.na -\fB\fBno_addresses =\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -Creates tickets with no address bindings. This is to allow tickets to be used -across a \fBNAT\fR boundary or when using multi-homed systems. This option is -valid in the \fBkinit\fR \fB[appdefault]\fR section only. -.RE - -.sp -.ne 2 -.na -\fB\fBmax_life =\fR\fIlifetime\fR\fR -.ad -.sp .6 -.RS 4n -Sets the maximum lifetime of the ticket, with a total lifetime of -\fIlifetime\fR. The values for \fIlifetime\fR follow the format described in -the \fB[libdefaults]\fR section above. This option is obsolete and is removed -in a future release of the Solaris operating system. -.RE - -.sp -.ne 2 -.na -\fB\fBmax_renewable_life =\fR\fIlifetime\fR\fR -.ad -.sp .6 -.RS 4n -Requests renewable tickets, with a total lifetime of \fIlifetime\fR. The values -for \fIlifetime\fR follow the format described in the \fB[libdefaults]\fR -section above. This option is obsolete and is removed in a future release of -the Solaris operating system. -.RE - -.sp -.ne 2 -.na -\fB\fBrcmd_protocol =\fR [ \fBrcmdv1\fR | \fBrcmdv2\fR ]\fR -.ad -.sp .6 -.RS 4n -Specifies which Kerberized "\fBrcmd\fR" protocol to use when using the -Kerberized \fBrlogin\fR(1), \fBrsh\fR(1), \fBrcp\fR(1), or \fBrdist\fR(1) -programs. The default is to use \fBrcmdv2\fR by default, as this is the more -secure and more recent update of the protocol. However, when talking to older -\fBMIT\fR or \fBSEAM\fR-based "\fBrcmd\fR" servers, it can be necessary to -force the new clients to use the older \fBrcmdv1\fR protocol. This option is -valid only for the following applications: \fBrlogin\fR, \fBrcp\fR, \fBrsh\fR, -and \fBrdist\fR. -.RE - -.sp -.LP -The following application defaults can be set to \fBtrue\fR or \fBfalse\fR: -.sp -.in +2 -.nf -kinit - forwardable = true - proxiable = true - renewable = true - no_addresses = true - max_life = \fIdelta_time\fR - max_renewable_life = \fIdelta_time\fR -.fi -.in -2 -.sp - -.sp -.LP -See \fBkinit\fR(1) for the valid time duration formats you can specify for -\fIdelta_time\fR. -.sp -.LP -In the following example, \fBkinit\fR gets forwardable tickets by default and -\fBtelnet\fR has three default behaviors specified: -.sp -.in +2 -.nf -[appdefaults] - kinit = { - forwardable = true - } - - telnet = { - forward = true - encrypt = true - autologin = true - } -.fi -.in -2 -.sp - -.sp -.LP -The application defaults specified here are overridden by those specified in -the \fB[realms]\fR section. -.SS "The \fB[realms]\fR Section" -This section contains subsections for Kerberos realms, where -\fIrelation-subsection\fR is the name of a realm. Each subsection contains -relations that define the properties for that particular realm. The following -relations can be specified in each \fB[realms]\fR subsection: -.sp -.ne 2 -.na -\fB\fBadmin_server\fR\fR -.ad -.sp .6 -.RS 4n -Identifies the host where the Kerberos administration daemon (\fBkadmind\fR) is -running. Typically, this is the master \fBKDC\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIapplication defaults\fR\fR -.ad -.sp .6 -.RS 4n -Application defaults that are specific to a particular realm can be specified -within a \fB[realms]\fR subsection. Realm-specific application defaults -override the global defaults specified in the \fB[appdefaults]\fR section. -.RE - -.sp -.ne 2 -.na -\fB\fBauth_to_local_realm\fR\fR -.ad -.sp .6 -.RS 4n -For use in the default realm, non-default realms can be equated with the -default realm for authenticated name-to-local name mapping. -.RE - -.sp -.ne 2 -.na -\fB\fBauth_to_local_names\fR\fR -.ad -.sp .6 -.RS 4n -This subsection allows you to set explicit mappings from principal names to -local user names. The tag is the mapping name and the value is the -corresponding local user name. -.RE - -.sp -.ne 2 -.na -\fB\fBauth_to_local\fR\fR -.ad -.sp .6 -.RS 4n -This tag allows you to set a general rule for mapping principal names to local -user names. It is used if there is not an explicit mapping for the principal -name that is being translated. The possible values are: -.sp -.in +2 -.nf -RULE:[<ncomps>:<format>](<regex>)s/<regex>/<text>/ -.fi -.in -2 - -Each rule has three parts: -.sp -.ne 2 -.na -\fBFirst part\(emFormulate the string on which to perform operations:\fR -.ad -.sp .6 -.RS 4n -If not present then the string defaults to the fully flattened principal minus -the realm name. Otherwise the syntax is as follows: -.sp -.in +2 -.nf -"[" \fI<ncomps>\fR ":" \fI<format>\fR "]" -.fi -.in -2 - -Where: -.sp -\fI<ncomps>\fR is the number of expected components for this rule. If the -particular principal does not have this number of components, then this rule -does not apply. -.sp -\fI<format>\fR is a string of \fI<component>\fR or verbatim characters to be -inserted. -.sp -\fI<component>\fR is of the form "\fB$\fR"\fI<number>\fR to select the -\fI<number>\fRth component. \fI<number>\fR begins from 1. -.RE - -.sp -.ne 2 -.na -\fBSecond part\(emselect rule validity:\fR -.ad -.sp .6 -.RS 4n -If not present, this rule can apply to all selections. Otherwise the syntax is -as follows: -.sp -.in +2 -.nf -"(" \fI<regex>\fR ")" -.fi -.in -2 - -Where: -.sp -\fI<regex>\fR is a selector regular expression. If this regular expression -matches the whole pattern generated from the first part, then this rule still -applies. -.RE - -.sp -.ne 2 -.na -\fBThird part\(emTransform rule:\fR -.ad -.sp .6 -.RS 4n -If not present, then the selection string is passed verbatim and is matched. -Otherwise, the syntax is as follows: -.sp -.in +2 -.nf -\fI<rule>\fR ... -.fi -.in -2 - -Where: -.sp -\fI<rule>\fR is of the form: -.sp -.in +2 -.nf -"s/" <regex> "/" <text> "/" ["g"] -.fi -.in -2 - -Regular expressions are defined in \fBregex\fR(5). -.sp -For example: -.sp -auth_to_local = RULE:[1:$1@$0](.*@.*EXAMPLE\.COM)s/@.*// -.sp -The preceding maps \fB\fIusername\fR@EXAMPLE.COM\fR and all sub-realms of -\fBEXAMPLE.COM\fR to \fIusername\fR. -.RE - -.sp -.ne 2 -.na -\fBDEFAULT\fR -.ad -.sp .6 -.RS 4n -The principal name is used as the local name. If the principal has more than -one component or is not in the default realm, this rule is not applicable and -the conversion fails. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBdatabase_module\fR\fR -.ad -.sp .6 -.RS 4n -Selects the \fBdbmodule\fR section entry to use to access the Kerberos -database. -.RE - -.sp -.ne 2 -.na -\fB\fBextra_addresses\fR...\fR -.ad -.sp .6 -.RS 4n -This allows a computer to use multiple local addresses, to allow Kerberos to -work in a network that uses NATs. The addresses should be in a comma-separated -list. -.RE - -.sp -.ne 2 -.na -\fB\fBkdc\fR\fR -.ad -.sp .6 -.RS 4n -The name of a host running a \fBKDC\fR for that realm. An optional port number -(separated from the hostname by a colon) can be included. -.RE - -.sp -.ne 2 -.na -\fB\fBkpasswd_server\fR\fR -.ad -.sp .6 -.RS 4n -Identifies the host where the Kerberos password-changing server is running. -Typically, this is the same as host indicated in the \fBadmin_server\fR. If -this parameter is omitted, the host in \fBadmin_server\fR is used. You can also -specify a port number if the server indicated by \fBkpasswd_server\fR runs on a -port other than 464 (the default). The format of this parameter is: -\fIhostname\fR[:\fIport\fR]. -.RE - -.sp -.ne 2 -.na -\fB\fBkpasswd_protocol\fR\fR -.ad -.sp .6 -.RS 4n -Identifies the protocol to be used when communicating with the server indicated -by \fBkpasswd_server\fR. By default, this parameter is defined to be -\fBRPCSEC_GSS\fR, which is the protocol used by Solaris-based administration -servers. To be able to change a principal's password stored on non-Solaris -Kerberos server, such as Microsoft Active Directory or \fBMIT\fR Kerberos, this -value should be \fBSET_CHANGE\fR. This indicates that a non-RPC- based protocol -is used to communicate the password change request to the server in the -\fBkpasswd_server\fR entry. -.RE - -.sp -.ne 2 -.na -\fB\fBudp_preference_limit\fR\fR -.ad -.sp .6 -.RS 4n -When sending a message to the KDC, the library tries using TCP before UDP if -the size of the message is above \fBudp_preference_limit\fR. If the message is -smaller than \fBudp_preference_limit\fR, then UDP is tried before TCP. -Regardless of the size, both protocols are tried if the first attempt fails. -.RE - -.sp -.ne 2 -.na -\fB\fBverify_ap_req_nofail\fR [\fBtrue\fR | \fBfalse\fR]\fR -.ad -.sp .6 -.RS 4n -If \fBtrue\fR, the local keytab file (\fB/etc/krb5/krb5.keytab\fR) must contain -an entry for the local \fBhost\fR principal, for example, -\fBhost/foo.example.net@EXAMPLE.COM\fR. This entry is needed to verify that the -\fBTGT\fR requested was issued by the same \fBKDC\fR that issued the key for -the host principal. If undefined, the behavior is as if this option were set to -\fBtrue\fR. Setting this value to \fBfalse\fR leaves the system vulnerable to -\fBDNS\fR spoofing attacks. This parameter might be in the \fB[realms]\fR -section to set it on a per-realm basis, or it might be in the -\fB[libdefaults]\fR section to make it a network-wide setting for all realms. -.RE - -.sp -.LP -The parameters "\fBforwardable\fR", "\fBproxiable\fR", and -"\fBrenew_lifetime\fR" as described in the \fB[libdefaults]\fR section (see -above) are also valid in the \fB[realms]\fR section. -.sp -.LP -Notice that \fBkpasswd_server\fR and \fBkpasswd_protocol\fR are realm-specific -parameters. Most often, you need to specify them only when using a -non-Solaris-based Kerberos server. Otherwise, the change request is sent over -\fBRPCSEC_GSS\fR to the Solaris Kerberos administration server. -.SS "The \fB[domain_realm]\fR Section" -This section provides a translation from a domain name or hostname to a -Kerberos realm name. The \fIrelation\fR can be a host name, or a domain name, -where domain names are indicated by a period (`\fB\&.\fR') prefix. -\fIrelation-value\fR is the Kerberos realm name for that particular host or -domain. Host names and domain names should be in lower case. -.sp -.LP -If no translation entry applies, the host's realm is considered to be the -hostname's domain portion converted to upper case. For example, the following -\fB[domain_realm]\fR section maps \fBcrash.mit.edu\fR into the -\fBTEST.ATHENA.MIT.EDU\fR realm: -.sp -.in +2 -.nf -[domain_realm] - .mit.edu = ATHENA.MIT.EDU - mit.edu = ATHENA.MIT.EDU - crash.mit.edu = TEST.ATHENA.MIT.EDU - .example.org = EXAMPLE.ORG - example.org = EXAMPLE.ORG -.fi -.in -2 -.sp - -.sp -.LP -All other hosts in the \fBmit.edu\fR domain maps by default to the -\fBATHENA.MIT.EDU\fR realm, and all hosts in the \fBexample.org\fR domain maps by -default into the \fBEXAMPLE.ORG\fR realm. The entries for the hosts \fBmit.edu\fR -and \fBexample.org\fR. Without these entries, these hosts would be mapped into -the Kerberos realms \fBEDU\fR and \fBORG\fR, respectively. -.SS "The \fB[logging]\fR Section" -This section indicates how Kerberos programs are to perform logging. There are -two types of relations for this section: relations to specify how to log and a -relation to specify how to rotate \fBkdc\fR log files. -.sp -.LP -The following relations can be defined to specify how to log. The same relation -can be repeated if you want to assign it multiple logging methods. -.sp -.ne 2 -.na -\fB\fBadmin_server\fR\fR -.ad -.sp .6 -.RS 4n -Specifies how to log the Kerberos administration daemon (\fBkadmind\fR). The -default is \fBFILE:/var/krb5/kadmin.log.\fR -.RE - -.sp -.ne 2 -.na -\fB\fBdefault\fR\fR -.ad -.sp .6 -.RS 4n -Specifies how to perform logging in the absence of explicit specifications -otherwise. -.RE - -.sp -.ne 2 -.na -\fB\fBkdc\fR\fR -.ad -.sp .6 -.RS 4n -Specifies how the \fBKDC\fR is to perform its logging. The default is -\fBFILE:/var/krb5/kdc.log\fR. -.RE - -.sp -.LP -The \fBadmin_server\fR, \fBdefault\fR, and \fBkdc\fR relations can have the -following values: -.sp -.ne 2 -.na -\fB\fBFILE:\fR\fIfilename\fR\fR -.ad -.br -.na -\fB\fBFILE=\fR\fIfilename\fR\fR -.ad -.sp .6 -.RS 4n -This value causes the entity's logging messages to go to the specified file. If -the `=' form is used, the file is overwritten. If the `:' form is used, the -file is appended to. -.RE - -.sp -.ne 2 -.na -\fB\fBSTDERR\fR\fR -.ad -.sp .6 -.RS 4n -This value causes the entity's logging messages to go to its standard error -stream. -.RE - -.sp -.ne 2 -.na -\fB\fBCONSOLE\fR\fR -.ad -.sp .6 -.RS 4n -This value causes the entity's logging messages to go to the console, if the -system supports it. -.RE - -.sp -.ne 2 -.na -\fB\fBDEVICE=\fR\fIdevicename\fR\fR -.ad -.sp .6 -.RS 4n -This causes the entity's logging messages to go to the specified device. -.RE - -.sp -.ne 2 -.na -\fB\fBSYSLOG[:\fR\fIseverity\fR\fB[:\fR\fIfacility\fR\fB]]\fR\fR -.ad -.sp .6 -.RS 4n -This causes the entity's logging messages to go to the system log. -.RE - -.sp -.LP -The \fIseverity\fR argument specifies the default severity of system log -messages. This can be any of the following severities supported by the -\fBsyslog\fR(3C) call, minus the \fBLOG_\fR prefix: \fBLOG_EMERG\fR, -\fBLOG_ALERT\fR, \fBLOG_CRIT\fR, \fBLOG_ERR\fR, \fBLOG_WARNING\fR, -\fBLOG_NOTICE\fR, \fBLOG_INFO\fR, and \fBLOG_DEBUG\fR. For example, a value of -\fBCRIT\fR would specify \fBLOG_CRIT\fR severity. -.sp -.LP -The \fIfacility\fR argument specifies the facility under which the messages are -logged. This can be any of the following facilities supported by the -\fBsyslog\fR(3C) call minus the \fBLOG_\fR prefix: \fBLOG_KERN\fR, -\fBLOG_USER\fR, \fBLOG_MAIL\fR, \fBLOG_DAEMON\fR, \fBLOG_AUTH\fR, -\fBLOG_LPR\fR, \fBLOG_NEWS\fR, \fBLOG_UUCP\fR, \fBLOG_CRON\fR, and -\fBLOG_LOCAL0\fR through \fBLOG_LOCAL7\fR. -.sp -.LP -If no severity is specified, the default is \fBERR\fR. If no facility is -specified, the default is \fBAUTH\fR. -.sp -.LP -The following relation can be defined to specify how to rotate \fBkdc\fR log -files if the \fBFILE:\fR value is being used to log: -.sp -.ne 2 -.na -\fB\fBkdc_rotate\fR\fR -.ad -.sp .6 -.RS 4n -A relation subsection that enables \fBkdc\fR logging to be rotated to multiple -files based on a time interval. This can be used to avoid logging to one file, -which might grow too large and bring the \fBKDC\fR to a halt. -.RE - -.sp -.LP -The time interval for the rotation is specified by the \fBperiod\fR relation. -The number of log files to be rotated is specified by the \fBversions\fR -relation. Both the \fBperiod\fR and \fBversions\fR (described below) should be -included in this subsection. And, this subsection applies only if the \fBkdc\fR -relation has a \fBFILE:\fR value. -.sp -.LP -The following relations can be specified for the \fBkdc_rotate\fR relation -subsection: -.sp -.ne 2 -.na -\fB\fB\fR\fBperiod=\fIdelta_time\fR\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the time interval before a new log file is created. See the -\fBTime\fR\fBFormats\fR section in \fBkinit\fR(1) for the valid time duration -formats you can specify for \fIdelta_time\fR. If \fBperiod\fR is not specified -or set to \fBnever\fR, no rotation occurs. -.RE - -.sp -.LP -Specifying a time interval does not mean that the log files are rotated at the -time interval based on real time. This is because the time interval is checked -at each attempt to write a record to the log, or when logging is actually -occurring. Therefore, rotation occurs only when logging has actually occurred -for the specified time interval. -.sp -.ne 2 -.na -\fB\fBversions=\fR\fInumber\fR\fR -.ad -.sp .6 -.RS 4n -Specifies how many previous versions are saved before the rotation begins. A -number is appended to the log file, starting with 0 and ending with -(\fInumber\fR - 1). For example, if \fBversions\fR is set to \fB2\fR, up to -three logging files are created (\fIfilename\fR, \fIfilename\fR.0, and -\fIfilename\fR.1) before the first one is overwritten to begin the rotation. -.RE - -.sp -.LP -Notice that if \fBversions\fR is not specified or set to \fB0\fR, only one log -file is created, but it is overwritten whenever the time interval is met. -.sp -.LP -In the following example, the logging messages from the Kerberos administration -daemon goes to the console. The logging messages from the \fBKDC\fR is appended -to the \fB/var/krb5/kdc.log\fR, which is rotated between twenty-one log files -with a specified time interval of a day. -.sp -.in +2 -.nf -[logging] - admin_server = CONSOLE - kdc = FILE:/export/logging/kadmin.log - kdc_rotate = { - period = 1d - versions = 20 - } -.fi -.in -2 -.sp - -.SS "The \fB[capaths]\fR Section" -In order to perform direct (non-hierarchical) cross-realm authentication, a -database is needed to construct the authentication paths between the realms. -This section defines that database. -.sp -.LP -A client uses this section to find the authentication path between its realm -and the realm of the server. The server uses this section to verify the -authentication path used by the client, by checking the transited field of the -received ticket. -.sp -.LP -There is a subsection for each participating realm, and each subsection has -relations named for each of the realms. The \fIrelation-value\fR is an -intermediate realm which can participate in the cross-realm authentication. The -relations can be repeated if there is more than one intermediate realm. A value -of '.' means that the two realms share keys directly, and no intermediate -realms should be allowed to participate. -.sp -.LP -There are n**2 possible entries in this table, but only those entries which is -needed on the client or the server need to be present. The client needs a -subsection named for its local realm, with relations named for all the realms -of servers it needs to authenticate with. A server needs a subsection named for -each realm of the clients it serves. -.sp -.LP -For example, \fBANL.GOV\fR, \fBPNL.GOV\fR, and \fBNERSC.GOV\fR all wish to use -the \fBES.NET\fR realm as an intermediate realm. \fBANL\fR has a sub realm of -\fBTEST.ANL.GOV\fR, which authenticates with \fBNERSC.GOV\fR but not -\fBPNL.GOV\fR. The \fB[capath]\fR section for \fBANL.GOV\fR systems would look -like this: -.sp -.in +2 -.nf -[capaths] - ANL.GOV = { - TEST.ANL.GOV = . - PNL.GOV = ES.NET - NERSC.GOV = ES.NET - ES.NET = . - } - - TEST.ANL.GOV = { - ANL.GOV = . - } - - PNL.GOV = { - ANL.GOV = ES.NET - } - - NERSC.GOV = { - ANL.GOV = ES.NET - } - - ES.NET = { - ANL.GOV = . - } -.fi -.in -2 -.sp - -.sp -.LP -The \fB[capath]\fR section of the configuration file used on \fBNERSC.GOV\fR -systems would look like this: -.sp -.in +2 -.nf -[capaths] - NERSC.GOV = { - ANL.GOV = ES.NET - TEST.ANL.GOV = ES.NET - TEST.ANL.GOV = ANL.GOV - PNL.GOV = ES.NET - ES.NET = . - } - - ANL.GOV = { - NERSC.GOV = ES.NET - } - - PNL.GOV = { - NERSC.GOV = ES.NET - } - - ES.NET = { - NERSC.GOV = . - } - - TEST.ANL.GOV = { - NERSC.GOV = ANL.GOV - NERSC.GOV = ES.NET - } -.fi -.in -2 -.sp - -.sp -.LP -In the above examples, the ordering is not important, except when the same -relation is used more than once. The client uses this to determine the path. -(It is not important to the server, since the transited field is not sorted.) -.SS "PKINIT-specific Options" -The following are \fBpkinit-specific\fR options. These values can be specified -in \fB[libdefaults]\fR as global defaults, or within a realm-specific -subsection of \fB[libdefaults]\fR, or can be specified as realm-specific values -in the \fB[realms]\fR section. A realm-specific value overrides, does not add -to, a generic \fB[libdefaults]\fR specification. -.sp -.LP -The search order is: -.RS +4 -.TP -1. -realm-specific subsection of \fB[libdefaults]\fR -.sp -.in +2 -.nf - [libdefaults] - EXAMPLE.COM = { - pkinit_anchors = FILE:/usr/local/example.com.crt -.fi -.in -2 - -.RE -.RS +4 -.TP -2. -realm-specific value in the \fB[realms]\fR section -.sp -.in +2 -.nf - [realms] - OTHERREALM.ORG = { - pkinit_anchors = FILE:/usr/local/otherrealm.org.crt -.fi -.in -2 - -.RE -.RS +4 -.TP -3. -generic value in the \fB[libdefaults]\fR section -.sp -.in +2 -.nf - [libdefaults] - pkinit_anchors = DIR:/usr/local/generic_trusted_cas/ -.fi -.in -2 - -.RE -.sp -.LP -The syntax for specifying Public Key identity, trust, and revocation -information for \fBpkinit\fR is as follows: -.sp -.ne 2 -.na -\fB\fBpkinit_identities\fR \fB=\fR \fIURI\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the location(s) to be used to find the user's X.509 identity -information. This option can be specified multiple times. Each value is -attempted in order until identity information is found and authentication is -attempted. These values are not used if the user specifies -\fBX509_user_identity\fR on the command line. -.sp -Valid \fIURI\fR types are \fBFILE\fR, \fBDIR\fR, \fBPKCS11\fR, \fBPKCS12\fR, -and \fBENV\fR. See the \fBPKINIT URI Types\fR section for more details. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_anchors\fR \fB=\fR \fIURI\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the location of trusted anchor (root) certificates which the client -trusts to sign KDC certificates. This option can be specified multiple times. -These values from the \fBconfig\fR file are not used if the user specifies -\fBX509_anchors\fR on the command line. -.sp -Valid \fIURI\fR types are \fBFILE\fR and \fBDIR\fR. See the \fBPKINIT URI -Types\fR section for more details. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_pool\fR \fB=\fR \fIURI\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the location of intermediate certificates which can be used by the -client to complete the trust chain between a KDC certificate and a trusted -anchor. This option can be specified multiple times. -.sp -Valid \fIURI\fR types are \fBFILE\fR and \fBDIR\fR. See the \fBPKINIT URI -Types\fR section for more details. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_revoke\fR \fB=\fR \fIURI\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the location of Certificate Revocation List (CRL) information to be -used by the client when verifying the validity of the KDC certificate -presented. This option can be specified multiple times. -.sp -The only valid \fIURI\fR type is \fBDIR\fR. See the \fBPKINIT URI Types\fR -section for more details. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_require_crl_checking\fR \fB=\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -The default certificate verification process always checks the available -revocation information to see if a certificate has been revoked. If a match is -found for the certificate in a CRL, verification fails. If the certificate -being verified is not listed in a CRL, or there is no CRL present for its -issuing CA, and \fBpkinit_require_crl_checking\fR is \fBfalse\fR, then -verification succeeds. However, if \fBpkinit_require_crl_checking\fR is -\fBtrue\fR and there is no CRL information available for the issuing CA, then -verification fails. \fBpkinit_require_crl_checking\fR should be set to -\fBtrue\fR if the policy is such that up-to-date CRLs must be present for every -CA. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_dh_min_bits\fR \fB=\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the size of the Diffie-Hellman key the client attempts to use. The -acceptable values are currently 1024, 2048, and 4096. The default is 2048. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_win2k\fR \fB=\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -This flag specifies whether the target realm is assumed to support only the -old, pre-RFC version of the protocol. The default is \fBfalse\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_win2k_require_binding\fR \fB=\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -If this flag is set to \fBtrue\fR, it expects that the target KDC is patched to -return a reply with a checksum rather than a nonce. The default is \fBfalse\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_eku_checking\fR \fB=\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -This option specifies what Extended Key Usage value the KDC certificate -presented to the client must contain. If the KDC certificate has the \fBpkinit -SubjectAlternativeName\fR encoded as the Kerberos TGS name, EKU checking is not -necessary since the issuing CA has certified this as a KDC certificate. The -values recognized in the \fBkrb5.conf\fR file are: -.sp -.ne 2 -.na -\fB\fBkpKDC\fR\fR -.ad -.RS 16n -This is the default value and specifies that the KDC must have the -\fBid-pkinit-KPKdc EKU\fR as defined in RFC4556. -.RE - -.sp -.ne 2 -.na -\fB\fBkpServerAuth\fR\fR -.ad -.RS 16n -If \fBkpServerAuth\fR is specified, a KDC certificate with the -\fBid-kp-serverAuth EKU\fR as used by Microsoft is accepted. -.RE - -.sp -.ne 2 -.na -\fB\fBnone\fR\fR -.ad -.RS 16n -If \fBnone\fR is specified, then the KDC certificate is not checked to verify -it has an acceptable EKU. The use of this option is not recommended. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_kdc_hostname\fR \fB=\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -The presence of this option indicates that the client is willing to accept a -KDC certificate with a \fBdNSName\fR SAN (Subject Alternative Name) rather than -requiring the \fBid-pkinit-san\fR as defined in RFC4556. This option can be -specified multiple times. Its value should contain the acceptable hostname for -the KDC (as contained in its certificate). -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_cert_match\fR \fB=\fR \fIrule\fR\fR -.ad -.sp .6 -.RS 4n -Specifies matching rules that the client certificate must match before it is -used to attempt \fBpkinit\fR authentication. If a user has multiple -certificates available (on a smart card, or by way of another media), there -must be exactly one certificate chosen before attempting \fBpkinit\fR -authentication. This option can be specified multiple times. All the -available certificates are checked against each rule in order until there is a -match of exactly one certificate. -.sp -The Subject and Issuer comparison strings are the RFC2253 string -representations from the certificate Subject DN and Issuer DN values. -.sp -The syntax of the matching rules is: -.sp -.in +2 -.nf -[relation-operator]component-rule `...' -.fi -.in -2 - -where -.sp -.ne 2 -.na -\fB\fIrelation-operator\fR\fR -.ad -.RS 21n -Specify \fIrelation-operator\fR as \fB&&\fR, meaning all component rules must -match, or \fB||\fR, meaning only one component rule must match. If -\fIrelation-operator\fR is not specified, the default is \fB&&\fR\&. -.RE - -.sp -.ne 2 -.na -\fB\fIcomponent-rule\fR\fR -.ad -.RS 21n -There is no punctuation or white space between component rules.Specify -\fIcomponent-rule\fR as one of the following: -.sp -.in +2 -.nf -`<SUBJECT>'regular-expression - -`<ISSUER>'regular-expression - -`<SAN>'regular-expression - -`<EKU>'extended-key-usage-list - where extended-key-usage-list is a comma-separated list - of required Extended Key Usage values. All values in - the list must be present in the certificate. - `pkinit' - `msScLogin' - `clientAuth' - `emailProtection' -`<KU>'key-usage-list - where key-usage-list is a comma-separated list of - required Key Usage values. All values in the list must - be present in the certificate. - `digitalSignature' -.fi -.in -2 - -.RE - -Examples: -.sp -.in +2 -.nf -pkinit_cert_match = ||<SUBJECT>.*DoE.*<SAN>.*@EXAMPLE.COM -pkinit_cert_match = &&<EKU>msScLogin,clientAuth<ISSUER>.*DoE.* -pkinit_cert_match = <EKU>msScLogin,clientAuth<KU>digitalSignature -.fi -.in -2 - -.RE - -.SS "PKINIT URI Types" -.ne 2 -.na -\fB\fBFILE:\fR\fIfile-name[,key-file-name]\fR\fR -.ad -.sp .6 -.RS 4n -This option has context-specific behavior. -.sp -.ne 2 -.na -\fB\fBpkinit_identities\fR\fR -.ad -.RS 21n -\fIfile-name\fR specifies the name of a PEM-format file containing the user's -certificate. If \fIkey-file-name\fR is not specified, the user's private key -is expected to be in \fIfile-name\fR as well. Otherwise, \fIkey-file-name\fR -is the name of the file containing the private key. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_anchors\fR\fR -.ad -.br -.na -\fB\fBpkinit_pool\fR\fR -.ad -.RS 21n -\fIfile-name\fR is assumed to be the name of an \fBOpenSSL-style ca-bundle\fR -file. The \fBca-bundle\fR file should be base-64 encoded. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBDIR:\fR\fIdirectory-name\fR\fR -.ad -.sp .6 -.RS 4n -This option has context-specific behavior. -.sp -.ne 2 -.na -\fB\fBpkinit_identities\fR\fR -.ad -.RS 21n -\fIdirectory-name\fR specifies a directory with files named \fB*.crt\fR and -\fB*.key\fR, where the first part of the file name is the same for matching -pairs of certificate and private key files. When a file with a name ending with -\&.\fBcrt\fR is found, a matching file ending with \fB\&.key\fR is assumed to -contain the private key. If no such file is found, then the certificate in the -\fB\&.crt\fR is not used. -.RE - -.sp -.ne 2 -.na -\fB\fBpkinit_anchors\fR\fR -.ad -.br -.na -\fB\fBpkinit_pool\fR\fR -.ad -.RS 21n -\fIdirectory-name\fR is assumed to be an OpenSSL-style hashed CA directory -where each CA cert is stored in a file named \fBhash-of-ca-cert\fR.\fI#\fR. -This infrastructure is encouraged, but all files in the directory are examined -and if they contain certificates (in PEM format), they are used. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBPKCS12:\fR\fIpkcs12-file-name\fR\fR -.ad -.sp .6 -.RS 4n -\fIpkcs12-file-name\fR is the name of a \fBPKCS #12\fR format file, containing -the user's certificate and private key. -.RE - -.sp -.ne 2 -.na -\fB\fBPKCS11:[slotid=\fR\fIslot-id\fR\fB][:token=\fR\fItoken-label\fR\fB][:cert -id=\fR\fIcert-id\fR\fB][:certlabel=\fR\fIcert-label\fR\fB]\fR\fR -.ad -.sp .6 -.RS 4n -All keyword/values are optional. PKCS11 modules (for example, -\fBopensc-pkcs11.so\fR) must be installed as a \fBcrypto\fR provider under -\fBlibpkcs11\fR(3LIB). \fBslotid=\fR and/or \fBtoken=\fR can be specified to -force the use of a particular smart card reader or token if there is more than -one available. \fBcertid=\fR and/or \fBcertlabel=\fR can be specified to force -the selection of a particular certificate on the device. See the -\fBpkinit_cert_match\fR configuration option for more ways to select a -particular certificate to use for \fBpkinit\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBENV:\fR\fIenvironment-variable-name\fR\fR -.ad -.sp .6 -.RS 4n -\fIenvironment-variable-name\fR specifies the name of an environment variable -which has been set to a value conforming to one of the previous values. For -example, \fBENV:X509_PROXY\fR, where environment variable \fBX509_PROXY\fR has -been set to \fBFILE:/tmp/my_proxy.pem\fR. -.RE - -.SS "The \fB[dbmodules]\fR Section" -This section consists of relations that provide configuration information for -plug-in modules. In particular, the relations describe the configuration for -LDAP KDB plug-in. Use of the \fBdb2\fR KDB plug-in is the default behavior and -that this section does not need to be filled out in that case. -.sp -.ne 2 -.na -\fB\fBdb_library\fR\fR -.ad -.sp .6 -.RS 4n -Name of the plug-in library. To use the LDAP KDB plug-in the name must be -\fBkdb_ldap\fR. The default value is \fBdb2\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdb_module_dir\fR\fR -.ad -.sp .6 -.RS 4n -Path to the plug-in libraries. The default is \fB/usr/lib/krb5\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBldap_cert_path\fR\fR -.ad -.sp .6 -.RS 4n -Path to the Network Security Services (NSS) trusted database for an SSL -connection. This is a required parameter when using the LDAP KDB plug-in. -.RE - -.sp -.ne 2 -.na -\fB\fBldap_conns_per_server\fR\fR -.ad -.sp .6 -.RS 4n -Number of connections per LDAP instance. The default is \fB5\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBldap_kadmind_dn\fR\fR -.ad -.sp .6 -.RS 4n -Bind DN for \fBkadmind\fR. This specifies the DN that the \fBkadmind\fR service -uses when binding to the LDAP Directory Server. The password for this bind DN -should be in the \fBldap_service_password_file\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBldap_kdc_dn\fR\fR -.ad -.sp .6 -.RS 4n -Bind DN for a Key Distribution Center (KDC). This specifies the DN that the -\fBkrb5kdc\fR service use when binding to the LDAP Directory Server. The -password for this bind DN should be in the \fBldap_service_password_file\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBldap_servers\fR\fR -.ad -.sp .6 -.RS 4n -List of LDAP directory servers in URI format. Use of either of the following is -acceptable. -.sp -.in +2 -.nf -ldap://\fI<ds hostname>\fR:\fI<SSL port>\fR -ldap://\fI<ds hostname>\fR -.fi -.in -2 -.sp - -Each server URI should be separated by whitespace. -.RE - -.sp -.ne 2 -.na -\fB\fBldap_service_password_file\fR\fR -.ad -.sp .6 -.RS 4n -File containing stashed passwords used by the KDC when binding to the LDAP -Directory Server. The default is \fB/var/krb5/service_passwd\fR. This file is -created using \fBkdb5_ldap_util\fR(1M). -.RE - -.sp -.ne 2 -.na -\fB\fBldap_ssl_port\fR\fR -.ad -.sp .6 -.RS 4n -Port number for SSL connection with directory server. The default is \fB389\fR. -.RE - -.SH EXAMPLES -\fBExample 1 \fRSample File -.sp -.LP -The following is an example of a generic \fBkrb5.conf\fR file: - -.sp -.in +2 -.nf -[libdefaults] - default_realm = ATHENA.MIT.EDU - default_tkt_enctypes = des-cbc-crc - default_tgs_enctypes = des-cbc-crc - -[realms] - ATHENA.MIT.EDU = { - kdc = kerberos.mit.edu - kdc = kerberos-1.mit.edu - kdc = kerberos-2.mit.edu - admin_server = kerberos.mit.edu - auth_to_local_realm = KRBDEV.ATHENA.MIT.EDU - } - - EXAMPLE.ORG = { - kdc = kerberos.example.org - kdc = kerberos-1.example.org - admin_server = kerberos.example.org - } - -[domain_realm] - .mit.edu = ATHENA.MIT.EDU - mit.edu = ATHENA.MIT.EDU -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRKDC Using the LDAP KDB plug-in, \fBrealms\fR and -\fBdbmodules\fR Sections -.sp -.LP -The following is an example of the \fBrealms\fR and \fBdbmodules\fR sections of -a Kerberos configuration file when the KDC is using the LDAP KDB plug-in. - -.sp -.in +2 -.nf -[realms] - EXAMPLE.COM = { - kdc = kc-umpk-01.athena.mit.edu - kdc = kc-umpk-02.athena.mit.edu - admin_server = kc-umpk-01.athena.mit.edu - database_module = LDAP - } - -[dbmodules] - LDAP = { - db_library = kdb_ldap - ldap_kerberos_container_dn = "cn=krbcontainer,dc=mit,dc=edu" - ldap_kdc_dn = "cn=kdc service,ou=profile,dc=mit,dc=edu" - ldap_kadmind_dn = "cn=kadmin service,ou=profile,dc=mit,dc=edu" - ldap_cert_path = /var/ldap - ldap_servers = ldaps://ds.mit.edu - } -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/var/krb5/kdc.log\fR\fR -.ad -.sp .6 -.RS 4n -\fBKDC\fR logging file -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability See below. -.TE - -.sp -.LP -All of the keywords are Committed, except for the \fBPKINIT\fR keywords, which -are Volatile. -.SH SEE ALSO -\fBkinit\fR(1), \fBrcp\fR(1), \fBrdist\fR(1), \fBrlogin\fR(1), \fBrsh\fR(1), -\fBtelnet\fR(1), \fBsyslog\fR(3C), \fBattributes\fR(5), \fBkerberos\fR(5), -\fBregex\fR(5) -.SH NOTES -If the \fBkrb5.conf\fR file is not formatted properly, the \fBtelnet\fR command -fails. However, the \fBdtlogin\fR and \fBlogin\fR commands still succeed, even -if the \fBkrb5.conf\fR file is specified as required for the commands. If this -occurs, the following error message is displayed: -.sp -.in +2 -.nf -Error initializing krb5: Improper format of \fIitem\fR -.fi -.in -2 -.sp - -.sp -.LP -To bypass any other problems that might occur, you should fix the file as soon -as possible. -.sp -.LP -The \fBmax_life\fR and \fBmax_renewable_life\fR options are obsolete and is -removed in a future release of the Solaris operating system. diff --git a/usr/src/man/man4/ldapfilter.conf.4 b/usr/src/man/man4/ldapfilter.conf.4 deleted file mode 100644 index 43d6f09088..0000000000 --- a/usr/src/man/man4/ldapfilter.conf.4 +++ /dev/null @@ -1,182 +0,0 @@ -'\" te -.\" Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved. -.\" Portions Copyright (C) 1997, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 LDAPFILTER.CONF 4 "Jul 9, 2003" -.SH NAME -ldapfilter.conf \- configuration file for LDAP filtering routines -.SH SYNOPSIS -.LP -.nf -\fB/etc/opt/SUNWconn/ldap/current/ldapfilter.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBldapfilter.conf\fR file contains information used by the LDAP filtering -routines. -.sp -.LP -Blank lines and lines that begin with a hash character (\fB#\fR) are treated as -comments and ignored. The configuration information consists of lines that -contain one to five tokens. Tokens are separated by white space, and double -quotes can be used to include white space inside a token. -.sp -.LP -The file consists of a sequence of one or more filter sets. A filter set begins -with a line containing a single token called a \fItag\fR. -.sp -.LP -The filter set consists of a sequence of one or more filter lists. The first -line in a filter list must contain four or five tokens: the \fIvalue -pattern\fR, the \fIdelimiter list\fR, a \fIfiltertemplate\fR, a \fImatch -description\fR, and an optional \fIsearch scope\fR. The \fIvalue pattern\fR is -a regular expression that is matched against the value passed to the LDAP -library call to select the filter list. -.sp -.LP -The \fIdelimiter list\fR is a list of the characters (in the form of a single -string) that can be used to break the \fBvalue\fR into distinct words. -.sp -.LP -The \fIfilter template\fR is used to construct an LDAP filter (see description -below) -.sp -.LP -The \fImatch description\fR is returned to the caller along with a filter as a -piece of text that can be used to describe the sort of LDAP search that took -place. It should correctly compete both of the following phrases: "One \fImatch -description\fR match was found for ..." and "Three \fImatch description\fR -matches were found for...." -.sp -.LP -The \fIsearch scope\fR is optional, and should be one of \fBbase\fR, -\fBonelevel\fR, or \fBsubtree\fR. If \fIsearch scope\fR is not provided, the -default is \fBsubtree\fR. -.sp -.LP -The remaining lines of the filter list should contain two or three tokens, a -\fIfilter template,\fR a \fImatch description\fR and an optional \fIsearch -scope\fR. -.sp -.LP -The \fIfilter template\fR is similar in concept to a \fBprintf\fR(3C) style -format string. Everything is taken literally except for the character -sequences: -.sp -.ne 2 -.na -\fB\fB%v\fR \fR -.ad -.RS 9n -Substitute the entire \fBvalue\fR string in place of the \fB%v\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB%v$\fR \fR -.ad -.RS 9n -Substitute the last word in this field. -.RE - -.sp -.ne 2 -.na -\fB\fB%v\fR\fIN\fR\fR -.ad -.RS 9n -Substitute word \fIN\fR in this field (where \fIN\fR is a single digit -\fB1\fR-\fB9\fR). Words are numbered from left to right within the value -starting at \fB1\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB%v\fR\fIM-N\fR\fR -.ad -.RS 9n -Substitute the indicated sequence of words where \fIM\fR and \fIN\fR are both -single digits \fB1\fR-\fB9\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB%v\fR\fIN-\fR\fR -.ad -.RS 9n -Substitute word \fIN\fR through the last word in \fBvalue\fR where \fIN\fR is -again a single digit \fB1\fR-\fB9\fR. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRAn LDAP Filter Configuration File -.sp -.LP -The following LDAP filter configuration file contains two filter sets, -\fBexample1\fR and \fBexample2 onelevel\fR, each of which contains four filter -lists. - -.sp -.in +2 -.nf -# ldap filter file -# -example1 -"=" " " "%v" "arbitrary filter" -"[0-9][0-9-]*" " " "(telephoneNumber=*%v)" "phone number" - -"@" " " "(mail=%v)" "email address" - -"^.[. _].*" ". _" "(cn=%v1* %v2-)" "first initial" - -".*[. _].$" ". _" "(cn=%v1-*)" "last initial" - -"[. _]" ". _" "(|(sn=%v1-)(cn=%v1-))" "exact" - "(|(sn~=%v1-)(cn~=%v1-))" "approximate" - -".*" ". " "(|(cn=%v1)(sn=%v1)(uid=%v1))" "exact" - "(|(cn~=%v1)(sn~=%v1))" "approximate" - -"example2 onelevel" -"^..$" " " "(|(o=%v)(c=%v)(l=%v)(co=%v))" "exact" "onelevel" - "(|(o~=%v)(c~=%v)(l~=%v)(co~=%v))" "approximate" -"onelevel" - -" " " " "(|(o=%v)(l=%v)(co=%v)" "exact" "onelevel" - "(|(o~=%v)(l~=%v)(co~=%v)" "approximate" "onelevel" - -"." " " "(associatedDomain=%v)" "exact" "onelevel" - -".*" " " "(|(o=%v)(l=%v)(co=%v)" "exact" "onelevel" - "(|(o~=%v)(l~=%v)(co~=%v)" "approximate" "onelevel" -.fi -.in -2 -.sp - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -l | l -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Stability Level Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBldap_getfilter\fR(3LDAP), \fBldap_ufn\fR(3LDAP), \fBattributes\fR(5) diff --git a/usr/src/man/man4/ldapsearchprefs.conf.4 b/usr/src/man/man4/ldapsearchprefs.conf.4 deleted file mode 100644 index 661f938f28..0000000000 --- a/usr/src/man/man4/ldapsearchprefs.conf.4 +++ /dev/null @@ -1,279 +0,0 @@ -'\" te -.\" Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved. -.\" Portions Copyright (C) 1997, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 LDAPSEARCHPREFS.CONF 4 "Nov 26, 2017" -.SH NAME -ldapsearchprefs.conf \- configuration file for LDAP search preference routines -.SH SYNOPSIS -.LP -.nf -\fB/etc/opt/SUNWconn/ldap/current/ldapsearchprefs.conf\fR -.fi - -.SH DESCRIPTION -.LP -The \fBldapsearchprefs.conf\fR file contains information used by LDAP when -searching the directory. Blank lines and lines that start with a hash ('#') -character are treated as comments and ignored. Non-comment lines contain one or -more tokens. Tokens are separated by white space, and double quotes can be used -to include white space inside a token. -.sp -.LP -Search preferences are typically used by LDAP-based client programs to specify -what a user may search for, which attributes are searched, and which options -are available to the user. -.sp -.LP -The first non-comment line specifies the version of the template information -and must contain the token \fBVersion\fR followed by an integer version number. -For example: -.sp -.in +2 -.nf -Version 1 -.fi -.in -2 -.sp - -.sp -.LP -The current version is \fI1,\fR so the above example is always the correct -opening line. -.sp -.LP -The remainder of the file consists of one or more search preference -configurations. The first line of a search preference is a human-readable name -for the type of object being searched for, for example \fBPeople\fR or -\fBOrganizations\fR. This name is stored in the \fIso_objtypeprompt\fR member -of the \fBldap_searchobj\fR structure (see \fBldap_searchprefs\fR(3LDAP)). For -example: -.sp -.in +2 -.nf -People -.fi -.in -2 -.sp - -.sp -.LP -specifies a label for a search preference designed to find X.500 entries for -people. -.sp -.LP -The next line specifies a list of options for this search object. The only -option currently allowed is "internal" which means that this search object -should not be presented directly to a user. Options are placed in the -\fIso_options\fR member of the \fIldap_searchobj\fR structure and can be tested -using the \fBLDAP_IS_SEARCHOBJ_OPTION_SET()\fR macro. Use "" if no special -options are required. -.sp -.LP -The next line specifies a label to use for "Fewer Choices" searches. "Fewer -Choices" searches are those where the user's input is fed to the ldap_filter -routines to determine an appropriate filter to use. This contrasts with -explicitly-constructed LDAP filters, or "More Choices" searches, where the user -can explicitly construct an LDAP filter. -.sp -.LP -For example: -.sp -.in +2 -.nf -"Search For:" -.fi -.in -2 -.sp - -.sp -.LP -can be used by LDAP client programs to label the field into which the user can -type a "Fewer Choices" search. -.sp -.LP -The next line specifies an LDAP filter prefix to append to all "More Choices" -searched. This is typically used to limit the types of entries returned to -those containing a specific object class. For example: -.sp -.in +2 -.nf -"(&(objectClass=person)" -.fi -.in -2 -.sp - -.sp -.LP -would cause only entries containing the object class \fIperson\fR to be -returned by a search. Note that parentheses may be unbalanced here, since this -is a filter prefix, not an entire filter. -.sp -.LP -The next line is an LDAP filter tag which specifies the set of LDAP filters to -be applied for "Fewer Choices" searching. The line -.sp -.in +2 -.nf -\fB"x500-People"\fR -.fi -.in -2 -.sp - -.sp -.LP -would tell the client program to use the set of LDAP filters from the ldap -filter configuration file tagged "x500-People". -.sp -.LP -The next line specifies an LDAP attribute to retrieve to help the user choose -when several entries match the search terms specified. For example: -.sp -.in +2 -.nf -"title" -.fi -.in -2 -.sp - -.sp -.LP -specifies that if more than one entry matches the search criteria, the client -program should retrieve the \fBtitle\fR attribute that and present that to the -user to allow them to select the appropriate entry. The next line specifies a -label for the above attribute, for example, -.sp -.in +2 -.nf -"Title:" -.fi -.in -2 -.sp - -.sp -.LP -Note that the values defined so far in the file are defaults, and are intended -to be overridden by the specific search options that follow. -.sp -.LP -The next line specifies the scope of the LDAP search to be performed. -Acceptable values are subtree, onelevel, and base. -.sp -.LP -The next section is a list of "More Choices" search options, terminated by a -line containing only the string \fBEND\fR. For example: -.sp -.in +2 -.nf -"Common Name" cn 11111 "" "" -"Surname" sn 11111 "" "" -"Business Phone" "telephoneNumber" 11101 "" "" -END -.fi -.in -2 -.sp - -.sp -.LP - Each line represents one method of searching. In this example, there are three -ways of searching - by Common Name, by Surname, and by Business Phone number. -The first field is the text which should be displayed to user. The second field -is the attribute which will be searched. The third field is a bitmap which -specifies which of the match types are permitted for this search type. A "1" -value in a given bit position indicates that a particular match type is valid, -and a "0" indicates that is it not valid. The fourth and fifth fields are, -respectively, the select attribute name and on-screen name for the selected -attribute. These values are intended to override the defaults defined above. If -no specific values are specified, the client software uses the default values -above. -.sp -.LP -The next section is a list of search match options, terminated by a a line -containing only the string \fBEND\fR. Example: -.sp -.in +2 -.nf -"exactly matches" "(%a=%v))" -"approximately matches" "(%a~=%v))" -"starts with" "(%a=%v*))" -"ends with" "(%a=*%v))" -"contains" "(%a=*%v*))" -END -.fi -.in -2 -.sp - -.sp -.LP -In this example, there are five ways of refining the search. For each method, -there is an LDAP filter suffix which is appended to the ldap filter. -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample Configuration Using Search Preference for "people" -.sp -.LP -The following example illustrates one possible configuration of search -preferences for "people". - -.sp -.in +2 -.nf -# Version number -Version 1 -# Name for this search object -People -# Label to place before text box user types in -"Search For:" -# Filter prefix to append to all "More Choices" searches -"(&(objectClass=person)" -# Tag to use for "Fewer Choices" searches - from ldapfilter.conf file -"x500-People" -# If a search results in > 1 match, retrieve this attribute to help -# user distinguish between the entries... -multilineDescription -# ...and label it with this string: -"Description" -# Search scope to use when searching -subtree -# Follows a list of "More Choices" search options. Format is: -# Label, attribute, select-bitmap, extra attr display name, extra attr ldap name -# If last two are null, "Fewer Choices" name/attributes used -"Common Name" cn 11111 "" "" -"Surname" sn 11111 "" "" -"Business Phone" "telephoneNumber" 11101 "" "" -"E-Mail Address" "mail" 11111 "" "" -"Uniqname" "uid" 11111 "" "" -END -# Match types -"exactly matches" "(%a=%v))" -"approximately matches" "(%a~=%v))" -"starts with" "(%a=%v*))" -"ends with" "(%a=*%v))" -"contains" "(%a=*%v*))" -END -.fi -.in -2 - -.sp -.LP -In this example, the user may search for People. For "fewer choices" searching, -the tag for the \fBldapfilter.conf\fR(4) file is "x500-People". -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Stability Level Evolving -.TE - -.SH SEE ALSO -.LP -\fBldap_searchprefs\fR(3LDAP), \fBattributes\fR(5) diff --git a/usr/src/man/man4/ldaptemplates.conf.4 b/usr/src/man/man4/ldaptemplates.conf.4 deleted file mode 100644 index 7d62bcbbbe..0000000000 --- a/usr/src/man/man4/ldaptemplates.conf.4 +++ /dev/null @@ -1,431 +0,0 @@ -'\" te -.\" Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved. -.\" Portions Copyright (C) 1997, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 LDAPTEMPLATES.CONF 4 "Jul 9, 2003" -.SH NAME -ldaptemplates.conf \- configuration file for LDAP display template routines -.SH SYNOPSIS -.LP -.nf -\fB/etc/opt/SUNWconn/ldap/current/ldaptemplates.conf\fR -.fi - -.SH DESCRIPTION -.LP -The \fBldaptemplates.conf\fR file contains information used by the LDAP display -routines. -.sp -.LP -Blank lines and lines that start with a hash character ('#') are treated as -comments and ignored. Non-comment lines contain one or more tokens. Tokens are -separated by white space, and double quotes can be used to include white space -inside a token. -.sp -.LP -The first non-comment line specifies the version of the template information -and must contain the token \fBVersion\fR followed by an integer version number. -For example, -.sp -.in +2 -.nf -Version 1 -.fi -.in -2 -.sp - -.sp -.LP -The current version is \fI1\fR, so the above example is always the correct -first line. -.sp -.LP -The remainder of the file consists of one or more display templates. The first -two lines of the display template each contain a single token that specifies -singular and plural names for the template in a user-friendly format. For -example, -.sp -.in +2 -.nf -"Person" -"People" -.fi -.in -2 -.sp - -.sp -.LP -specifies appropriate names for a template designed to display person -information. -.sp -.LP -The next line specifies the name of the icon or similar element that is -associated with this template. For example, -.sp -.in +2 -.nf -"person icon" -.fi -.in -2 -.sp - -.sp -.LP -The next line is a blank-separated list of template options. "" can be used if -no options are desired. Available options are: \fBaddable\fR (it is appropriate -to allow entries of this type to be added), \fBmodrdn\fR (it is appropriate to -offer the \fBmodify rdn\fR operation), \fBaltview\fR (this template is an -alternate view of another template). For example, -.sp -.in +2 -.nf -"addable" "modrdn" -.fi -.in -2 -.sp - -.sp -.LP -The next portion of the template is a list of X.500 object classes that is used -to determine whether the template should be used to display a given entry. The -object class information consists of one or more lines, followed by a -terminating line that contains the single token \fBEND\fR. Each line contains -one or more object class names, all of which must be present in a directory -entry. Multiple lines can be used to associate more than one set of object -classes with a given template. For example, -.sp -.in +2 -.nf -emailPerson -orgPerson -END -.fi -.in -2 -.sp - -.sp -.LP -means that the template is appropriate for display of \fBemailPerson\fR entries -or \fBorgPerson\fR entries. -.sp -.LP -The next line after the object class list is the name of the attribute to -authenticate as to make changes (use "" if it is appropriate to authenticate as -the entry itself). For example, -.sp -.in +2 -.nf -"owner" -.fi -.in -2 -.sp - -.sp -.LP -The next line is the default attribute to use when naming a new entry, for -example, -.sp -.in +2 -.nf -"cn" -.fi -.in -2 -.sp - -.sp -.LP -The next line is the distinguished name of the default location under which new -entries are created. For example, -.sp -.in +2 -.nf -"o=XYZ, c=US" -.fi -.in -2 -.sp - -.sp -.LP -The next section is a list of rules used to assign default values to new -entries. The list should be terminated with a line that contains the single -token \fBEND\fR. Each line in this section should either begin with the token -\fBconstant\fR and be followed by the name of the attribute and a constant -value to assign, or the line should begin with \fBaddersdn\fR followed by the -name of an attribute whose value will be the DN of the person who has -authenticated to add the entry. For example, -.sp -.in +2 -.nf -constant associatedDomain XYZ.us -addersdn seeAlso -END -.fi -.in -2 -.sp - -.sp -.LP -The last portion of the template is a list of items to display. It consists of -one or more lines, followed by a terminating line that contains the single -token \fBEND\fR. Each line is must begin with the token \fBsamerow\fR or the -token \fBitem\fR -.sp -.LP -It is assumed that each item appears on a row by itself unless it was preceded -by a \fBsamerow\fR line (in which case it should be displayed on the same line -as the previous item, if possible). Lines that begin with \fBsamerow\fR should -not have any other tokens on them. -.sp -.LP -Lines that begin with \fBitem\fR must have at least three more tokens on them: -an item type, a label, and an attribute name. Any extra tokens are taken as -extra arguments. -.sp -.LP -The item type token must be one of the following strings: -.sp -.ne 2 -.na -\fB\fBcis\fR \fR -.ad -.RS 14n -case-ignore string attributes -.RE - -.sp -.ne 2 -.na -\fB\fBmls\fR \fR -.ad -.RS 14n -multiline string attributes -.RE - -.sp -.ne 2 -.na -\fB\fBmail\fR \fR -.ad -.RS 14n -RFC-822 conformant mail address attributes -.RE - -.sp -.ne 2 -.na -\fB\fBdn\fR \fR -.ad -.RS 14n -distinguished name pointer attributes -.RE - -.sp -.ne 2 -.na -\fB\fBbool\fR \fR -.ad -.RS 14n -Boolean attributes -.RE - -.sp -.ne 2 -.na -\fB\fBjpeg\fR \fR -.ad -.RS 14n -JPEG photo attributes -.RE - -.sp -.ne 2 -.na -\fB\fBjpegbtn\fR \fR -.ad -.RS 14n -a button that will retrieve and show a JPEG photo attribute -.RE - -.sp -.ne 2 -.na -\fB\fBfax\fR \fR -.ad -.RS 14n -FAX T.4 format image attributes -.RE - -.sp -.ne 2 -.na -\fB\fBfaxbtn\fR \fR -.ad -.RS 14n -a button that will retrieve and show a FAX photo attribute -.RE - -.sp -.ne 2 -.na -\fB\fBaudiobtn\fR \fR -.ad -.RS 14n -audio attributes -.RE - -.sp -.ne 2 -.na -\fB\fBtime\fR \fR -.ad -.RS 14n -UTC time attributes -.RE - -.sp -.ne 2 -.na -\fB\fBdate\fR \fR -.ad -.RS 14n -UTC time attributes where only the date portion should be shown -.RE - -.sp -.ne 2 -.na -\fB\fBurl\fR \fR -.ad -.RS 14n -labeled Uniform Resource Locator attributes -.RE - -.sp -.ne 2 -.na -\fB\fBsearchact\fR \fR -.ad -.RS 14n -define an action that will do a directory search for other entries -.RE - -.sp -.ne 2 -.na -\fB\fBlinkact\fR \fR -.ad -.RS 14n -define an action which is a link to another display template -.RE - -.sp -.ne 2 -.na -\fB\fBprotected\fR \fR -.ad -.RS 14n -for an encrypted attribute, with values displayed as asterisks -.RE - -.sp -.LP -An example of an item line for the drink attribute (displayed with label "Work -Phone"): -.sp -.in +2 -.nf -item cis "Work Phone" telephoneNumber -.fi -.in -2 -.sp - -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample Configuration File Containing a Template that Displays -People Entries -.sp -.LP -The following template configuration file contains a templates for display of -people entries. - -.sp -.in +2 -.nf - # - # LDAP display templates - # - # Version must be 1 for now - # - Version 1 - # - # Person template - "Person" - "People" - - # name of the icon that is associated with this template - "person icon" - - # blank-separated list of template options ("" for none) - "addable" - - # - # objectclass list - person - END - - # - # name of attribute to authenticate as ("" means auth as this entry) - "" - - # - # default attribute name to use when forming RDN of a new entry - # - "cn" - - # - # default location when adding new entries (DN; "" means no default) - "o=XYZ, c=US" - - # - # rules used to define default values for new entries - END - - # - # list of items for display - item jpegbtn "View Photo" jpegPhoto "Next Photo" - item audiobtn "Play Sound" audio - item cis "Also Known As" cn - item cis "Title" title - item mls "Work Address" postalAddress - item cis "Work Phone" telephoneNumber - item cis "Fax Number" facsimileTelephoneNumber - item mls "Home Address" homePostalAddress - item cis "Home Phone" homePhone - item cis "User ID" uid - item mail "E-Mail Address" mail - item cis "Description" description - item dn "See Also" seeAlso - END -.fi -.in -2 -.sp - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Stability Level Evolving -.TE - -.SH SEE ALSO -.LP -\fBldap_disptmpl\fR(3LDAP), \fBldap_entry2text\fR(3LDAP), \fBattributes\fR(5) diff --git a/usr/src/man/man4/loader.conf.4 b/usr/src/man/man4/loader.conf.4 deleted file mode 100644 index 52dfb4eb8d..0000000000 --- a/usr/src/man/man4/loader.conf.4 +++ /dev/null @@ -1,249 +0,0 @@ -.\" Copyright (c) 1999 Daniel C. Sobral -.\" All rights reserved. -.\" -.\" 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 AUTHOR 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 AUTHOR 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 Nov 26, 2017 -.Dt LOADER.CONF 4 -.Os -.Sh NAME -.Nm loader.conf -.Nd "system bootstrap configuration information" -.Sh SYNOPSIS -.Nm /boot/loader.conf -.Sh DESCRIPTION -The file -.Nm -contains descriptive information on bootstrapping the system. -Through -it you can specify the kernel to be booted, parameters to be passed to -it, and additional modules to be loaded; and generally set all variables -described in -.Xr loader 5 . -.Pp -Loader implements set of builtin commands and functions and script -interpreter as standalone binary program. -When starting, the loader will read the file -.Pa /boot/loader.rc -as initialization and startup script, to include other support files -and to read the configuration, describing current boot environment. -All loader scripts and configuration files are located in the -.Pa /boot -directory tree. -.Pp -The file -.Pa /boot/loader.rc -must contain the following two lines for -.Nm -to be automatically processed: -.Pp -.Dl include /boot/forth/loader.4th -.Dl start -.Pp -The default -.Pa /boot/loader.rc -is provided by the operating system and may be replaced on operating -system update. -The local updates are advised to be added into the -.Pa /boot/loader.rc.local -.Pp -The configuration variables are read from the following files: -.Bl -tag -width Ar -.It Ar /boot/solaris/bootenv.rc -Managed by the -.Xr eeprom 1M -command. -.It Ar /boot/defaults/loader.conf -Loader defaults provided by the operating system. -.It Ar /boot/loader.conf -System specific loader configuration. -May be provided by the operating system. -.It Ar /boot/loader.conf.local -User editable loader configuration. -.It Ar /boot/conf.d/* -User editable loader configuration snippets. -The files are processed in lexicographical order. -The configuration snippets mechanism is not available in case of TFTP boot as -TFTP does not provide the directory list. -.It Ar /boot/transient.conf -Configuration file for transient boot. -This file is created by the -.Xr reboot 1M -command and is automatically removed when system is reaching the multi-user -run level. -.El -.Pp -The configuration is processed in the order listed above. -.Ss SYNTAX -The general parsing rules are: -.Bl -bullet -.It -Spaces and empty lines are ignored. -.It -A # sign will mark the remainder of the line as a comment. -.It -Only one setting can be present on each line. -.El -.Pp -All settings have the following format: -.Pp -.Dl variable="value" -.Pp -Unless it belongs to one of the classes of settings that receive special -treatment, a setting will set the value of a -.Xr loader 5 -environment variable. -The settings that receive special -treatment are listed below. -Settings beginning with -.Qq * -below define the modules to be loaded and -may have any prefix; the prefix identifies a module. -All such settings sharing a common -prefix refer to the same module. -.Bl -tag -width Ar -.It Ar exec -Immediately executes a -.Xr loader 5 -command. -This type of setting cannot be processed by programs other -than -.Xr loader 5 , -so its use should be avoided. -Multiple instances of it will be processed -independently. -.It Ar loader_conf_files -Defines additional configuration files to be processed right after the -present file. -.It Ar kernel -Name of the kernel to be loaded. -If no kernel name is set, no additional -modules will be loaded. -.It Ar boot-args -Flags to be passed to the kernel. -.It Ar password -Protect boot menu with a password without interrupting -.Ic autoboot -process. -The password should be in clear text format. -If a password is set, boot menu will not appear until any key is pressed during -countdown period specified by -.Va autoboot_delay -variable or -.Ic autoboot -process fails. -In both cases user should provide specified password to be able to access boot -menu. -.It Ar bootlock_password -Provides a password to be required by check-password before execution is -allowed to continue. -The password should be in clear text format. -If a password is set, the user must provide specified password to boot. -.It Ar verbose_loading -If set to -.Dq YES , -module names will be displayed as they are loaded. -.It Ar *_load -If set to -.Dq YES , -that module will be loaded. -If no name is defined (see below), the -module's name is taken to be the same as the prefix. -.It Ar *_name -Defines the name of the module. -.It Ar *_type -Defines the module's type. -If none is given, it defaults to a kld module. -.It Ar *_flags -Flags and parameters to be passed to the module. -.It Ar *_before -Commands to be executed before the module is loaded. -Use of this setting -should be avoided. -.It Ar *_after -Commands to be executed after the module is loaded. -Use of this setting -should be avoided. -.It Ar *_error -Commands to be executed if the loading of a module fails. -Except for the -special value -.Dq abort , -which aborts the bootstrap process, use of this setting should be avoided. -.El -.Ss DEFAULT SETTINGS -Most of -.Nm Ns 's -default settings can be ignored. -The few of them which are important -or useful are: -.Bl -tag -width bootfile -offset indent -.It Va console -.Pq Dq text -.Dq ttya -- -.Dq ttyd -selects serial console, -.Dq text -selects the video console, -.Dq nullconsole -selects a mute console -(useful for systems with neither a video console nor a serial port), and -.Dq spinconsole -selects the video console which prevents any input and hides all output -replacing it with -.Dq spinning -character (useful for embedded products and such). -.It Va kernel -.Pq Dq i86pc/kernel/${ISADIR} -.Ar /platform -sub-directory containing kernel -.It Va loader_conf_files -.Pq Dq Pa /boot/loader.conf /boot/loader.conf.local -.It Va beastie_disable -If set to -.Dq YES , -the beastie boot menu will be skipped. -The beastie boot menu is always skipped if running non-x86 hardware. -.It Va loader_logo Pq Dq Li illumos -Selects a desired logo in the beastie boot menu. -Possible values depend on distribution; -.Dq Li none -will disable the logo. -.It Va loader_color -If set to -.Dq NO , -the beastie boot menu will be displayed without ANSI coloring. -.El -.Sh SEE ALSO -.Xr boot 1M , -.Xr eeprom 1M , -.Xr loader 5 , -.Xr loader.4th 5 -.Sh NOTES -The -.Xr loader 5 -stops reading -.Nm -when it encounters a syntax error, so any options which are vital for -booting a particular system should precede any experimental additions to -.Nm . diff --git a/usr/src/man/man4/logadm.conf.4 b/usr/src/man/man4/logadm.conf.4 deleted file mode 100644 index cb10ede60a..0000000000 --- a/usr/src/man/man4/logadm.conf.4 +++ /dev/null @@ -1,70 +0,0 @@ -'\" te -.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 LOGADM.CONF 4 "May 23, 2007" -.SH NAME -logadm.conf \- configuration file for logadm command -.SH SYNOPSIS -.LP -.nf -\fB/etc/logadm.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -\fB/etc/logadm.conf\fR is the default configuration file for the log management -tool \fBlogadm\fR(1M). Comments are allowed using the pound character (\fB#\fR) -and extend to the end of line. Each non-comment line has the form: -.sp -.in +2 -.nf -\fIlogname\fR \fIoptions\fR -.fi -.in -2 - -.sp -.LP -where \fIlogname\fR is the name of the entry and \fIoptions\fR are the default -command line options for the \fBlogadm\fR command. The name of the entry may be -the same as the name of the log file, or a log file name may be given in the -options section of the entry. Long lines may be folded using a backslash -followed by a newline to continue an entry on the next line. Single or double -quotes may be used to protect spaces or alternate-style quotes in strings. -.sp -.LP -The preferred method for changing \fB/etc/logadm.conf\fR is to use the -\fB-V\fR, \fB-w\fR, and \fB-r\fR options to the \fBlogadm\fR(1M) command, which -allow you to lookup an entry, write an entry, or remove an entry from -\fB/etc/logadm.conf\fR. -.sp -.LP -A full description of how and when \fB/etc/logadm.conf\fR is used and sample -entries are found in \fBlogadm\fR(1M). -.sp -.LP -By default, \fBlogadm\fR(1M) works in \fBGMT\fR. Therefore, all entries in -\fB/etc/logadm.conf\fR will have a \fBGMT\fR timestamp. Users can use the -\fB-l\fR option to set \fBlogadm\fR to local time. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBlogadm\fR(1M), \fBattributes\fR(5) diff --git a/usr/src/man/man4/logindevperm.4 b/usr/src/man/man4/logindevperm.4 deleted file mode 100644 index 6fad0f269f..0000000000 --- a/usr/src/man/man4/logindevperm.4 +++ /dev/null @@ -1,137 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. -.\" 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 LOGINDEVPERM 4 "Sep 25, 2008" -.SH NAME -logindevperm, fbtab \- login-based device permissions -.SH SYNOPSIS -.LP -.nf -\fB/etc/logindevperm\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/etc/logindevperm\fR file contains information that is used by -\fBlogin\fR(1) and \fBttymon\fR(1M) to change the owner, group, and permissions -of devices upon logging into or out of a console device. By default, this file -contains lines for the keyboard, mouse, audio, and frame buffer devices. -.sp -.LP -The owner of the devices listed in \fB/etc/logindevperm\fR is set to the owner -of the console by \fBlogin\fR(1). The group of the devices is set to the -owner's group specified in \fB/etc/passwd\fR. The permissions are set as -specified in \fB/etc/logindevperm\fR. -.sp -.LP -If the console is \fB/dev/vt/active\fR, the owner of the devices is the first -user logged in on the consoles (\fB/dev/console\fR or \fB/dev/vt/#\fR). Upon -this first user's logout the owner and group of these devices is reset by -\fBttymon\fR(1M) to owner root and root's group as specified in -\fB/etc/passwd\fR. -.sp -.LP -Fields are separated by a TAB or SPACE characters. Blank lines and comments can -appear anywhere in the file; comments start with a hashmark, (\fB#\fR), and -continue to the end of the line. -.sp -.LP -The first field specifies the name of a console device (for example, -\fB/dev/console\fR). By default, it is \fB/dev/vt/active\fR, which points to -the current active console, including \fB/dev/console\fR and all virtual -consoles (\fB/dev/vt/#\fR). The second field specifies the permissions to which -the devices in the \fIdevice_list\fR field (third field) are set. These -permissions must be expressed in octal format, for example, \fB0774\fR. A -\fIdevice_list\fR is a colon-separated list of device names. A device name must -be a \fB/dev\fR link. -.sp -.LP -A directory or logical name in the device name can be either one of the -following: -.RS +4 -.TP -.ie t \(bu -.el o -A fully qualified name, for example, \fBfbs\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A regular expression, for example, \fB[a-z0-9.]+\fR. See \fBregexp\fR(5) for -more information on regular expressions. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The wildcard character \fB*\fR specifying all directory or node names (except -\fB\&.\fR and \fB\&..\fR, for example, \fB/dev/fbs/*\fR specifies all frame -buffer devices. -.RE -.sp -.LP -Some examples of \fB/etc/logindevperm\fR file entries include: -.sp -.in +2 -.nf -/dev/usb/[0-9a-f]+[.][0-9a-f]+/[0-9]+/[a-z0-9.]+ -/dev/usb/[0-9a-f]+[.][0-9a-f]+/[0-9]+/* -/dev/usb/[0-9a-f]+[.][0-9a-f]+/*/* -.fi -.in -2 - -.sp -.LP -Specify all \fBugen\fR(7D) endpoints and status nodes. -.sp -.LP -Drivers can also be specified to limit the permission changes to minor nodes -owned by the specified drivers. For example, -.sp -.in +2 -.nf -/dev/console 0600 /dev/usb/[0-9a-f]+[.][0-9a-f]+/[0-9]+/* \e -driver=usb_mid,scsa2usb,usbprn # libusb devices -.fi -.in -2 - -.sp -.LP -Due to the persistence of \fBdevfs\fR(7FS) minor node management, the user -should be logged in as root if the list of minor nodes will be reduced and the -devices should all be plugged in. -.sp -.LP -Once the devices are owned by the user, their permissions and ownership can be -changed using \fBchmod\fR(1) and \fBchown\fR(1), as with any other user-owned -file. -.sp -.LP -Upon logout the owner and group of these devices are reset by \fBttymon\fR(1M) -to owner \fBroot\fR and root's group as specified in \fB/etc/passwd\fR -(typically \fBother\fR). The permissions are set as specified in the -\fB/etc/logindevperm\fR file. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/passwd\fR\fR -.ad -.RS 15n -File that contains user group information. -.RE - -.SH SEE ALSO -.sp -.LP -\fBchmod\fR(1), \fBchown\fR(1), \fBlogin\fR(1), \fBttymon\fR(1M), -\fBpasswd\fR(4), \fBregexp\fR(5), \fBugen\fR(7D) -.SH NOTES -.sp -.LP -\fB/etc/logindevperm\fR provides a superset of the functionality provided by -\fB/etc/fbtab\fR in SunOS 4.\fIx\fR releases. diff --git a/usr/src/man/man4/loginlog.4 b/usr/src/man/man4/loginlog.4 deleted file mode 100644 index 6d226f0a7d..0000000000 --- a/usr/src/man/man4/loginlog.4 +++ /dev/null @@ -1,37 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" 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 LOGINLOG 4 "Jul 3, 1990" -.SH NAME -loginlog \- log of failed login attempts -.SH DESCRIPTION -.sp -.LP -After five unsuccessful login attempts, all the attempts are logged in the file -\fB/var/adm/loginlog\fR. This file contains one record for each failed attempt. -Each record contains the login name, tty specification, and time. -.sp -.LP -This is an \fBASCII\fR file. Each field within each entry is separated from the -next by a colon. Each entry is separated from the next by a new-line. -.sp -.LP -By default, \fBloginlog\fR does not exist, so no logging is done. To enable -logging, the log file must be created with read and write permission for owner -only. Owner must be \fBroot\fR and group must be \fBsys\fR. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/var/adm/loginlog\fR\fR -.ad -.RS 21n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBlogin\fR(1), \fBpasswd\fR(1) diff --git a/usr/src/man/man4/magic.4 b/usr/src/man/man4/magic.4 deleted file mode 100644 index a8770cdb02..0000000000 --- a/usr/src/man/man4/magic.4 +++ /dev/null @@ -1,357 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. -.\" 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 MAGIC 4 "Feb 6, 2004" -.SH NAME -magic \- file command's magic number file -.SH SYNOPSIS -.LP -.nf -\fB/etc/magic\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBfile\fR(1) command identifies the type of a file using, among other -tests, a test for whether the file begins with a certain \fImagic number\fR. -The \fB/etc/magic\fR file, or a file specified as an option-argument to the -\fB-m\fR or \fB-M\fR options of \fBfile\fR(1), specifies what magic numbers are -to be tested for, what message to print if a particular magic number is found, -and additional information to extract from the file. -.sp -.LP -Each line of the file specifies a position-sensitive test to perform. A test -compares the data starting at a particular offset in the file with a 1-byte, -2-byte, 4-byte, or 8-byte numeric value or string. If the test succeeds, a -message is printed. The line consists of the following fields (separated by -tabs): \fIoffset\fR \fItype\fR \fIvalue\fR \fImessage\fR -.sp -.ne 2 -.na -\fB\fIoffset\fR\fR -.ad -.RS 11n -A number specifying the offset, in bytes, into the file of the data which is to -be tested. -.RE - -.sp -.ne 2 -.na -\fB\fItype\fR\fR -.ad -.RS 11n -The type of the data to be tested. The possible values are: -.sp -.ne 2 -.na -\fB\fBbyte, d1, dC\fR\fR -.ad -.RS 24n -A one-byte signed value. -.RE - -.sp -.ne 2 -.na -\fB\fBshort, d2, dS\fR\fR -.ad -.RS 24n -A 2-byte signed value. -.RE - -.sp -.ne 2 -.na -\fB\fBlong, d4, dI, dL, d\fR\fR -.ad -.RS 24n -A 4-byte signed value. -.RE - -.sp -.ne 2 -.na -\fB\fBllong, d8\fR\fR -.ad -.RS 24n -An 8-byte signed value -.RE - -.sp -.ne 2 -.na -\fB\fBubyte, u1, uC\fR\fR -.ad -.RS 24n -A one-byte unsigned value. -.RE - -.sp -.ne 2 -.na -\fB\fBushort, u2, uS\fR\fR -.ad -.RS 24n -A 2-byte unsigned value. -.RE - -.sp -.ne 2 -.na -\fB\fBulong, u4, uI, uL, u\fR\fR -.ad -.RS 24n -A 4-byte unsigned value. -.RE - -.sp -.ne 2 -.na -\fB\fBullong, u8\fR\fR -.ad -.RS 24n -An 8-byte unsigned value. -.RE - -.sp -.ne 2 -.na -\fB\fBstring, s\fR\fR -.ad -.RS 24n -A string of bytes. -.RE - -All type specifiers, except for \fBstring\fR and \fBs\fR, may be followed by a -mask specifier of the form \fB&\fR\fInumber\fR. If a mask specifier is given, -the value is AND'ed with the \fInumber\fR before any comparisons are done. The -\fInumber\fR is specified in C form. For instance, \fB13\fR is decimal, -\fB013\fR is octal, and \fB0x13\fR is hexadecimal. -.RE - -.sp -.ne 2 -.na -\fB\fIvalue\fR\fR -.ad -.RS 11n -The value to be compared with the value from the file. If the type is numeric, -this value is specified in \fBC\fR form. If it is a string, it is specified as -a \fBC\fR string with the usual escapes permitted (for instance, \en for -NEWLINE). -.sp -\fINumeric values\fR may be preceded by a character indicating the operation to -be performed, as follows: -.sp -.ne 2 -.na -\fB\fB=\fR\fR -.ad -.RS 5n -The value from the file must equal the specified value. -.RE - -.sp -.ne 2 -.na -\fB\fB<\fR\fR -.ad -.RS 5n -The value from the file must be less than the specified value. -.RE - -.sp -.ne 2 -.na -\fB\fB>\fR\fR -.ad -.RS 5n -The value from the file must be greater than the specified value. -.RE - -.sp -.ne 2 -.na -\fB\fB&\fR\fR -.ad -.RS 5n -All the bits in the specified value must be set in the value from the file. -.RE - -.sp -.ne 2 -.na -\fB\fB^\fR\fR -.ad -.RS 5n -At least one of the bits in the specified value must not be set in the value -from the file. -.RE - -.sp -.ne 2 -.na -\fB\fBx\fR\fR -.ad -.RS 5n -Any value will match. -.RE - -If the character is omitted, it is assumed to be "\fB=\fR". -.sp -For comparison of numeric values, the sign and size of both the value in the -file and the value from the \fIvalue\fR field of the magic entry will match -that of the corresponding \fItype\fR field. If there is a non-zero mask -(\fB&\fR) in the \fItype\fR field, the comparison will be unsigned. -.sp -For string values, the byte string from the file must match the specified byte -string. The byte string from the file which is matched is the same length as -the specified byte string. If the value is a string, it can contain the -following sequences: -.sp -.ne 2 -.na -\fB\e\fIcharacter\fR\fR -.ad -.RS 15n -The backslash-escape sequences \fB\e\e\fR, \fB\ea\fR, \fB\eb\fR, \fB\ef\fR, -\fB\en\fR, \fB\er\fR, \fB\et\fR, \fB\ev\fR\&. -.RE - -.sp -.ne 2 -.na -\fB\e\fIoctal\fR\fR -.ad -.RS 15n -Octal sequences that can be used to represent characters with specific coded -values. An octal sequence consists of a backslash followed by the longest -sequence of one, two, or three octal-digit characters (01234567). -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fImessage\fR\fR -.ad -.RS 11n -The message to be printed if the comparison succeeds. If the string contains a -\fBprintf\fR(3C) format specification, the value from the file (with any -specified masking performed) is printed using the message as the format string. -.RE - -.sp -.LP -Some file formats contain additional information which is to be printed along -with the file type. A line which begins with the character "\fB>\fR" indicates -additional tests and messages to be printed. If the test on the line preceding -the first line with a "\fB>\fR" succeeds, the tests specified in all the -subsequent lines beginning with "\fB>\fR" are performed, and the messages are -printed if the tests succeed. The next line which does not begin with a -"\fB>\fR" terminates this. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/magic\fR\fR -.ad -.RS 14n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBfile\fR(1), \fBfile\fR(1B), \fBprintf\fR(3C) -.SH NOTES -.sp -.LP -In Solaris 9 and prior releases, the file utility may have performed unsigned -comparisons for types \fBbyte\fR, \fBshort\fR, and \fBlong\fR. Old user-defined -magic files, which were specified with the \fB-m\fR option, will need -modification of \fBbyte\fR, \fBshort\fR, and \fBlong\fR entries to their -corresponding unsigned types (\fBubyte\fR, \fBushort\fR, or \fBulong\fR) for -those entries for which all of the following are true: -.RS +4 -.TP -.ie t \(bu -.el o -The entry uses the "\fB<\fR" or the "\fB>\fR" operator. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBtype\fR field does not contain a non-zero mask. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The intention of the entry is to test unsigned values. -.RE -.sp -.LP -For example, if the following entry is expected to match any non-zero, one-byte -value from the file, including values for which the sign bit is on: -.sp -.in +2 -.nf -#offset type value message -0 byte >0 this matches any non-zero value -.fi -.in -2 -.sp - -.sp -.LP -then that entry should be changed to: -.sp -.in +2 -.nf -0 ubyte >0 this matches any non-zero value -.fi -.in -2 -.sp - -.sp -.LP -In Solaris 7 through Solaris 9, when applying tests for magic file entries -whose \fBtype\fR field is the numeric type "short" or "long", the file utility -in the x86 environment would switch the byte order of the numeric values read. -Starting in Solaris 10, the byte order will not be switched on x86. A test for -a numeric value whose byte order is identical in both little- and big-endian -architectures may require two magic file entries, to ensure that the test -correctly identifies files in both environments. For example, a magic file -entry that will match on a big-endian system may look like this: -.sp -.in +2 -.nf -0 long 0xf00000ff extended accounting file -.fi -.in -2 -.sp - -.sp -.LP -Its corresponding magic file entry that will match the same value on a -little-endian system would look like this: -.sp -.in +2 -.nf -0 long 0xff0000f0 extended accounting file -.fi -.in -2 -.sp - -.SH BUGS -.sp -.LP -There should be more than one level of subtests, with the level indicated by -the number of `\fB>\fR' at the beginning of the line. diff --git a/usr/src/man/man4/mailer.conf.4 b/usr/src/man/man4/mailer.conf.4 deleted file mode 100644 index a46f0160e4..0000000000 --- a/usr/src/man/man4/mailer.conf.4 +++ /dev/null @@ -1,107 +0,0 @@ -.\" $NetBSD: mailer.conf.5,v 1.2 1999/05/29 18:18:30 christos Exp $ -.\" -.\" Copyright (c) 1998 -.\" Perry E. Metzger. All rights reserved. -.\" -.\" 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. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgment: -.\" This product includes software developed for the NetBSD Project -.\" by Perry E. Metzger. -.\" 4. The name of the author may not be used to endorse or promote products -.\" derived from this software without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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. -.\" -.\" $FreeBSD: releng/9.1/share/man/man5/mailer.conf.5 213609 2010-10-08 20:13:12Z markm $ -.\" -.Dd November 11, 2017 -.Dt MAILER.CONF 4 -.Os -.Sh NAME -.Nm mailer.conf -.Nd configuration file for -.Xr mailwrapper 1M -.Sh DESCRIPTION -The file -.Pa /etc/mailer.conf -contains a series of lines of the form -.Pp -.Ar name -.Ar program -.Op Ar arguments ... -.Pp -The first word of each line is the -.Ar name -of a program invoking -.Xr mailwrapper 1M . -(For example, on a typical system -.Pa /usr/lib/sendmail -would be a symbolic link to -.Xr mailwrapper 1M , -as would -.Xr newaliases 1M -and -.Xr mailq 1 . -Thus, -.Ar name -might be -.Dq Li sendmail -or -.Dq Li newaliases -etc.) -.Pp -The second word of each line is the name of the -.Ar program -to actually execute when the first name is invoked. -.Pp -The further -.Ar arguments , -if any, are passed to the -.Ar program , -followed by the arguments -.Xr mailwrapper 1M -was called with. -.Pp -The file may also contain comment lines, denoted by a -.Ql # -mark in the first column of any line. -.Sh FILES -/etc/mailer.conf -.Sh EXAMPLES -This example shows how to set up -.Nm -to invoke the traditional -.Xr sendmail 1M -program: -.Bd -literal -offset indent -# Execute the "real" sendmail program located in -# /usr/lib/smtp/sendmail/sendmail -sendmail /usr/lib/smtp/sendmail/sendmail -mailq /usr/lib/smtp/sendmail/sendmail -newaliases /usr/lib/smtp/sendmail/sendmail -.Ed -.Sh SEE ALSO -.Xr mail 1 , -.Xr mailq 1 , -.Xr mailwrapper 1M , -.Xr newaliases 1M , -.Xr sendmail 1M -.Sh AUTHORS -.An Perry E. Metzger Aq perry@piermont.com diff --git a/usr/src/man/man4/mech.4 b/usr/src/man/man4/mech.4 deleted file mode 100644 index 2f32308765..0000000000 --- a/usr/src/man/man4/mech.4 +++ /dev/null @@ -1,155 +0,0 @@ -'\" te -.\" Copyright 2003 Sun Microsystems, Inc. -.\" 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 MECH 4 "Sep 6, 2006" -.SH NAME -mech, qop \- mechanism and QOP files -.SH SYNOPSIS -.LP -.nf -\fB/etc/gss/mech\fR -\fB/etc/gss/qop\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/etc/gss/mech\fR and \fB/etc/gss/qop\fR files contain tables showing -installed security mechanisms and the Quality of Protection (\fBQOP\fR) -associated with them, respectively. As security mechanisms are installed on the -system, entries are added to these two files. Contents of these files may be -accessed either manually or programmatically. For example, manually with -\fBcat\fR(1) or \fBmore\fR(1), or programmatically with either -\fBrpc_gss_get_mechanisms\fR(3NSL) or \fBrpc_gss_get_mech_info\fR(3NSL). -.sp -.LP -The order of entries in the \fB/etc/gss/mech\fR file is significant: the order -should be from the most preferred to the least preferred mechanisms. -.sp -.LP -The \fB/etc/gss/mech\fR file contains five fields: -.sp -.ne 2 -.na -\fB\fImechanism name\fR\fR -.ad -.sp .6 -.RS 4n -\fBASCII\fR string representing the mechanism. -.RE - -.sp -.ne 2 -.na -\fB\fIobject identifier\fR\fR -.ad -.sp .6 -.RS 4n -\fBRPC\fR \fBOID\fR for this mechanism. -.RE - -.sp -.ne 2 -.na -\fB\fIshared library\fR\fR -.ad -.sp .6 -.RS 4n -Shared library which implements the services provided by this mechanism. -.RE - -.sp -.ne 2 -.na -\fB\fIkernel module\fR\fR -.ad -.sp .6 -.RS 4n -Kernel module which implements the services provided by this mechanism. -.RE - -.sp -.ne 2 -.na -\fB\fIlibrary options\fR (optional field)\fR -.ad -.sp .6 -.RS 4n -Optional parameters that are interpreted by the individual mechanism with which -they are associated. Specific supported options are described in the -documentation for the individual mechanism, if any. Not all mechanisms have -support for optional parameters. \fIlibrary options\fR must be enclosed in -brackets (\fB[ ]\fR) so they may be differentiated from the optional kernel -module entries. -.RE - -.sp -.LP -The \fB/etc/gss/qop\fR file contains three fields: -.sp -.ne 2 -.na -\fB\fIQOP string\fR\fR -.ad -.RS 19n -Name, in \fBASCII\fR, of this Quality of Protection. -.RE - -.sp -.ne 2 -.na -\fB\fIQOP value\fR\fR -.ad -.RS 19n -Numeric value by which \fBRPC\fR identifies this \fBQOP\fR. -.RE - -.sp -.ne 2 -.na -\fB\fImechanism name\fR \fR -.ad -.RS 19n -\fBASCII\fR string representing the mechanism with which this \fBQOP\fR is -associated. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRA Typical Entry in \fB/etc/gss/mech\fR -.sp -.LP -This is a typical entry in a \fB/etc/gss/mech\fR file: - -.sp -.in +2 -.nf -kerberosv5 1.2.840.113554.1.2.2 mech_krb5.so kmech_krb5 -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRA Typical Entry in \fB/etc/gss/qop\fR -.sp -.LP -This is a typical entry in a \fB/etc/gss/qop\fR file: - -.sp -.in +2 -.nf -GSS_KRB5_CONF_C_QOP_DES 0 kerberosv5 -.fi -.in -2 -.sp - -.SH SEE ALSO -.sp -.LP -\fBrpc\fR(3NSL), \fBrpc_gss_get_mechanisms\fR(3NSL), -\fBrpc_gss_get_mech_info\fR(3NSL), \fBrpcsec_gss\fR(3NSL) -.sp -.LP -\fIONC+ Developer\&'s Guide\fR diff --git a/usr/src/man/man4/mnttab.4 b/usr/src/man/man4/mnttab.4 deleted file mode 100644 index e188b308e2..0000000000 --- a/usr/src/man/man4/mnttab.4 +++ /dev/null @@ -1,241 +0,0 @@ -'\" te -.\" Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2015 Nexenta Systems, Inc. All rights reserved. -.\" Copyright 1989 AT&T -.\" 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 MNTTAB 4 "Sep 8, 2015" -.SH NAME -mnttab \- mounted file system table -.SH DESCRIPTION -.LP -The file \fB/etc/mnttab\fR is really a file system that provides read-only -access to the table of mounted file systems for the current host. -\fB/etc/mnttab\fR is read by programs using the routines described in -\fBgetmntent\fR(3C). Mounting a file system adds an entry to this table. -Unmounting removes an entry from this table. Remounting a file system causes -the information in the mounted file system table to be updated to reflect any -changes caused by the remount. The list is maintained by the kernel in order of -mount time. That is, the first mounted file system is first in the list and the -most recently mounted file system is last. When mounted on a mount point the -file system appears as a regular file containing the current \fBmnttab\fR -information. -.LP -Each entry is a line of fields separated by TABs in the form: -.sp -.in +2 -.nf -\fIspecial mount_point fstype options time\fR -.fi -.in -2 - -.LP -where: -.sp -.ne 2 -.na -\fB\fIspecial\fR\fR -.ad -.RS 15n -The name of the resource that has been mounted. -.RE - -.sp -.ne 2 -.na -\fB\fImount_point\fR\fR -.ad -.RS 15n -The pathname of the directory on which the filesystem is mounted. -.RE - -.sp -.ne 2 -.na -\fB\fIfstype\fR\fR -.ad -.RS 15n -The file system type of the mounted file system. -.RE - -.sp -.ne 2 -.na -\fB\fIoptions\fR\fR -.ad -.RS 15n -The mount options. See respective mount file system man page in the See Also -section below. -.RE - -.sp -.ne 2 -.na -\fB\fItime\fR\fR -.ad -.RS 15n -The time at which the file system was mounted. -.RE - -.LP -Examples of entries for the \fIspecial\fR field include the pathname of a -block-special device, the name of a remote file system in the form of -\fIhost:pathname\fR, or the name of a \fBswap file\fR, for example, a file made -with \fBmkfile\fR(1M). -.SH IOCTLS -.LP -The following \fBioctl\fR(2) calls are supported: -.sp -.ne 2 -.na -\fB\fBMNTIOC_NMNTS\fR\fR -.ad -.RS 21n -Returns the count of mounted resources in the current snapshot in the -\fBuint32_t\fR pointed to by \fIarg\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBMNTIOC_GETDEVLIST\fR\fR -.ad -.RS 21n -Returns an array of \fBuint32_t\fR's that is twice as long as the length -returned by \fBMNTIOC_NMNTS\fR. Each pair of numbers is the major and minor -device number for the file system at the corresponding line in the current -\fB/etc/mnttab\fR snapshot. \fIarg\fR points to the memory buffer to receive -the device number information. -.RE - -.sp -.ne 2 -.na -\fB\fBMNTIOC_SETTAG\fR\fR -.ad -.RS 21n -Sets a tag word into the options list for a mounted file system. A tag is a -notation that will appear in the options string of a mounted file system but it -is not recognized or interpreted by the file system code. \fIarg\fR points to a -filled in \fBmnttagdesc\fR structure, as shown in the following example: -.sp -.in +2 -.nf -uint_t mtd_major; /* major number for mounted fs */ -uint_t mtd_minor; /* minor number for mounted fs */ -char *mtd_mntpt; /* mount point of file system */ -char *mtd_tag; /* tag to set/clear */ -.fi -.in -2 - -If the tag already exists then it is marked as set but not re-added. Tags can -be at most \fBMAX_MNTOPT_TAG\fR long. -.sp -Use of this ioctl is restricted to processes with the \fB{PRIV_SYS_MOUNT}\fR -privilege. -.RE - -.sp -.ne 2 -.na -\fB\fBMNTIOC_CLRTAG\fR\fR -.ad -.RS 21n -Marks a tag in the options list for a mounted file system as not set. \fIarg\fR -points to the same structure as \fBMNTIOC_SETTAG\fR, which identifies the file -system and tag to be cleared. -.sp -Use of this ioctl is restricted to processes with the \fB{PRIV_SYS_MOUNT}\fR -privilege. -.RE - -.SH ERRORS -.ne 2 -.na -\fB\fBEFAULT\fR\fR -.ad -.RS 16n -The arg pointer in an \fBMNTIOC_ ioctl\fR call pointed to an inaccessible -memory location or a character pointer in a \fBmnttagdesc\fR structure pointed -to an inaccessible memory location. -.RE - -.sp -.ne 2 -.na -\fB\fBEINVAL\fR\fR -.ad -.RS 16n -The tag specified in a \fBMNTIOC_SETTAG\fR call already exists as a file system -option, or the tag specified in a \fBMNTIOC_CLRTAG\fR call does not exist. -.RE - -.sp -.ne 2 -.na -\fB\fBENAMETOOLONG\fR\fR -.ad -.RS 16n -The tag specified in a \fBMNTIOC_SETTAG\fR call is too long or the tag would -make the total length of the option string for the mounted file system too -long. -.RE - -.sp -.ne 2 -.na -\fB\fBEPERM\fR\fR -.ad -.RS 16n -The calling process does not have \fB{PRIV_SYS_MOUNT}\fR privilege and either a -\fBMNTIOC_SETTAG\fR or \fBMNTIOC_CLRTAG\fR call was made. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/etc/mnttab\fR\fR -.ad -.RS 28n -Usual mount point for \fBmnttab\fR file system -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/include/sys/mntio.h\fR\fR -.ad -.RS 28n -Header file that contains \fBIOCTL\fR definitions -.RE - -.SH SEE ALSO -.LP -\fBmkfile\fR(1M), \fBmount_hsfs\fR(1M), \fBmount_nfs\fR(1M), -\fBmount_pcfs\fR(1M), \fBmount_ufs\fR(1M), \fBmount\fR(1M), -\fBioctl\fR(2), \fBread\fR(2), \fBpoll\fR(2), \fBstat\fR(2), -\fBgetmntent\fR(3C) -.SH WARNINGS -.LP -The \fBmnttab\fR file system provides the previously undocumented -\fBdev=\fR\fIxxx\fR option in the option string for each mounted file system. -This is provided for legacy applications that might have been using the -\fBdev=information\fR option. -.LP -Using \fBdev=\fR\fIoption\fR in applications is strongly discouraged. The -device number string represents a 32-bit quantity and might not contain correct -information in 64-bit environments. -.LP -Applications requiring device number information for mounted file systems -should use the \fBgetextmntent\fR(3C) interface, which functions properly in -either 32- or 64-bit environments. -.SH NOTES -.LP -The snapshot of the \fBmnttab\fR information is taken any time a \fBread\fR(2) -is performed at offset \fB0\fR (the beginning) of the \fBmnttab\fR file. The -file modification time returned by \fBstat\fR(2) for the \fBmnttab\fR file is -the time of the last change to mounted file system information. A \fBpoll\fR(2) -system call requesting a \fBPOLLRDBAND\fR event can be used to block and wait -for the system's mounted file system information to be different from the most -recent snapshot since the \fBmnttab\fR file was opened. diff --git a/usr/src/man/man4/mpapi.conf.4 b/usr/src/man/man4/mpapi.conf.4 deleted file mode 100644 index 4edf6a9adb..0000000000 --- a/usr/src/man/man4/mpapi.conf.4 +++ /dev/null @@ -1,98 +0,0 @@ -'\" te -.\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved. -.\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 MPAPI.CONF 4 "Sep 16, 2018" -.SH NAME -mpapi.conf \- configuration file for libMPAPI -.SH SYNOPSIS -.LP -.nf -/etc/mpapi.conf -.fi - -.SH DESCRIPTION -.LP -The \fB/etc/mpapi.conf\fR file is used to specify the vendor-provided plugin -library that is installed on the system. This file is used by the -\fBlibMPAPI\fR(3LIB) common library to load the individual plugin library when -its interface is called. If changes are made to the file while the library is -in use, the library should be unloaded and reloaded. Addition and removal of -the plugin library should be handled through \fBMP_RegisterPlugin\fR(3MPAPI) -and \fBMP_DeregisterPlugin\fR(3MPAPI). -.sp -.LP -Each plugin library entry is a single line of the form: -.sp -.in +2 -.nf -"id" "library file name" -.fi -.in -2 -.sp - -.sp -.LP -where -.sp -.ne 2 -.na -\fB\fBid\fR\fR -.ad -.RS 21n -The identification of the library. It is the reversed domain name of the vendor -followed by \fB\&.\fR followed by the vendor specific name of the plugin that -uniquely identifies the plugin library. -.RE - -.sp -.ne 2 -.na -\fB\fBlibrary file name\fR\fR -.ad -.RS 21n -The absolute path to the shared object library file. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRExample of an \fB/etc/mpapi.conf\fR file -.sp -.in +2 -.nf -# This file contains names and references to MP API plugin libraries -# -# Do NOT manually edit this file -# -# Format: -# -# <library ID> <library file name> -# -com.sun.mpapi32 /lib/libmpscsi_vhci.so -com.sun.mpapi64 /lib/64/libmpscsi_vhci.so -.fi -.in -2 - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability T{ -Standard: ANSI INCITS 412 Multipath Management API -T} -.TE - -.SH SEE ALSO -.LP -\fBlibMPAPI\fR(3LIB), \fBMP_DeregisterPlugin\fR(3MPAPI), -\fBMP_RegisterPlugin\fR(3MPAPI), \fBattributes\fR(5) diff --git a/usr/src/man/man4/nca.if.4 b/usr/src/man/man4/nca.if.4 deleted file mode 100644 index 68fe2de3e7..0000000000 --- a/usr/src/man/man4/nca.if.4 +++ /dev/null @@ -1,137 +0,0 @@ -'\" te -.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved -.\" 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 NCA.IF 4 "Feb 18, 2003" -.SH NAME -nca.if \- the NCA configuration file that specifies physical interfaces -.SH SYNOPSIS -.LP -.nf -\fB/etc/nca/nca.if\fR -.fi - -.SH DESCRIPTION -.sp -.LP -Specify the physical interfaces for which the Solaris Network Cache and -Accelerator ("\fBNCA\fR") feature will be configured in the \fBnca.if\fR -configuration file. List the physical interfaces in the file, one per line. To -configure \fBNCA\fR to listen on all physical interfaces present on the system -backed by a \fBhostname.{interface_name}\fR, then list only an asterik -("\fB*\fR") in \fBnca.if\fR. -.sp -.LP -When the \fBncakmod\fR(1) initialization script is invoked during system boot, -it will attempt to configure each physical interface specified in the -\fBnca.if\fR file by using \fBncaconfd\fR(1M). Note that there must be an -accompanying \fBhostname.{interface_name}\fR file and an entry in -\fB/etc/hosts\fR for the contents of \fBhostname.{interface_name}\fR. -.sp -.LP -You must reboot in order to implement changes to the \fBnca.if\fR file. -.SH EXAMPLES -.SS "x86" -.LP -\fBExample 1 \fR\fBnca.if\fR on x86 -.sp -.LP -The following is an example of an \fBnca.if\fR file that would be used on an -x86 system: - -.sp -.in +2 -.nf -iprb1 -iprb6 -iprb8 -.fi -.in -2 - -.SS "SPARC" -.LP -\fBExample 2 \fR\fBnca.if\fR on SPARC -.sp -.LP -The following is an example of an \fBnca.if\fR file that would be used on a -SPARC system: - -.sp -.in +2 -.nf -hme2 -hme3 -hme4 -.fi -.in -2 - -.SS "All Platforms" -.LP -\fBExample 3 \fRConfiguring NCA to Listen on All Physical Interfaces -.sp -.LP -The following example shows the contents of an \fBnca.if\fR file that would be -used to configure either platform to listen on all physical interfaces present -on the system: - -.sp -.in +2 -.nf -* -.fi -.in -2 - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/nca/nca.if\fR\fR -.ad -.RS 25n -Lists the physical interfaces on which \fBNCA\fR will run. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/hostname.{}{0-9}\fR\fR -.ad -.RS 25n -Lists all physical interfaces configured on the server. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/hosts\fR\fR -.ad -.RS 25n -Lists all host names associated with the server. Entries in this file must -match with entries in \fB/etc/hostname.{}{0-9}\fR for \fBNCA\fR to function. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBnca\fR(1), \fBncab2clf\fR(1), \fBncakmod\fR(1), \fBifconfig\fR(1M), -\fBncakmod.conf\fR(4), \fBncalogd.conf\fR(4), \fBattributes\fR(5) -.sp -.LP -\fISystem Administration Guide: IP Services\fR diff --git a/usr/src/man/man4/ncad_addr.4 b/usr/src/man/man4/ncad_addr.4 deleted file mode 100644 index 198a6e87ff..0000000000 --- a/usr/src/man/man4/ncad_addr.4 +++ /dev/null @@ -1,75 +0,0 @@ -'\" te -.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved -.\" 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 NCAD_ADDR 4 "April 9, 2016" -.SH NAME -ncad_addr \- name of the Solaris Network Cache and Accelerator (NCA) socket -utility library -.SH SYNOPSIS -.LP -.nf -\fB/usr/lib/ncad_addr.so\fR -.fi - -.SH DESCRIPTION -.LP -\fBncad_addr.so\fR is the Solaris Network Cache and Accelerator (\fBNCA\fR) -socket utility library. Use this library with a web server to avoid support for -the \fBPF_NCA\fR family type socket. The web server can take advantage of NCA -functionality. -.sp -.LP -Interpose the \fBncad_addr\fR interfaces before the interfaces in -\fBlibsocket\fR by setting the environment variable \fBLD_PRELOAD\fR to -\fBncad_addr.so\fR so that it is preloaded before \fBlibsocket.so.1\fR. The -\fBncad_addr.so\fR interfaces will be interposed only if NCA is enabled. See -\fBncakmod\fR(1). -.SH EXAMPLES -.LP -\fBExample 1 \fRInterposing \fBncad_addr\fR -.sp -.LP -Using Bourne shell syntax as an example, set \fBLD_PRELOAD\fR as shown below to -interpose the \fBncad_addr\fR socket utility library: - -.sp -.in +2 -.nf -LD_PRELOAD=/usr/lib/ncad_addr.so /usr/bin/httpd -.fi -.in -2 - -.SH FILES -.ne 2 -.na -\fB\fB/usr/lib/ncad_addr.so\fR\fR -.ad -.RS 25n -\fBncad_addr\fR socket utility library shared object -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Unstable -.TE - -.SH SEE ALSO -.LP -\fBnca\fR(1), \fBncab2clf\fR(1), \fBncakmod\fR(1), \fBsocket\fR(3SOCKET), -\fBnca.if\fR(4), \fBncakmod.conf\fR(4), \fBattributes\fR(5) -.SH NOTES -.LP -Only applications that use the \fBNCA\fR feature, for example, web servers, -should interpose this library. diff --git a/usr/src/man/man4/ncakmod.conf.4 b/usr/src/man/man4/ncakmod.conf.4 deleted file mode 100644 index ed9f72fbb0..0000000000 --- a/usr/src/man/man4/ncakmod.conf.4 +++ /dev/null @@ -1,104 +0,0 @@ -'\" te -.\" Copyright (C) 2001, Sun Microsystems, Inc. All Rights Reserved -.\" 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 NCAKMOD.CONF 4 "Sep 28, 2001" -.SH NAME -ncakmod.conf \- ncakmod configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/nca/ncakmod.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBncakmod.conf\fR file is used to configure the Solaris Network Cache and -Accelerator ("\fBNCA\fR") kernel module. The file contains two fields, -\fBkey\fR and \fBvalue\fR. -.sp -.LP -The \fBstatus\fR key is used to indicate if the user wants to have \fBNCA\fR -turned on as a feature. If the value of \fBstatus\fR key is \fBenabled\fR, -then the \fBNCA\fR kernel module will be pushed on to the specified interfaces. -If the value of the \fBstatus\fR key is \fBdisabled\fR, then the \fBNCA\fR -kernel module will not be pushed on to any interfaces . The default is -\fBdisabled\fR. -.sp -.LP -The \fBhttpd_door_path\fR key specifies the path name of the Solaris Door -\fBRPC\fR mechanism that will be used to communicate with the \fBhttp\fR -daemon. The default value is \fB/var/run/nca_httpd_1.door\fR. -.sp -.LP -Use the \fBnca_active\fR key to indicate whether to allow NCA to actively open -outgoing TCP connections. The default value for \fBnca_active\fR is -\fBdisabled\fR. If set to \fBenabled\fR, \fBncaconfd\fR sets up NCA for each -interface and then operates as a daemon, allowing NCA to make outgoing TCP -connections. This functionality is possible only by using the doors interface -to NCA. A web server that uses the sockets interface with \fBPF_NCA\fR or -\fBncad_addr.so\fR cannot connect by means of \fBnca_active\fR. -.sp -.LP -NCA supports the logging of in-kernel cache hits. See \fBncalogd.conf\fR(4). -NCA stores logs in a binary format. Use the \fBncab2clf\fR(1) utility to -convert the log from a binary format to the Common Log File format. -.sp -.LP -In order to implement changes to the \fBncakmod.conf\fR file, you will need to -reboot. -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample \fBncakmod.conf\fR File -.sp -.LP -The following is a sample \fBncakmod.conf\fR file: - -.sp -.in +2 -.nf -# -# NCA Kernel Module Configuration File -# -status=disabled -httpd_door_path=/var/run/nca_httpd_1.door -nca_active=disabled -.fi -.in -2 - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/nca/ncakmod.conf\fR\fR -.ad -.RS 25n -The NCA kernel module configuration file. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBnca\fR(1), \fBncab2clf\fR(1), \fBncakmod\fR(1), \fBdoor_create\fR(3C), -\fBnca.if\fR(4), \fBncad_addr\fR(4), \fBncalogd.conf\fR(4), \fBattributes\fR(5) -.sp -.LP -\fISystem Administration Guide: IP Services\fR diff --git a/usr/src/man/man4/ncalogd.conf.4 b/usr/src/man/man4/ncalogd.conf.4 deleted file mode 100644 index 0d3a06a69f..0000000000 --- a/usr/src/man/man4/ncalogd.conf.4 +++ /dev/null @@ -1,113 +0,0 @@ -'\" te -.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 NCALOGD.CONF 4 "Jan 22, 2002" -.SH NAME -ncalogd.conf \- NCA logging configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/nca/ncalogd.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBncalogd.conf\fR is used to configure Solaris Network Cache and -Accelerator ("\fBNCA\fR") logging. The file contains two fields, \fBkey\fR and -\fBvalue\fR. -.sp -.LP -The \fBstatus\fR key is used to indicate if the user wants to have \fBNCA\fR -logging turned on. If the value of \fBstatus\fR key is \fBenabled\fR, then -\fBNCA\fR logging will be turned on. If the value of the \fBstatus\fR key is -\fBdisabled\fR, then \fBNCA\fR logging will not be invoked. The default value -is \fBdisabled\fR. -.sp -.LP -The \fBlogd_path_name\fR key specifies the absolute pathname of the log file. -The log file must be a raw device without a filesystem or a file on a local -file system. The default value is \fB/var/nca/log\fR. \fBlogd_path_name\fR can -also contain a whitespace-delimited list of values for multiple log files to a -maximum of 16. If you specify multiple log files, you must enclose the list in -quotation marks ("). With multiple files, \fBNCA\fR logging moves to the next -file on the list once the file size specified by \fBlogd_file_size\fR has been -reached. When the last file is full, \fBNCA\fR logging rotates back to the -first file in the list. A pointer to the current log file is stored in -\fB/var/nca/current\fR. -.sp -.LP -The \fBlogd_file_size\fR key specifies the value of the file size, in bytes, -allowed for each log file specified in by the \fBlogd_path_name\fR key. The -default value is 1000000 bytes. -.sp -.LP -In order to implement changes to the \fBncalogd.conf\fR file, you will need to -stop and start NCA logging or reboot. -.sp -.LP -NCA stores logs in a binary format. Use the \fBncab2clf\fR(1) utility to -convert the log from a binary format to the Common Log File format. -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample \fBncalogd.conf\fR File -.sp -.LP -The following is a sample \fBncalogd.conf\fR file that specifies three log -files: - -.sp -.in +2 -.nf -# -# NCA Log Daemon Configuration File -# - -status=enabled -logd_path_name="/var/nca/log1 /var/nca/log2 /var/nca/log3" -logd_file_size=1000000 -.fi -.in -2 - -.sp -.LP -Note that there is no NCA logging daemon. Logging is performed as one of the -functions of the NCA software. - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/nca/ncalogd.conf\fR\fR -.ad -.RS 25n -Lists configuration parameters for \fBNCA\fRlogging. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBnca\fR(1), \fBncab2clf\fR(1), \fBncakmod\fR(1), \fBdd\fR(1M), -\fBdoor_create\fR(3C), \fBnca.if\fR(4), \fBncakmod.conf\fR(4), -\fBattributes\fR(5) -.sp -.LP -\fISystem Administration Guide: IP Services\fR diff --git a/usr/src/man/man4/ncaport.conf.4 b/usr/src/man/man4/ncaport.conf.4 deleted file mode 100644 index 1c85142dd9..0000000000 --- a/usr/src/man/man4/ncaport.conf.4 +++ /dev/null @@ -1,66 +0,0 @@ -'\" te -.\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 NCAPORT.CONF 4 "Jul 30, 2001" -.SH NAME -ncaport.conf \- ncaport configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/nca/ncaport.conf\fR -.fi - -.SH DESCRIPTION -.LP -The \fBncaport.conf\fR file is used to configure the IP addresses and ports -that the Solaris Network Cache and Acceleration (NCA) kernel module services. -The file contains two fields, key and value, in the format of -\fBncaport=\fIipaddress\fR/\fIport\fR\fR. IPv4 addresses must be in the dot -notation \fId\fR.\fId\fR.\fId\fR.\fId\fR. IPv6 addresses must be in one of the -three conventional forms (see \fBinet_pton\fR(3C)). If an asterisk -(\fB*\fR) is used for an IP address, it is interpreted as \fBINADDR_ANY\fR, -which matches any IP address. -.sp -.LP -A web server uses the environment variable \fBLD_PRELOAD\fR and the -\fBncaport.conf\fR configuration file to convert an \fBAF_INET\fR socket to an -\fBAF_NCA\fR socket. \fBLD_PRELOAD\fR enables the NCA socket utility library to -be loaded before \fBlibsocket.so.1\fR. See the \fBncad_addr\fR(4) for details. -When a web server issues the \fBbind\fR(3SOCKET) system call, it is intercepted -by the interposition library \fBncad_addr.so\fR. If the bind address is in the -\fBncaport.conf\fR file, the \fBAF_INET\fR socket is converted to a -\fBAF_NCA\fR socket. -.SH EXAMPLES -.LP -\fBExample 1 \fRSample \fBncaport.conf\fR File -.sp -.LP -The following is a sample \fBncaport.conf\fR file: - -.sp -.in +2 -.nf -# -# NCA Kernel Module Port Configuration File -# -ncaport=1080:0:0:0:8:800:200C:417A/100 -ncaport=192.168.84.71/80 -ncaport=*/9000 -.fi -.in -2 -.sp - -.SH SEE ALSO -.LP -\fBnca\fR(1), \fBbind\fR(3SOCKET), \fBinet_pton\fR(3C), -\fBncad_addr\fR(4), \fBattributes\fR(5) -.SH NOTES -.LP -For those web servers that use \fBAF_NCA\fR sockets, the NCA port configuration -described here has no effect. -.sp -.LP -NCA does not currently support IPv6. Any IPv6 addresses in the file -\fBncaport.conf\fR are ignored. diff --git a/usr/src/man/man4/ndmp.4 b/usr/src/man/man4/ndmp.4 deleted file mode 100644 index 16ef84eadf..0000000000 --- a/usr/src/man/man4/ndmp.4 +++ /dev/null @@ -1,174 +0,0 @@ -'\" te -.\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2014 Nexenta Systems, Inc. All rights reserved. -.\" 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 NDMP 4 "Feb 24, 2014" -.SH NAME -ndmp \- configuration properties for Solaris Network Data Management Protocol -(NDMP) server -.SH DESCRIPTION -.sp -.LP -The behavior of the Solaris NDMP server is specified by property values that -are stored in the Service Management Facility, \fBsmf\fR(5). -.sp -.LP -An authorized user can use the \fBndmpadm\fR(1M) command to set global values -for these properties in SMF. -.sp -.LP -You can set the following properties by using the \fBndmpadm set\fR command: -.sp -.ne 2 -.na -\fB\fBbackup-quarantine\fR\fR -.ad -.RS 24n -Backup the files marked as quarantined by AV. Acceptable values are \fByes\fR -or \fBno\fR. The default is \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdar-support\fR\fR -.ad -.RS 24n -Set the Direct Access Recovery mode. Acceptable values are \fByes\fR or -\fBno\fR. The default is \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdebug-path\fR\fR -.ad -.RS 24n -The path to which to save the debug log. The default is \fB/var/log/ndmp\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdebug-mode\fR\fR -.ad -.RS 24n -Enable or disable debug log messages. -.RE - -.sp -.ne 2 -.na -\fB\fBdump-pathnode\fR\fR -.ad -.RS 24n -Enable or disable backing up the directories containing modified files or -directories in \fBdump\fR(1) backup format. Acceptable values are yes or no. -The default is no. -.RE - -.sp -.ne 2 -.na -\fB\fBignore-ctime\fR\fR -.ad -.RS 24n -Determines whether the change timestamp (\fBctime\fR) of files and directories -is used to determine whether a file should be backed up in level backup. If -this parameter is set to \fByes\fR, only the modification time (\fBmtime\fR) of -the file or directory determines whether it should be backed up. Acceptable -values are \fByes\fR or \fBno\fR. The default value is \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBoverwrite-quarantine\fR\fR -.ad -.RS 24n -Restore quarantined files on top of current files if they already exist. -Acceptable values are \fByes\fR or \fBno\fR. The default value is \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBrestore-quarantine\fR\fR -.ad -.RS 24n -Restore the files that had been marked as quarantined by AV and are backed up. -Acceptable values are yes or no. The default value is no. -.RE - -.sp -.ne 2 -.na -\fB\fBtar-pathnode\fR\fR -.ad -.RS 24n -Enable or disable backing up the directories containing modified files or -directories in \fBtar\fR(1) backup format. Acceptable values are \fByes\fR or -\fBno\fR. The default value is \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBtoken-maxseq\fR\fR -.ad -.RS 24n -Set the maximum sequence number for subsequent token-based incremental backup -in NDMP-V4. The default value is \fB9\fR. There are two limits for this value: -soft-limit, which is \fB59\fR, and hard-limit, equal to \fB64\fR. If the token -sequence number, passed by the DMA, is between the soft and hard limits, a -warning message is issued to the DMA. The token sequence number can never -exceed the hard-limit value. -.RE - -.sp -.ne 2 -.na -\fB\fBversion\fR\fR -.ad -.RS 24n -Set the maximum active NDMP protocol version. Valid values are currently -\fB2\fR, \fB3\fR, and \fB4\fR. The default is \fB4\fR. -.RE - -.sp -.LP -The following property can only be set when using the \fBndmpadm enable\fR or -\fBndmpadm disable\fR command: -.sp -.ne 2 -.na -\fB\fBauth-type\fR\fR -.ad -.RS 13n -Sets the password encryption type for the authentication of local users. Valid -values are \fBcram-md5\fR or \fBcleartext\fR. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdump\fR(1), \fBtar\fR(1), \fBndmpadm\fR(1M), \fBndmpd\fR(1M), -\fBattributes\fR(5), \fBsmf\fR(5) diff --git a/usr/src/man/man4/ndpd.conf.4 b/usr/src/man/man4/ndpd.conf.4 deleted file mode 100644 index f3ec1a3e1f..0000000000 --- a/usr/src/man/man4/ndpd.conf.4 +++ /dev/null @@ -1,552 +0,0 @@ -'\" te -.\" Copyright (C) 2004, Sun Microsystems, Inc. All Rights Reserved -.\" 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 NDPD.CONF 4 "Jan 4, 2007" -.SH NAME -ndpd.conf \- configuration file for IPv6 router autoconfiguration -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/ndpd.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBndpd.conf\fR file contains configuration information for -\fBin.ndpd\fR(1M). On a host, this file does not need to exist or can be empty. -The file has one configuration entry per line; note that lines can be extended -with a backslash (\fB\e\fR) followed by a NEWLINE. There are four forms of -configuration entries which are identified by the first field on the line: -\fBifdefault\fR, \fBprefixdefault\fR, \fBif\fR, or \fBprefix\fR. The -\fBifdefault\fR and \fBif\fR entries set interface configuration variables. The -former establishes the routing behavior for all interfaces, the latter sets -per-interface parameters. Any \fBifdefault\fR entries must precede any \fBif\fR -entries in the file. -.sp -.LP -The \fBprefixdefault\fR and \fBprefix\fR entries control prefix configuration -variables. \fBprefixdefault\fR establishes the default behavior for all prefix -advertisements on all interfaces. The \fBprefix\fR keyword advertises -per-prefix information. Any \fBprefixdefault\fR entries must precede any -\fBprefix\fR entries in the file. -.sp -.LP -Each \fBifdefault\fR entry is composed of a single line of the form: -.sp -.in +2 -.nf -ifdefault [ \fIif-variable-name\fR \fIvalue\fR ]* -.fi -.in -2 - -.sp -.LP -Each \fBif\fR entry is composed of a single line of the form: -.sp -.in +2 -.nf -if \fIinterface\fR [ \fIif-variable-name\fR \fIvalue\fR ]* -.fi -.in -2 - -.sp -.LP -Each \fBprefixdefault\fR entry is composed of a single line of the form: -.sp -.in +2 -.nf -prefixdefault [ \fIprefix-variable-name\fR \fIvalue\fR ]* -.fi -.in -2 - -.sp -.LP -Each prefix\fB\fR entry is composed of a single line of the form: -.sp -.in +2 -.nf -prefix \fIprefix\fR/\fIprefix_length\fR \fIinterface\fR [ \fIprefix-variable-name\fR \fIvalue\fR ]* -.fi -.in -2 - -.sp -.LP -Fields are separated by either SPACE or TAB characters. A `\fB#\fR' (number -sign) indicates the beginning of a comment. Characters up to the end of the -line are not interpreted by routines that search this file. -.sp -.ne 2 -.na -\fB\fB\fIinterface\fR\fR\fR -.ad -.RS 24n -The name of a network interface, for example, \fBeri0\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB\fIprefix\fR\fR\fR -.ad -.RS 24n -An IPv6 address in standard hexadecimal notation, for example, -\fBfec0:0:0:1::0\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB\fIprefix_length\fR\fR\fR -.ad -.RS 24n -A number between 0 and 128. -.RE - -.sp -.ne 2 -.na -\fB\fB\fIif-variable-name\fR\fR\fR -.ad -.RS 24n -An interface variable. Below is the list of interface variables applicable to -routers only along with their default values and units as discussed in \fIRFC -2461\fR and \fIRFC 2462\fR. The \fBTmp\fR* variables apply to hosts and -routers. The \fBTmp\fR* variables configure temporary address functionality as -defined in \fIRFC 3041\fR. -.sp -.in +2 -.nf -Variable Name Default Unit - -AdvSendAdvertisements false Boolean -DupAddrDetectTransmits 1 Counter -MaxRtrAdvInterval 600 Seconds -MinRtrAdvInterval 200 Seconds -AdvManagedFlag false Boolean -AdvOtherConfigFlag false Boolean -AdvLinkMTU 0 Bytes -AdvReachableTime 0 Milliseconds -AdvRetransTimer 0 Milliseconds -AdvCurHopLimit see below Counter -AdvDefaultLifetime 1800 Seconds -.fi -.in -2 -.sp - -These variables are described as follows: -.sp -.ne 2 -.na -\fB\fBAdvSendAdvertisements\fR\fR -.ad -.RS 26n -Indicates whether the node should send out advertisements and respond to router -solicitations. You need to explicitly configure this value to turn on router -advertisement functions. -.RE - -.sp -.ne 2 -.na -\fB\fBDupAddrDetectTransmits\fR\fR -.ad -.RS 26n -Defines the number of consecutive Neighbor Solicitation messages that the -Neighbor Discovery protocol should send during Duplicate Address Detection of -the local node's address. -.RE - -.sp -.ne 2 -.na -\fB\fBMaxRtrAdvInterval\fR\fR -.ad -.RS 26n -Specifies the maximum time to wait between sending unsolicited multicast -advertisements. -.RE - -.sp -.ne 2 -.na -\fB\fBMinRtrAdvInterval\fR\fR -.ad -.RS 26n -Specifies the minimum amount of time to wait between sending unsolicited -multicast advertisements. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvManagedFlag\fR\fR -.ad -.RS 26n -Indicates the value to be placed in the "Manage address configuration" flag in -the Router Advertisement. This flag causes hosts to run DHCPv6 to acquire -addresses and other configuration information. This flag causes hosts to run -DHCPv6 to acquire configuration information, but only if \fBAdvManagedFlag\fR -is not set. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvOtherConfigFlag\fR\fR -.ad -.RS 26n -Indicates the value to be placed in the "Other stateful configuration"flag in -the Router Advertisement. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvLinkMTU\fR\fR -.ad -.RS 26n -Specifies an MTU value to be sent by the router. The default of zero indicates -that the router does not specify MTU options. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvReachableTime\fR\fR -.ad -.RS 26n -Specifies the value in the Reachable Time field in the advertisement messages -sent by the router. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvRetransTimer\fR\fR -.ad -.RS 26n -Specifies the value in the Retrans Timer field in the advertisement messages -sent by the router. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvCurHopLimit\fR\fR -.ad -.RS 26n -Specifies the value to be placed in the current hop limit field in the -advertisement messages sent by the router. The default is the current diameter -of the Internet. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvDefaultLifetime\fR\fR -.ad -.RS 26n -Specifies the default lifetime of the router advertisements. -.RE - -Listed below is the interface variable that applies to both hosts and routers. -.sp -.in +2 -.nf -Variable Name Default Unit - -StatefulAddrConf true Boolean -StatelessAddrConf true Boolean -TmpAddrsEnabled false Boolean -TmpValidLifetime 604800 Seconds - (1 week) -TmpPreferredLifetime 86400 Seconds - (1 day) -TmpRegenAdvance 5 Seconds -TmpMaxDesyncFactor 600 Seconds -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fB\fBStatefulAddrConf\fR\fR -.ad -.RS 24n -Controls whether the system configures its IPv6 addresses by means of the -Stateful Address Autoconfiguration mechanism, also known as DHCPv6, as -described in RFC 3315. If enabled (the default), hosts automatically run DHCPv6 -based on the "managed" and "other" flags sent by routers. If disabled, -\fBin.ndpd\fR will not invoke DHCPv6 automatically. DHCPv6 can still be invoked -manually by using \fBifconfig\fR(1M), in which case \fBin.ndpd\fR automatically -sets the prefix length as needed. -.RE - -.sp -.ne 2 -.na -\fB\fBStatelessAddrConf\fR\fR -.ad -.RS 24n -Controls whether the system configures its IPv6 addresses by means of the -Stateless Address Autoconfiguration mechanism described in \fIRFC 2462\fR. If -enabled hosts (the default) autoconfigure addresses based on prefixes -advertised by routers, routers will only autoconfigure addresses based on the -prefixes they advertise themselves. In other words, even when enabled, routers -do not autoconfigure addresses based on prefixes that other routers advertise. -If you specify \fBfalse\fR for this variable, then the address must be -configured manually. -.RE - -.sp -.ne 2 -.na -\fB\fBTmpAddrsEnabled\fR\fR -.ad -.RS 24n -Indicates whether a temporary address should be created for all interfaces or -for a particular interface of a node. -.RE - -.sp -.ne 2 -.na -\fB\fBTmpValidLifetime\fR\fR -.ad -.RS 24n -Sets the valid lifetime for a temporary address. -.RE - -.sp -.ne 2 -.na -\fB\fBTmpPreferredLifetime\fR\fR -.ad -.RS 24n -Sets the preferred lifetime of a temporary address. -.RE - -.sp -.ne 2 -.na -\fB\fBTmpRegenAdvance\fR\fR -.ad -.RS 24n -Specifies the lead time in advance of address deprecation for generation of a -new temporary address. -.RE - -.sp -.ne 2 -.na -\fB\fBTmpMaxDesyncFactor\fR\fR -.ad -.RS 24n -Sets the upper bound on the DesyncFactor, which is a random value that is used -to shorten the preferred lifetime so that clients do not regenerate an address -at the same time. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIprefix-variable-name\fR\fR -.ad -.RS 24n -A prefix variable as discussed in \fIRFC 2461 \fR and \fIRFC 2462\fR. The -following lists the each interface variable and its default value and unit: -.sp - -.sp -.TS -box; -c | c | c -l | l | l . -Variable Name Default Unit -_ -AdvValidLifetime 2592000 Seconds -_ -AdvOnLinkFlag true Boolean -_ -AdvPreferredLifetime 604800 Seconds -_ -AdvAutonomousFlag true Boolean -_ -AdvValidExpiration not set Date/Time -_ -AdvPreferredExpiration not set Date/TIme -.TE - -These variables are described as follows: -.sp -.ne 2 -.na -\fB\fBAdvValidLifetime\fR\fR -.ad -.RS 26n -Specifies the valid lifetime of the prefix that is being configured. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvOnLinkFlag\fR\fR -.ad -.RS 26n -Specifies the value to be placed in the on-link flag ("L-bit") field in the -Prefix Information option. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvPreferredLifetime\fR\fR -.ad -.RS 26n -Specifies the value to be placed in the Preferred Lifetime in the Prefix -Information option. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvAutonomousFlag\fR\fR -.ad -.RS 26n -Specifies the value to be placed in the Autonomous Flag field in the Prefix -Information option. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvValidExpiration\fR\fR -.ad -.RS 26n -Specifies the valid expiration date of the prefix. -.RE - -.sp -.ne 2 -.na -\fB\fBAdvPreferredExpiration\fR\fR -.ad -.RS 26n -Specifies the preferred expiration date of the prefix. -.RE - -The \fBAdvValidExpiration\fR and \fBAdvPreferredExpiration\fR variables are -used to specify that the lifetime should be decremented in real time as -specified in \fIRFC 2461\fR. If an \fBExpiration\fR variable is set, it takes -precedence over the corresponding \fBAdvValidLifetime\fR or -\fBAdvPreferredLifetime\fR variable setting. -.RE - -.sp -.ne 2 -.na -\fB\fIvalue\fR\fR -.ad -.RS 24n -The value is a function of the unit. Boolean values are \fBtrue\fR, -\fBfalse\fR, \fBon\fR, \fBoff\fR, \fB1\fR, or \fB0\fR. -.sp -Values in seconds can have characters appended for day (\fBd\fR), hour -\fBh\fR), minute (\fBm\fR) and second (\fBs\fR). The default is seconds. For -example, \fB1h\fR means 1 hour. This is equivalent to the value \fB3600\fR. -.sp -Values in milliseconds can have characters appended for day (\fBd\fR),hour -(\fBh\fR), minute (\fBm\fR) second (\fBs\fR), and millisecond (\fBms\fR). The -default is milliseconds. For example, \fB1h\fR is equivalent to the value -\fB3600000\fR. -.sp -Date/time values are strings that use the recommended ISO date format described -as "\fB%Y-%m-%d %R\fR", which represents a 4 digit year, a dash character, a -numeric month, a dash character, and a numeric day of the month, followed by -one or more whitespace characters and finally a 24 hour clock with hours, a -colon, and minutes. For example, \fB1999-01-31 20:00\fR means 8pm January 31 in -1999. Since the date/time values contain a space, use single or double quotes -to declare the value. For example: -.sp -.in +2 -.nf -prefixdefault AdvPreferredExpiration '1999-01-31 20:00' -.fi -.in -2 - -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRSending Router Advertisements for all Interfaces -.sp -.LP -The following example can be used to send router advertisements out to all -interfaces: - -.sp -.in +2 -.nf -# Send router advertisements out all interfaces -ifdefault AdvSendAdvertisements on -prefixdefault AdvOnLinkFlag on AdvAutonomousFlag on - -# Advertise a (bogus) global prefix and a site -# local prefix on three interfaces using the default lifetimes -prefix 2:0:0:9255::0/64 eri0 -prefix fec0:0:0:9255::0/64 eri0 - -prefix 2:0:0:9256::0/64 eri1 -prefix fec0:0:0:9256::0/64 eri1 - -prefix 2:0:0:9259::0/64 eri2 -prefix fec0:0:0:9259::0/64 eri2 -.fi -.in -2 - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBin.ndpd\fR(1M), \fBrouteadm\fR(1M), -\fBattributes\fR(5), \fBicmp6\fR(7P), \fBip6\fR(7P) -.sp -.LP -Narten, T., Nordmark, E., and Simpson, W. \fIRFC 2461, Neighbor Discovery for -IP Version 6 (IPv6)\fR. The Internet Society. December 1998. -.sp -.LP -Thomson, S., and Narten, T. \fIRFC 2462, IPv6 Stateless Address -Autoconfiguration\fR. The Internet Society. December 1998. -.sp -.LP -Narten, T., and Draves, R. \fIRFC 3041, Privacy Extensions for Stateless -Address Autoconfiguration in IPv6\fR. The Internet Society. January 2001. -.sp -.LP -Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6 -(DHCPv6)\fR. Cisco Systems. July 2003. -.sp -.LP -\fISystem Administration Guide: IP Services\fR diff --git a/usr/src/man/man4/netconfig.4 b/usr/src/man/man4/netconfig.4 deleted file mode 100644 index 074ab8627b..0000000000 --- a/usr/src/man/man4/netconfig.4 +++ /dev/null @@ -1,584 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" Copyright (C) 1999, Sun Microsystems, Inc. All Rights Reserved -.\" 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 NETCONFIG 4 "Nov 18, 2003" -.SH NAME -netconfig \- network configuration database -.SH SYNOPSIS -.LP -.nf -\fB/etc/netconfig\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The network configuration database, \fB/etc/netconfig\fR, is a system file used -to store information about networks that are connected to the system. The -\fBnetconfig\fR database and the routines that access it (see -\fBgetnetconfig\fR(3NSL)) are part of the Network Selection component. The -Network Selection component also includes \fBgetnetpath\fR(3NSL) routines to -provide application-specific network search paths. These routines access the -\fBnetconfig\fR database based on the environment variable \fBNETPATH\fR. See -\fBenviron\fR(5). -.sp -.LP -\fBnetconfig\fR contains an entry for each network available on the system. -Entries are separated by newlines. Fields are separated by whitespace and occur -in the order in which they are described below. Whitespace can be embedded as -``\fB\e\fR\fIblank\fR'' or ``\fB\e\fR\fItab\fR''. Backslashes may be embedded -as ``\fB\e\e\fR\&''. Lines in \fB/etc/netconfig\fR that begin with a \fB#\fR -(hash) in column 1 are treated as comments. -.sp -.LP -Each of the valid lines in the \fBnetconfig\fR database correspond to an -available transport. Each entry is of the form: -.sp -.in +2 -.nf -network ID semantics flag protocol-family \e - protocol-name network-device translation-libraries -.fi -.in -2 - -.sp -.ne 2 -.na -\fB\fInetwork ID\fR\fR -.ad -.RS 25n -A string used to uniquely identify a network. \fInetwork ID\fR consists of -non-null characters, and has a length of at least 1. No maximum length is -specified. This namespace is locally significant and the local system -administrator is the naming authority. All \fInetwork ID\fRs on a system must -be unique. -.RE - -.sp -.ne 2 -.na -\fB\fIsemantics\fR\fR -.ad -.RS 25n -The \fIsemantics\fR field is a string identifying the ``semantics'' of the -network, that is, the set of services it supports, by identifying the service -interface it provides. The \fIsemantics\fR field is mandatory. The following -semantics are recognized. -.sp -.ne 2 -.na -\fB\fBtpi_clts\fR\fR -.ad -.RS 16n -Transport Provider Interface, connectionless -.RE - -.sp -.ne 2 -.na -\fB\fBtpi_cots\fR\fR -.ad -.RS 16n -Transport Provider Interface, connection oriented -.RE - -.sp -.ne 2 -.na -\fB\fBtpi_cots_ord\fR\fR -.ad -.RS 16n -Transport Provider Interface, connection oriented, supports orderly release. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIflag\fR\fR -.ad -.RS 25n -The \fIflag\fR field records certain two-valued (``true'' and ``false'') -attributes of networks. \fIflag\fR is a string composed of a combination of -characters, each of which indicates the value of the corresponding attribute. -If the character is present, the attribute is ``true.'' If the character is -absent, the attribute is ``false.'' ``\fB-\fR'' indicates that none of the -attributes are present. Only one character is currently recognized: -.sp -.ne 2 -.na -\fB\fBv\fR\fR -.ad -.RS 5n -Visible (``default'') network. Used when the environment variable \fBNETPATH\fR -is unset. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIprotocol family\fR\fR -.ad -.RS 25n -The \fIprotocol family\fR and \fIprotocol name\fR fields are provided for -protocol-specific applications. The \fIprotocol family\fR field contains a -string that identifies a protocol family. The \fIprotocol family\fR identifier -follows the same rules as those for \fInetwork ID\fRs; the string consists of -non-null characters, it has a length of at least \fB1\fR, and there is no -maximum length specified. A ``\fB\(mi\fR\&'' in the \fIprotocol family\fR field -indicates that no protocol family identifier applies (the network is -experimental). The following are examples: -.sp -.ne 2 -.na -\fB\fBloopback\fR\fR -.ad -.RS 13n -Loopback (local to host). -.RE - -.sp -.ne 2 -.na -\fB\fBinet\fR\fR -.ad -.RS 13n -Internetwork: UDP, TCP, and the like. -.RE - -.sp -.ne 2 -.na -\fB\fBinet6\fR\fR -.ad -.RS 13n -Internetwork over IPv6: UDP, TCP, and the like. -.RE - -.sp -.ne 2 -.na -\fB\fBimplink\fR\fR -.ad -.RS 13n -ARPANET imp addresses -.RE - -.sp -.ne 2 -.na -\fB\fBpup\fR\fR -.ad -.RS 13n -PUP protocols: for example, BSP -.RE - -.sp -.ne 2 -.na -\fB\fBchaos\fR\fR -.ad -.RS 13n -MIT CHAOS protocols -.RE - -.sp -.ne 2 -.na -\fB\fBns\fR\fR -.ad -.RS 13n -XEROX NS protocols -.RE - -.sp -.ne 2 -.na -\fB\fBnbs\fR\fR -.ad -.RS 13n -NBS protocols -.RE - -.sp -.ne 2 -.na -\fB\fBecma\fR\fR -.ad -.RS 13n -European Computer Manufacturers Association -.RE - -.sp -.ne 2 -.na -\fB\fBdatakit\fR\fR -.ad -.RS 13n -DATAKIT protocols -.RE - -.sp -.ne 2 -.na -\fB\fBccitt\fR\fR -.ad -.RS 13n -CCITT protocols, X.25, and the like. -.RE - -.sp -.ne 2 -.na -\fB\fBsna\fR\fR -.ad -.RS 13n -IBM SNA -.RE - -.sp -.ne 2 -.na -\fB\fBdecnet\fR\fR -.ad -.RS 13n -DECNET -.RE - -.sp -.ne 2 -.na -\fB\fBdli\fR\fR -.ad -.RS 13n -Direct data link interface -.RE - -.sp -.ne 2 -.na -\fB\fBlat\fR\fR -.ad -.RS 13n -LAT -.RE - -.sp -.ne 2 -.na -\fB\fBhylink\fR\fR -.ad -.RS 13n -NSC Hyperchannel -.RE - -.sp -.ne 2 -.na -\fB\fBappletalk\fR\fR -.ad -.RS 13n -Apple Talk -.RE - -.sp -.ne 2 -.na -\fB\fBnit\fR\fR -.ad -.RS 13n -Network Interface Tap -.RE - -.sp -.ne 2 -.na -\fB\fBieee802\fR\fR -.ad -.RS 13n -IEEE 802.2; also ISO 8802 -.RE - -.sp -.ne 2 -.na -\fB\fBosi\fR\fR -.ad -.RS 13n -Umbrella for all families used by OSI (for example, protosw lookup) -.RE - -.sp -.ne 2 -.na -\fB\fBx25\fR\fR -.ad -.RS 13n -CCITT X.25 in particular -.RE - -.sp -.ne 2 -.na -\fB\fBosinet\fR\fR -.ad -.RS 13n -AFI = 47, IDI = 4 -.RE - -.sp -.ne 2 -.na -\fB\fBgosip\fR\fR -.ad -.RS 13n -U.S. Government OSI -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIprotocol name\fR\fR -.ad -.RS 25n -The \fIprotocol name\fR field contains a string that identifies a protocol. The -\fIprotocol name\fR identifier follows the same rules as those for \fInetwork -ID\fRs; that is, the string consists of non-NULL characters, it has a length of -at least \fB1\fR, and there is no maximum length specified. A ``\fB\(mi\fR\&'' -indicates that none of the names listed apply. The following protocol names are -recognized. -.sp -.ne 2 -.na -\fB\fBtcp\fR\fR -.ad -.RS 8n -Transmission Control Protocol -.RE - -.sp -.ne 2 -.na -\fB\fBudp\fR\fR -.ad -.RS 8n -User Datagram Protocol -.RE - -.sp -.ne 2 -.na -\fB\fBicmp\fR\fR -.ad -.RS 8n -Internet Control Message Protocol -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fInetwork device\fR\fR -.ad -.RS 25n -The \fInetwork device\fR is the full pathname of the device used to connect to -the transport provider. Typically, this device will be in the \fB/dev\fR -directory. The \fInetwork device\fR must be specified. -.RE - -.sp -.ne 2 -.na -\fB\fItranslation libraries\fR\fR -.ad -.RS 25n -The \fIname-to-address translation libraries\fR support a ``directory service'' -(a name-to-address mapping service) for the network. A ``\fB\(mi\fR\&'' in this -field indicates the absence of any \fItranslation libraries\fR. This has a -special meaning for networks of the protocol family \fBinet :\fR its -name-to-address mapping is provided by the name service switch based on the -entries for \fBhosts\fR and \fBservices\fR in \fBnsswitch.conf\fR(4). For -networks of other families, a ``\fB\(mi\fR\&'' indicates non-functional -name-to-address mapping. Otherwise, this field consists of a comma-separated -list of pathnames to dynamically linked libraries. The pathname of the library -can be either absolute or relative. See \fBdlopen\fR(3C). -.RE - -.sp -.LP -Each field corresponds to an element in the \fBstruct netconfig\fR structure. -\fBstruct netconfig\fR and the identifiers described on this manual page are -defined in <\fBnetconfig.h\fR>. This structure includes the following members: -.sp -.ne 2 -.na -\fB\fBchar *\fR\fInc_netid\fR\fR -.ad -.RS 30n -Network ID, including \fBNULL\fR terminator. -.RE - -.sp -.ne 2 -.na -\fB\fBunsigned long\fR \fInc_semantics\fR\fR -.ad -.RS 30n -Semantics. -.RE - -.sp -.ne 2 -.na -\fB\fBunsigned long\fR \fInc_flag\fR\fR -.ad -.RS 30n -Flags. -.RE - -.sp -.ne 2 -.na -\fB\fBchar *\fR\fInc_protofmly\fR\fR -.ad -.RS 30n -Protocol family. -.RE - -.sp -.ne 2 -.na -\fB\fBchar *\fR\fInc_proto\fR\fR -.ad -.RS 30n -Protocol name. -.RE - -.sp -.ne 2 -.na -\fB\fBchar *\fR\fInc_device\fR\fR -.ad -.RS 30n -Full pathname of the network device. -.RE - -.sp -.ne 2 -.na -\fB\fBunsigned long\fR \fInc_nlookups\fR\fR -.ad -.RS 30n -Number of directory lookup libraries. -.RE - -.sp -.ne 2 -.na -\fB\fBchar **\fR\fInc_lookups\fR\fR -.ad -.RS 30n -Names of the name-to-address translation libraries. -.RE - -.sp -.ne 2 -.na -\fB\fBunsigned long\fR \fInc_unused[9]\fR\fR -.ad -.RS 30n -Reserved for future expansion. -.RE - -.sp -.LP -The \fInc_semantics\fR field takes the following values, corresponding to the -semantics identified above: -.br -.in +2 -\fBNC_TPI_CLTS\fR -.in -2 -.br -.in +2 -\fBNC_TPI_COTS\fR -.in -2 -.br -.in +2 -\fBNC_TPI_COTS_ORD\fR -.in -2 -.sp -.LP -The \fInc_flag\fR field is a bitfield. The following bit, corresponding to the -attribute identified above, is currently recognized. \fBNC_NOFLAG\fR indicates -the absence of any attributes. -.sp -.in +2 -.nf -\fBNC_VISIBLE\fR -.fi -.in -2 - -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample \fBnetconfig\fR File -.sp -.LP -Below is a sample \fBnetconfig\fR file: - -.sp -.in +2 -.nf -# -# The "Network Configuration" File. -# -# Each entry is of the form: -# -# <networkid> <semantics> <flags> <protofamily> <protoname> <device> -# <nametoaddrlibs> -# -# The "-" in <nametoaddrlibs> for inet family transports indicates -# redirection to the name service switch policies for "hosts" and -# "services". The "-" may be replaced by nametoaddr libraries that -# comply with the SVr4 specs, in which case the name service switch -# will not be used for netdir_getbyname, netdir_getbyaddr, -# gethostbyname, gethostbyaddr, getservbyname, and getservbyport. -# There are no nametoaddr_libs for the inet family in Solaris anymore. -# -udp6 tpi_clts v inet6 udp /dev/udp6 - -tcp6 tpi_cots_ord v inet6 tcp /dev/tcp6 - -udp tpi_clts v inet udp /dev/udp - -tcp tpi_cots_ord v inet tcp /dev/tcp - -rawip tpi_raw - inet - /dev/rawip - -ticlts tpi_clts v loopback - /dev/ticlts straddr.so -ticotsord tpi_cots_ord v loopback - /dev/ticotsord straddr.so -ticots tpi_cots v loopback - /dev/ticots straddr.so -.fi -.in -2 - -.SH FILES -.sp -.ne 2 -.na -\fB<\fBnetconfig.h\fR>\fR -.ad -.RS 17n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBdlopen\fR(3C), \fBgetnetconfig\fR(3NSL), \fBgetnetpath\fR(3NSL), -\fBnsswitch.conf\fR(4) -.sp -.LP -\fISystem Administration Guide: IP Services\fR diff --git a/usr/src/man/man4/netgroup.4 b/usr/src/man/man4/netgroup.4 deleted file mode 100644 index b693d6a7be..0000000000 --- a/usr/src/man/man4/netgroup.4 +++ /dev/null @@ -1,158 +0,0 @@ -'\" te -.\" Copyright 2012 Nexenta Systems, Inc. All rights reserved. -.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved -.\" 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 NETGROUP 4 "Jun 17, 2021" -.SH NAME -netgroup \- list of network groups -.SH SYNOPSIS -.nf -\fB/etc/netgroup\fR -.fi -.SH DESCRIPTION -A \fBnetgroup\fR defines a network-wide group of hosts and users. Use a -\fBnetgroup\fR to restrict access to shared \fBNFS\fR filesystems and to -restrict remote login and shell access. -.sp -Network groups are usually stored in network information services, -such as \fBLDAP\fR, or \fBNIS\fR, but may alternatively be stored in -the local \fB/etc/netgroup\fR file. The \fBnetgroup\fR line of the -\fBnsswitch.conf\fR(4) file determines which of those sources are used. -.sp -This manual page describes the format for a file that is used to supply input -to a program such as \fBldapaddent\fR(1M) for LDAP, or \fBmakedbm\fR(1M) for -NIS. The same file format is used in the local \fB/etc/netgroup\fR file. -.sp -Each line of the file defines the name and membership of a network group. The -line should have the format: -.sp -.in +2 -.nf -\fIgroupname member\fR... -.fi -.in -2 -.sp -.sp -The items on a line can be separated by a combination of one or more spaces or -tabs. -.sp -The \fIgroupname\fR is the name of the group being defined. This is followed by -a list of members of the group. Each \fImember\fR is either another group name, -all of whose members are to be included in the group being defined, or a triple -of the form: -.sp -.in +2 -.nf -\fI(hostname,username,domainname)\fR -.fi -.in -2 -.sp -.sp -In each triple, any of the three fields \fIhostname\fR, \fIusername\fR, and -\fIdomainname\fR, can be empty. An empty field signifies a wildcard that -matches any value in that field. Thus: -.sp -.in +2 -.nf -everything (\|,\|,this.domain) -.fi -.in -2 -.sp -.sp -defines a group named "everything" for the domain "this.domain" to which every -host and user belongs. -.sp -The \fIdomainname\fR field refers to the domain in which the triple is valid, -not the domain containing the host or user. In fact, applications using -\fBnetgroup\fR generally do not check the \fIdomainname\fR. Therefore, using -.sp -.in +2 -.nf -(,,domain) -.fi -.in -2 -.sp -.sp -is equivalent to -.sp -.in +2 -.nf -(,,) -.fi -.in -2 -.sp -.sp -You can also use netgroups to control \fBNFS\fR mount access (see -\fBshare_nfs\fR(1M)) and to control remote login and shell access (see -\fBhosts.equiv\fR(4)). You can also use them to control local login access (see -\fBpasswd\fR(4), \fBshadow\fR(4), and \fBcompat\fR in \fBnsswitch.conf\fR(4)). -.sp -When used for these purposes, a host is considered a member of a \fBnetgroup\fR -if the \fBnetgroup\fR contains any triple in which the \fBhostname\fR field -matches the name of the host requesting access and the \fBdomainname\fR field -matches the domain of the host controlling access. -.sp -Similarly, a user is considered a member of a \fBnetgroup\fR if the -\fBnetgroup\fR contains any triple in which the \fIusername\fR field matches -the name of the \fBuser\fR requesting access and the \fIdomainname\fR field -matches the domain of the host controlling access. -.sp -Note that when netgroups are used to control NFS mount access, access is -granted depending only on whether the requesting host is a member of the -\fBnetgroup\fR. Remote login and shell access can be controlled both on the -basis of host and user membership in separate netgroups. -.SH FILES -.ne 2 -.na -\fB\fB/etc/netgroup\fR\fR -.ad -.RS 17n -Used by a network information service's utility to construct a map or table -that contains \fBnetgroup\fR information. For example, \fBldapaddent\fR(1M) -uses \fB/etc/netgroup\fR to construct an LDAP container. Alternatively, -the \fB/etc/netgroup\fR file may be used directly if the \fBfiles\fR -source is specified in \fBnsswitch.conf\fR(4) for the \fBnetgroup\fR -database. -.RE -.SH SEE ALSO -\fBldapaddent\fR(1M), \fBmakedbm\fR(1M), -\fBshare_nfs\fR(1M), \fBinnetgr\fR(3C), \fBhosts\fR(4), \fBhosts.equiv\fR(4), -\fBnsswitch.conf\fR(4), \fBpasswd\fR(4), \fBshadow\fR(4) -.SH NOTES -Applications may make general membership tests using the \fBinnetgr()\fR -function. See \fBinnetgr\fR(3C). -.sp -Because the "-" character will not match any specific username or hostname, it -is commonly used as a placeholder that will match only wildcarded membership -queries. So, for example: -.sp -.in +2 -.nf -onlyhosts (host1,-,our.domain) (host2,-,our.domain) -onlyusers (-,john,our.domain) (-,linda,our.domain) -.fi -.in -2 -.sp -.sp -effectively define netgroups containing only hosts and only users, -respectively. Any other string that is guaranteed not to be a legal username or -hostname will also suffice for this purpose. -.sp -Use of placeholders will improve search performance. -.sp -When a machine with multiple interfaces and multiple names is defined as a -member of a \fBnetgroup\fR, one must list all of the names. See \fBhosts\fR(4). -A manageable way to do this is to define a \fBnetgroup\fR containing all of the -machine names. For example, for a host "gateway" that has names -"gateway-subnet1" and "gateway-subnet2" one may define the \fBnetgroup\fR: -.sp -.in +2 -.nf -gateway (gateway-subnet1,\|,our.domain) (gateway-subnet2,\|,our.domain) -.fi -.in -2 -.sp -and use this \fBnetgroup\fR "\fBgateway\fR" whenever the host is to be included -in another \fBnetgroup\fR. diff --git a/usr/src/man/man4/netid.4 b/usr/src/man/man4/netid.4 deleted file mode 100644 index 7f52e76ca8..0000000000 --- a/usr/src/man/man4/netid.4 +++ /dev/null @@ -1,171 +0,0 @@ -'\" te -.\" Copyright (c) 1994, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 NETID 4 "November 22, 2021" -.SH NAME -netid \- netname database -.SH SYNOPSIS -.nf -\fB/etc/netid\fR -.fi - -.SH DESCRIPTION -The \fBnetid\fR file is a local source of information on mappings between -netnames (see \fBsecure_rpc\fR(3NSL)) and user ids or hostnames in the local -domain. The \fBnetid\fR file can be used in conjunction with, or instead of, -a network nameservice. The \fBpublickey\fR entry in -the \fBnsswitch.conf\fR (see \fBnsswitch.conf\fR(4)) file determines which of -these sources will be queried by the system to translate netnames to local user -ids or hostnames. -.sp -.LP -Each entry in the \fBnetid\fR file is a single line of the form: -.sp -.in +2 -.nf -\fInetname uid\fR\fB:\fR\fIgid, gid, gid\|.\|.\|.\fR -.fi -.in -2 -.sp - -.sp -.LP -or -.sp -.in +2 -.nf -\fInetname\fR \fB 0:\fR\fBhostname\fR -.fi -.in -2 -.sp - -.sp -.LP -The first entry associates a local user id with a netname. The second entry -associates a hostname with a netname. -.sp -.LP -The \fBnetid\fR file field descriptions are as follows: -.sp -.ne 2 -.na -\fB\fInetname\fR\fR -.ad -.RS 12n -The operating system independent network name for the user or host. -\fInetname\fR has one of two formats. The format used to specify a host is of -the form: -.sp -\fBunix.\fR\fBhostname\fR\fB@\fR\fIdomain\fR -.sp -where \fBhostname\fR is the name of the host and \fIdomain\fR is the network -domain name. -.sp -The format used to specify a user id is of the form: -.sp -\fBunix.\fR\fIuid\fR\fB@\fR\fIdomain\fR -.sp -where \fIuid\fR is the numerical id of the user and \fIdomain\fR is the network -domain name. -.RE - -.sp -.ne 2 -.na -\fB\fIuid\fR\fR -.ad -.RS 12n -The numerical id of the user (see \fBpasswd\fR(4)). When specifying a host -name, \fIuid\fR is always zero. -.RE - -.sp -.ne 2 -.na -\fB\fIgroup\fR\fR -.ad -.RS 12n -The numerical id of the group the user belongs to (see \fBgroup\fR(4)). -Several groups, separated by commas, may be listed for a single \fIuid\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBhostname\fR\fR -.ad -.RS 12n -The local hostname (see \fBhosts\fR(4)). -.RE - -.sp -.LP -Blank lines are ignored. Any part of a line to the right of a `\fB#\fR' symbol -is treated as a comment. -.SH EXAMPLES -\fBExample 1 \fRA sample \fBnetid\fR file. -.sp -.LP -Here is a sample \fBnetid\fR file: - -.sp -.in +2 -.nf -unix.789@West.Example.COM 789:30,65 -unix.123@Bldg_xy.Example.COM 123:20,1521 -unix.candlestick@campus1.example.NET 0:candlestick -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/etc/group\fR\fR -.ad -.RS 18n -groups file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/hosts\fR\fR -.ad -.RS 18n -hosts database -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/netid\fR\fR -.ad -.RS 18n -netname database -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/passwd\fR\fR -.ad -.RS 18n -password file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/publickey\fR\fR -.ad -.RS 18n -public key database -.RE - -.SH SEE ALSO -\fBnetname2user\fR(3NSL), \fBsecure_rpc\fR(3NSL), \fBgroup\fR(4), -\fBhosts\fR(4), \fBnsswitch.conf\fR(4), \fBpasswd\fR(4), \fBpublickey\fR(4) diff --git a/usr/src/man/man4/netmasks.4 b/usr/src/man/man4/netmasks.4 deleted file mode 100644 index 2d52182c3e..0000000000 --- a/usr/src/man/man4/netmasks.4 +++ /dev/null @@ -1,133 +0,0 @@ -'\" te -.\" Copyright 1996 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 NETMASKS 4 "Jan 7, 1997" -.SH NAME -netmasks \- network mask database -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/netmasks\fR -.fi - -.LP -.nf -\fB/etc/netmasks\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBnetmasks\fR file contains network masks used to implement \fBIP\fR -subnetting. It supports both standard subnetting as specified in \fIRFC-950\fR -and variable length subnetting as specified in \fIRFC-1519\fR. When using -standard subnetting there should be a single line for each network that is -subnetted in this file with the network number, any number of \fBSPACE\fR or -\fBTAB\fR characters, and the network mask to use on that network. Network -numbers and masks may be specified in the conventional \fBIP\fR `.' (dot) -notation (like \fBIP\fR host addresses, but with zeroes for the host part). -For example, -.sp -.ne 2 -.na -\fB\fR -.ad -.sp .6 -.RS 4n -.sp -.in +2 -.nf -128.32.0.0 255.255.255.0 -.fi -.in -2 -.sp - -.RE - -.sp -.LP -can be used to specify that the Class B network 128.32.0.0 should have eight -bits of subnet field and eight bits of host field, in addition to the standard -sixteen bits in the network field. -.sp -.LP -When using variable length subnetting, the format is identical. However, there -should be a line for each subnet with the first field being the subnet and the -second field being the netmask that applies to that subnet. The users of the -database, such as \fBifconfig\fR(1M), perform a lookup to find the longest -possible matching mask. It is possible to combine the \fIRFC-950\fR and -\fIRFC-1519\fR form of subnet masks in the netmasks file. For example, -.sp -.ne 2 -.na -\fB\fR -.ad -.sp .6 -.RS 4n -.sp -.in +2 -.nf -128.32.0.0 255.255.255.0 -128.32.27.0 255.255.255.240 -128.32.27.16 255.255.255.240 -128.32.27.32 255.255.255.240 -128.32.27.48 255.255.255.240 -128.32.27.64 255.255.255.240 -128.32.27.80 255.255.255.240 -128.32.27.96 255.255.255.240 -128.32.27.112 255.255.255.240 -128.32.27.128 255.255.255.240 -128.32.27.144 255.255.255.240 -128.32.27.160 255.255.255.240 -128.32.27.176 255.255.255.240 -128.32.27.192 255.255.255.240 -128.32.27.208 255.255.255.240 -128.32.27.224 255.255.255.240 -128.32.27.240 255.255.255.240 -128.32.64.0 255.255.255.192 -.fi -.in -2 -.sp - -.RE - -.sp -.LP -can be used to specify different netmasks in different parts of the 128.32.0.0 -Class B network number. Addresses 128.32.27.0 through 128.32.27.255 have a -subnet mask with 28 bits in the combined network and subnet fields (often -referred to as the subnet field) and 4 bits in the host field. Furthermore, -addresses 128.32.64.0 through 128.32.64.63 have a 26 bits in the subnet field. -Finally, all other addresses in the range 128.32.0.0 through 128.32.255.255 -have a 24 bit subnet field. -.sp -.LP -Invalid entries are ignored. -.SH SEE ALSO -.sp -.LP -\fBifconfig\fR(1M), \fBinet\fR(7P) -.sp -.LP -Postel, Jon, and Mogul, Jeff, \fIInternet Standard Subnetting Procedure\fR, -\fBRFC\fR 950, Network Information Center, \fBSRI\fR International, Menlo Park, -Calif., August 1985. -.sp -.LP -V. Fuller, T. Li, J. Yu, K. Varadhan, \fIClassless Inter-Domain Routing -(CIDR): an Address Assignment and Aggregation Strategy\fR, \fBRFC\fR 1519, -Network Information Center, \fBSRI\fR International, Menlo Park, Calif., -September 1993. -.sp -.LP -T. Pummill, B. Manning, \fIVariable Length Subnet Table For IPv4\fR, \fBRFC\fR -1878, Network Information Center, \fBSRI\fR International, Menlo Park, Calif., -December 1995. -.SH NOTES -.sp -.LP -\fB/etc/inet/netmasks\fR is the official SVr4 name of the \fBnetmasks\fR file. -The symbolic link \fB/etc/netmasks\fR exists for \fBBSD\fR compatibility. diff --git a/usr/src/man/man4/netrc.4 b/usr/src/man/man4/netrc.4 deleted file mode 100644 index 3098daf61f..0000000000 --- a/usr/src/man/man4/netrc.4 +++ /dev/null @@ -1,148 +0,0 @@ -'\" te -.\" Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 NETRC 4 "Aug 25, 2006" -.SH NAME -netrc \- file for ftp remote login data -.SH DESCRIPTION -.LP -The \fB\&.netrc\fR file contains data for logging in to a remote host over the -network for file transfers by \fBftp\fR(1). This file resides in the user's -home directory on the machine initiating the file transfer. Its permissions -should be set to disallow read access by group and others. See \fBchmod\fR(1). -.sp -.LP -Tokens can be separated by \fBSPACE\fR, \fBTAB\fR, or \fBNEWLINE\fR characters. -The following tokens are supported: -.sp -.ne 2 -.na -\fB\fBaccount\fR \fIstring\fR\fR -.ad -.RS 19n -Supply an additional account password. If this token is present, the auto-login -process supplies the specified string if the remote server requires an -additional account password. If the remote server does not require an -additional account password, the auto-login process initiates an \fBACCT\fR -command. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault\fR\fR -.ad -.RS 19n -Same as \fBmachine\fR \fIname\fR, except that default matches any name. There -can be only one \fBdefault\fR token, and it must be after all \fBmachine\fR -tokens. The \fBdefault\fR token is normally used as follows: -.sp -.in +2 -.nf -default login anonymous password \fIuser\fR@\fIsite\fR -.fi -.in -2 -.sp - -Such an entry gives the user automatic anonymous \fBftp\fR login to machines -not specified in \fB\&.netrc\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBlogin\fR \fIname\fR\fR -.ad -.RS 19n -Identify a user on the remote machine. If this token is present, the auto-login -process initiates a login using the specified name. -.RE - -.sp -.ne 2 -.na -\fB\fBmachine\fR \fIname\fR\fR -.ad -.RS 19n -Identify a remote machine name. The auto-login process searches the -\fB\&.netrc\fR file for a \fBmachine\fR token that matches the remote machine -specified on the \fBftp\fR command line or as an \fBopen\fR command argument. -Once a match is made, the subsequent \fB\&.netrc\fR tokens are processed, -stopping when the \fBEOF\fR is reached or another \fBmachine\fR token is -encountered. -.RE - -.sp -.ne 2 -.na -\fB\fBmacdef\fR \fIname\fR\fR -.ad -.RS 19n -Define a macro. This token functions the same as \fBftp\fR \fBmacdef\fR. A -macro is defined with the specified name; its contents begin with the next -\fB\&.netrc\fR line and continue until a null line (consecutive \fBNEWLINE\fR -characters) is encountered. If a macro named \fBinit\fR is defined, it is -automatically executed as the last step in the auto-login process. -.RE - -.sp -.ne 2 -.na -\fB\fBpassword\fR \fIstring\fR\fR -.ad -.RS 19n -Supply a password. If this token is present, the auto-login process supplies -the specified string if the remote server requires a password as part of the -login process. If this token is present in the \fB\&.netrc\fR file, \fBftp\fR -aborts the auto-login process if the \fB\&.netrc\fR is readable by anyone -besides the user. -.RE - -.sp -.ne 2 -.na -\fB\fBskipsyst\fR\fR -.ad -.RS 19n -Skip the \fBSYST\fR command that is sent by default to all remote servers upon -connection. The system command is what enables the automatic use of binary mode -rather than the protocol default ascii mode. -.sp -As some older servers cannot handle the \fBftp\fR command, this directive is -provided to allow inter-operability with these servers. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample \fB\&.netrc\fR File -.sp -.LP -A \fB\&.netrc\fR file containing the following line: - -.sp -.in +2 -.nf -machine ray login demo password mypassword -.fi -.in -2 - -.sp -.LP -allows an autologin to the machine \fBray\fR using the login name \fBdemo\fR -with password \fBmypassword\fR. - -.SH FILES -.ne 2 -.na -\fB\fB~/.netrc\fR\fR -.ad -.RS 12n - -.RE - -.SH SEE ALSO -.LP -\fBchmod\fR(1), \fBftp\fR(1) diff --git a/usr/src/man/man4/networks.4 b/usr/src/man/man4/networks.4 deleted file mode 100644 index 2ffa0390cb..0000000000 --- a/usr/src/man/man4/networks.4 +++ /dev/null @@ -1,71 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 NETWORKS 4 "Feb 25, 2017" -.SH NAME -networks \- network name database -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/networks\fR -.fi - -.LP -.nf -\fB/etc/networks\fR -.fi - -.SH DESCRIPTION -.LP -The \fBnetworks\fR file is a local source of information regarding the networks -which comprise the Internet. The networks file can be used in conjunction -with, or instead of, other networks sources, including the NIS maps -\fBnetworks.byname\fR and \fBnetworks.byaddr\fR. -Programs use the \fBgetnetbyname\fR(3SOCKET) routines to access -this information. -.sp -.LP -The network file has a single line for each network, with the following -information: -.sp -.in +2 -.nf -\fIofficial-network-name network-number aliases\fR -.fi -.in -2 - -.sp -.LP -Items are separated by any number of \fBSPACE\fR or \fBTAB\fR characters. A -`\fB#\fR' indicates the beginning of a comment. Characters up to the end of the -line are not interpreted by routines which search the file. This file is -normally created from the official network database maintained at the Network -Information Control Center (NIC), though local changes may be required to bring -it up to date regarding unofficial aliases and/or unknown networks. -.sp -.LP -Network numbers may be specified in the conventional dot (`\fB\&.\fR') notation -using the \fBinet_network\fR routine from the Internet address manipulation -library, \fBinet\fR(7P). Network names may contain any printable character -other than a field delimiter, \fBNEWLINE\fR, or comment character. -.SH SEE ALSO -.LP -\fBgetnetbyaddr\fR(3SOCKET), \fBgetnetbyname\fR(3SOCKET), \fBinet\fR(3SOCKET), -\fBnsswitch.conf\fR(4), \fBinet\fR(7P) -.SH NOTES -.LP -The official SVR4 name of the \fBnetworks\fR file is \fB/etc/inet/networks\fR. -The symbolic link \fB/etc/networks\fR exists for \fBBSD\fR compatibility. -.sp -.LP -The network number in \fBnetworks\fR database is the host address shifted to -the right by the number of 0 bits in the address mask. For example, for the -address \fB24.132.47.86\fR that has a mask of \fBfffffe00\fR, its network -number is \fB803351\fR. This is obtained when the address is shifted right by 9 -bits. The address maps to \fB12.66.23\fR. The trailing 0 bits should not be -specified. The network number here is different from that described in -\fBnetmasks\fR(4). For this example, the entry in \fBnetmasks\fR would be -\fB24.132.46.0 fffffe00\fR. diff --git a/usr/src/man/man4/nfs.4 b/usr/src/man/man4/nfs.4 deleted file mode 100644 index 6979f5f485..0000000000 --- a/usr/src/man/man4/nfs.4 +++ /dev/null @@ -1,319 +0,0 @@ -.\" -.\" 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] -.\" -.\" -.\" Copyright 1989 AT&T -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2016 Nexenta Systems, Inc. -.\" Copyright 2020 Joyent, Inc. -.\" -.Dd November 22, 2021 -.Dt NFS 4 -.Os -.Sh NAME -.Nm nfs -.Nd NFS configuration properties -.Sh DESCRIPTION -The behavior of the -.Xr nfsd 1M , -.Xr nfsmapid 1M , -.Xr lockd 1M , -and -.Xr mountd 1M -daemons and -.Xr mount_nfs 1M -command is controlled by property values that are stored in the Service -Management Facility, smf(5). -The -.Xr sharectl 1M -command should be used to query or change values for these properties. -.Pp -Changes made to -.Nm -property values on the -.Nm nfsd , -.Nm lockd , -.Nm mountd , -or -.Nm mount_nfs -command line override the values set using -.Xr sharectl 1M . -.Pp -The following list describes the properties: -.Bl -tag -width Ds -.It Xo -.Sy client_versmin Ns = Ns Ar num -.br -.Sy client_versmax Ns = Ns Ar num -.Xc -The NFS client only uses NFS versions in the range specified by these -properties. -Valid values of versions are: 2, 3, and 4. -Default minimum version is -.Li 2 , -while default maximum is -.Li 4 . -.Pp -You can override this range on a per-mount basis by using the -.Fl o Sy vers Ns = -option to -.Xr mount_nfs 1M . -.It Xo -.Sy server_versmin Ns = Ns Ar num -.br -.Sy server_versmax Ns = Ns Ar num -.Xc -The NFS server only uses NFS versions in the range specified by these -properties. -Valid values of versions are: 2, 3, and 4. -Default minimum version is -.Li 2 , -while the default maximum version is -.Li 4 . -.It Sy server_delegation Ns = Ns Sy on Ns | Ns Sy off -By default the NFS server provides delegations to clients. -The user can turn off delegations for all exported filesystems by setting this -variable to -.Li off . -This variable only applies to NFS Version 4. -.It Sy nfsmapid_domain Ns = Ns Op Ar string -By default, the -.Nm nfsmapid -uses the DNS domain of the system. -This setting overrides the default. -This domain is used for identifying user and group attribute strings in the NFS -Version 4 protocol. -Clients and servers must match with this domain for operation to proceed -normally. -This variable only applies to NFS Version 4. -See -.Sx Setting nfsmapid_domain -below for further details. -.It Sy max_connections Ns = Ns Ar num -Sets the maximum number of concurrent, connection-oriented connections. -The default is -.Li -1 -.Pq unlimited . -Equivalent to the -.Fl c -option in -.Nm nfsd . -.It Sy listen_backlog Ns = Ns Ar num -Set connection queue length for the NFS over a connection-oriented transport. -The default value is -.Li 32 , -meaning 32 entries in the queue. -Equivalent to the -.Fl l -option in -.Nm nfsd . -.It Sy protocol Ns = Ns Op Sy all Ns | Ns Ar protocol -Start -.Nm nfsd -over the specified protocol only. -Equivalent to the -.Fl p -option in -.Nm nfsd . -.Sy all -is equivalent to -.Fl a -on the -.Nm nfsd -command line. -Mutually exclusive of -.Sy device . -For the UDP protocol, only version 2 and version 3 service is established. -NFS Version 4 is not supported for the UDP protocol. -.It Sy device Ns = Ns Op Ar devname -Start NFS daemon for the transport specified by the given device only. -Equivalent to the -.Fl t -option in -.Nm nfsd . -Mutually exclusive of -.Sy protocol . -.It Sy servers Ns = Ns Ar num -Maximum number of concurrent NFS requests. -Equivalent to last numeric argument on the -.Nm nfsd -command line. -The default is -.Li 1024 . -.It Sy lockd_listen_backlog Ns = Ns Ar num -Set connection queue length for -.Nm lockd -over a connection-oriented transport. -The default and minimum value is -.Li 32 . -.It Sy lockd_servers Ns = Ns Ar num -Maximum number of concurrent -.Nm lockd -requests. -The default is 256. -.It Sy lockd_retransmit_timeout Ns = Ns Ar num -Retransmit timeout, in seconds, before -.Nm lockd -retries. -The default is -.Li 5 . -.It Sy grace_period Ns = Ns Ar num -Grace period, in seconds, that all clients -.Pq both NLM and NFSv4 -have to reclaim locks after a server reboot. -This parameter also controls the NFSv4 lease interval. -The default is -.Li 90 . -.It Sy mountd_listen_backlog Ns = Ns Ar num -Set the connection queue length for -.Nm mountd -over a connection-oriented transport. -The default value is -.Li 64 . -.It Sy mountd_max_threads Ns = Ns Ar num -Maximum number of threads for -.Nm mountd . -The default value is -.Li 16 . -.It Sy mountd_port Ns = Ns Ar num -The IP port number on which -.Nm mountd -should listen. -The default value is -.Li 0 , -which means it should use a default binding. -.It Sy statd_port Ns = Ns Ar num -The IP port number on which -.Nm statd -should listen. -The default value is -.Li 0 , -which means it should use a default binding. -.El -.Ss Setting nfsmapid_domain -As described above, the setting for -.Sy nfsmapid_domain -overrides the domain used by -.Xr nfsmapid 1M -for building and comparing outbound and inbound attribute strings, respectively. -This setting overrides any other mechanism for setting the NFSv4 domain. -In the absence of a -.Sy nfsmapid_domain -setting, the -.Xr nfsmapid 1M -daemon determines the NFSv4 domain as follows: -.Bl -bullet -.It -If a properly configured -.Pa /etc/resolv.conf -.Po see -.Xr resolv.conf 4 -.Pc -exists, -.Nm nfsmapid -queries specified nameserver(s) for the domain. -.It -If a properly configured -.Pa /etc/resolv.conf -.Po see -.Xr resolv.conf 4 -.Pc -exists, but the queried nameserver does not have a proper record of the domain -name, -.Nm nfsmapid -attempts to obtain the domain name through the BIND interface -.Po see -.Xr resolver 3RESOLV -.Pc . -.It -If no -.Pa /etc/resolv.conf -exists, -.Nm nfsmapid -falls back on using the configured domain name -.Po see -.Xr domainname 1M -.Pc , -which is returned with the leading domain suffix removed. -For example, for -.Li widgets.sales.example.com , -.Li sales.example.com -is returned. -.It -If -.Pa /etc/resolv.conf -does not exist, no domain name has been configured -.Po or no -.Pa /etc/defaultdomain -exists -.Pc , -.Nm nfsmapid -falls back on obtaining the domain name from the host name, if the host name -contains a fully qualified domain name -.Pq FQDN . -.El -.Pp -If a domainname is still not obtained following all of the preceding steps, -.Nm nfsmapid -will have no domain configured. -This results in the following behavior: -.Bl -bullet -.It -Outbound -.Qq owner -and -.Qq owner_group -attribute strings are encoded as literal id's. -For example, the UID 12345 is encoded as -.Li 12345 . -.It -.Nm nfsmapid -ignores the -.Qq domain -portion of the inbound attribute string and performs name service lookups only -for the user or group. -If the user/group exists in the local system name service databases, then the -proper uid/gid will be mapped even when no domain has been configured. -.Pp -This behavior implies that the same administrative user/group domain exists -between NFSv4 client and server (that is, the same uid/gid's for users/groups -on both client and server). -In the case of overlapping id spaces, the inbound attribute string could -potentially be mapped to the wrong id. -However, this is not functionally different from mapping the inbound string to -.Sy nobody , -yet provides greater flexibility. -.El -.Sh ZONES -NFS can be served out of a non-global zone. -All of the above documentation applies to an in-zone NFS server. -File sharing in zones is restricted to filesystems a zone completely controls. -Some zone brands (see -.Xr brands 5 ) -do not give the zone's root its own filesystem, for example. -Delegated ZFS datasets to a zone are shareable, as well as lofs-remounted -directories. -The zone must have sys_nfs privileges; most brands grant this already. -.Sh SEE ALSO -.Xr lockd 1M , -.Xr mount_nfs 1M , -.Xr mountd 1M , -.Xr nfsd 1M , -.Xr nfsmapid 1M , -.Xr sharectl 1M , -.Xr brands 5 , -.Xr smf 5 , -.Xr zones 5 diff --git a/usr/src/man/man4/nfslog.conf.4 b/usr/src/man/man4/nfslog.conf.4 deleted file mode 100644 index a035a70a04..0000000000 --- a/usr/src/man/man4/nfslog.conf.4 +++ /dev/null @@ -1,178 +0,0 @@ -'\" te -.\" Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 NFSLOG.CONF 4 "Dec 2, 2004" -.SH NAME -nfslog.conf \- NFS server logging configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/nfs/nfslog.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBnfslog.conf\fR file specifies the location of the \fBNFS\fR server logs, -as well as the location of the private work files used by the \fBNFS\fR server -and \fBnfslogd\fR(1M) daemon during logging. Each entry in the file consists of -a mandatory tag identifier and one or more parameter identifiers. The parameter -identifier specifies the value or location of the specific parameter. For -instance, the parameter identifier "\fBlog=/var/nfs/logs/serverLog\fR" -specifies the location of the \fBNFS\fR server activity log. The mandatory tag -identifier serves as an index into the \fB/etc/nfs/nfslog.conf\fR file to -identify the various parameters to be used. At export time, the -\fBshare_nfs\fR(1M) command specifies the \fBNFS\fR server logging parameters -to use by associating a tag from the \fB/etc/nfs/nfslog.conf\fR file to the -exported file system. It is legal for more than one file system to be exported -using the same logging tag identifier. -.sp -.LP -NFS server logging is not supported on Solaris machines that are using NFS -Version 4. -.sp -.LP -A "global" tag identifier is included in \fB/etc/nfs/nfslog.conf\fR. It -specifies the default set of values to be used during logging. If no tag -identifier is specified at export time, then the values in the "global" entry -are used. The "global" values can be modified by updating this entry in -\fB/etc/nfs/nfslog.conf\fR. -.sp -.LP -Each entry in the file must contain a mandatory tag identifier and at least one -parameter/value pair. If a parameter is not specified in a given entry, the -global value of the parameter will be used. The exact entry syntax follows: -.sp -.in +2 -.nf -<tag> [defaultdir=<path>] [log=<path><file>] \e -[fhtable=<path><file>] [buffer=<path><file>] [logformat=basic|extended] -.fi -.in -2 - -.sp -.ne 2 -.na -\fB\fBdefaultdir=\fI<path>\fR\fR\fR -.ad -.RS 28n -Specifies the directory where the logging files and working files will be -placed. This path is prepended to all relative paths specified in other -parameters. -.RE - -.sp -.ne 2 -.na -\fB\fBlog=\fI<path>\fR\fI<file>\fR\fR\fR -.ad -.RS 28n -Specifies the location of the user-readable log file. The log will be located -in the \fBdefaultdir\fR, unless \fB<path>\fR is an absolute path. -.RE - -.sp -.ne 2 -.na -\fB\fBfhtable=\fI<path>\fR\fI<file>\fR\fR\fR -.ad -.RS 28n -Specifies the location of the private file handle to path mapping database -files. These database files are for the private use of the \fBNFS\fR server -kernel module and the \fBnfslog\fRd daemon. These files will be located in the -\fBdefaultdir\fR, unless \fB<path>\fR is an absolute path. These database files -are permanently stored in the file system. Consult \fBnfslogd\fR(1M) for -information on pruning the database files. -.RE - -.sp -.ne 2 -.na -\fB\fBbuffer=\fI<path>\fR\fI<file>\fR\fR\fR -.ad -.RS 28n -Specifies the location of the private work buffer file used by the \fBNFS\fR -server kernel module to record raw \fBRPC\fR information. This file is later -processed by the \fBnfslog\fR daemon, which in turn generates the user-readable -log file. This work buffer file will be located in the \fBdefaultdir\fR, unless -\fB<path>\fR is an absolute path. -.RE - -.sp -.ne 2 -.na -\fB\fBlogformat=basic|extended\fR\fR -.ad -.RS 28n -Sets the format of the user-readable log file. If not specified, the basic -format is used. The basic format is compatible with log files generated by the -Washington University \fBFTPd\fR. The extended format provides a more detailed -log, which includes directory modification operations not included in the basic -format, such as \fBmkdir\fR, \fBrmdir\fR and \fBremove\fR. Note that the -extended format is not compatible with Washington University's \fBFTPd\fR log -format. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRUsing the \fBglobal\fR Tag -.sp -.LP -The "global" tag may be modified so that all exported file systems that enabled -logging use a common set of parameters that conform to the specific needs of -the user. These values are used until a specific tag identifier overrides them. - -.sp -.in +2 -.nf -global defaultdir=/var/nfs log=logs/nfslog \e - fhtable=tables/fhtable buffer=buffers/nfslog_workbuffer \e - logformat=basic -.fi -.in -2 - -.LP -\fBExample 2 \fROverriding the Global \fBdefaultdir\fR and \fBlogformat\fR -.sp -.LP -Because log files can become very large, it may be desirable to store the logs -and working files in separate file systems. This can be easily accomplished by -simply specifying a different \fBdefaultdir\fR for every file system exported -by means of a unique tag: - -.sp -.in +2 -.nf -engineering defaultdir=/engineering/logging \e - logformat=extended -accounting defaultdir=/accounting/logging -marketing defaultdir=/marketing/logging -.fi -.in -2 - -.sp -.LP -File systems shared with the engineering identifier will have their logs and -workfiles located in \fB/engineering/logging\fR. For instance, the log file -will be located at \fB/engineering/logging/logs/nfslog\fR. Note that the -engineering log file will be stored in the extended format, while the rest of -the log files will remain in the basic format. - -.sp -.LP -Any of the parameters can be updated in a tag identifier, which overrides the -global settings. - -.SH SEE ALSO -.sp -.LP -\fBnfslogd\fR(1M), \fBshare_nfs\fR(1M), \fBattributes\fR(5) -.SH NOTES -.sp -.LP -Logs, work files, and file handle to path mapping database can become very -large. Be aware of appropriate placement within the file system name space. See -\fBnfslogd\fR(1M)) for information on pruning the database files and cycling -logs. diff --git a/usr/src/man/man4/nfssec.conf.4 b/usr/src/man/man4/nfssec.conf.4 deleted file mode 100644 index 1c38aa2827..0000000000 --- a/usr/src/man/man4/nfssec.conf.4 +++ /dev/null @@ -1,26 +0,0 @@ -'\" te -.\" Copyright (c) 2001 Sun Microsystems, Inc. All rights reserved. -.\" 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 NFSSEC.CONF 4 "Nov 12, 2001" -.SH NAME -nfssec.conf \- list NFS security modes -.SH SYNOPSIS -.LP -.nf -\fB/etc/nfssec.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBnfssec.conf\fR file lists the NFS security modes supported on a system. -These modes are defined in \fBnfssec\fR(5). -.sp -.LP -The \fBnfssec.conf\fR file should not be edited by a user. -.SH SEE ALSO -.sp -.LP -\fBnfssec\fR(5) diff --git a/usr/src/man/man4/nodename.4 b/usr/src/man/man4/nodename.4 deleted file mode 100644 index 6ebc66667f..0000000000 --- a/usr/src/man/man4/nodename.4 +++ /dev/null @@ -1,64 +0,0 @@ -'\" te -.\" Copyright 2015 Nexenta Systems, Inc. All rights reserved. -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 NODENAME 4 "Feb 25, 2017" -.SH NAME -nodename \- local source for system name -.SH SYNOPSIS -.LP -.nf -\fB/etc/nodename\fR -.fi - -.SH DESCRIPTION -.LP -When a machine is standalone or its IP address is configured locally, the -\fB/etc/nodename\fR file contains the system name. By convention, the system -name is the same as the hostname associated with the IP address of the primary -network interface, for example, \fBhostname.hme0\fR. -.sp -.LP -If the machine's network configuration is delivered by the RPC bootparams -protocol, the \fB/etc/nodename\fR file is not used, as the system name is -delivered by the remote service. -.sp -.LP -If the machine's network configuration is delivered by the DHCP protocol, the -\fB/etc/nodename\fR file is used only if the DHCP server does not provide a -value for the Hostname option (DHCP standard option code 12). -.sp -.LP -A system name configured in \fB/etc/nodename\fR should be unique within the -system's name service domain in order to ensure that any network services -provided by the system will operate correctly. -.sp -.LP -Given a system name value, regardless of source, the \fBuname\fR utility -invoked with the \fB-S\fR option is used to set the system name of the running -system. -.SH EXAMPLES -.LP -\fBExample 1 \fRSyntax -.sp -.LP -The syntax for \fBnodename\fR consists of a single line containing the system's -name. For example, for a system named \fBmyhost\fR: - -.sp -.in +2 -.nf -myhost -.fi -.in -2 - -.SH SEE ALSO -.LP -\fBuname\fR(1), \fBnamed\fR(1M), \fBypbind\fR(1M), -\fBattributes\fR(5) -.SH NOTES -.LP -The \fBnodename\fR file is modified by Solaris installation and de-installation -scripts. diff --git a/usr/src/man/man4/nologin.4 b/usr/src/man/man4/nologin.4 deleted file mode 100644 index f6be44ea40..0000000000 --- a/usr/src/man/man4/nologin.4 +++ /dev/null @@ -1,40 +0,0 @@ -'\" te -.\" Copyright (c) 1995 Sun Microsystems, Inc. All Rights Reserved. -.\" 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 NOLOGIN 4 "Dec 21, 1995" -.SH NAME -nologin \- message displayed to users attempting to log on in the process of a -system shutdown -.SH SYNOPSIS -.LP -.nf -\fB/etc/nologin\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/etc/nologin\fR file contains the message displayed to users attempting -to log on to a machine in the process of being shutdown. After displaying the -contents of the \fBnologin\fR file, the \fBlogin\fR procedure terminates, -preventing the user from logging onto the machine. -.sp -.LP -This procedure is preferable to terminating a user's session by -\fBshutdown\fR shortly after the user has logged on. -.sp -.LP -Logins by super-user are not affected by this procedure. -.sp -.LP -The message contained in the \fBnologin\fR file is editable by super-user. A -typical \fBnologin\fR file contains a message similar to: -.sp -.LP -\fBNO LOGINS: System going down in 10 minutes.\fR -.SH SEE ALSO -.sp -.LP -\fBlogin\fR(1), \fBrlogin\fR(1), \fBtelnet\fR(1), \fBshutdown\fR(1M) diff --git a/usr/src/man/man4/note.4 b/usr/src/man/man4/note.4 deleted file mode 100644 index 7c241154a2..0000000000 --- a/usr/src/man/man4/note.4 +++ /dev/null @@ -1,79 +0,0 @@ -'\" te -.\" Copyright (c) 1995, Sun Microsystems, Inc. -.\" 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 NOTE 4 "Jan 17, 1995" -.SH NAME -note \- specify legal annotations -.SH SYNOPSIS -.LP -.nf -\fB/usr/lib/note\fR -.fi - -.SH DESCRIPTION -.sp -.LP -Each file in this directory contains the \fBNOTE\fR (also \fB_NOTE\fR) -annotations legal for a single tool. The name of the file, by convention, -should be the tool vendor's stock name, followed by a hyphen, followed by the -tool name. For example, for Sun's \fBlock_lint\fR tool the filename should be -\fBSUNW-lock_lint\fR. -.sp -.LP -The file should contain the names of the annotations understood by the tool, -one per line. For example, if a tool understands the following annotations: -.sp -.in +2 -.nf -NOTE(NOT_REACHED) -NOTE(MUTEX_PROTECTS_DATA(list_lock, list_head)) -.fi -.in -2 -.sp - -.sp -.LP -then its file in \fB/usr/lib/note\fR should contain the entries: -.sp -.in +2 -.nf -\fBNOT_REACHED -MUTEX_PROTECTS_DATA\fR -.fi -.in -2 -.sp - -.sp -.LP -Blank lines, and lines beginning with a pound (#), are ignored. -.sp -.LP -While \fB/usr/lib/note\fR is the default directory tools search for such files, -they can be made to search other directories instead simply by setting -environment variable \fBNOTE\fR\fBPATH\fR to contain the paths, separated by -colons, of directories to be searched, e.g., -\fB/usr/mytool/note:/usr/lib/note\fR. -.SH USAGE -.sp -.LP -These files are used by such tools whenever they encounter \fBNOTE\fRs they do -not understand. If a file in \fB/usr/lib/note\fR contains the annotation, then -it is valid. If no such file contains the annotation, then the tool should -issue a warning complaining that it might be invalid. -.SH ENVIRONMENT VARIABLES -.sp -.ne 2 -.na -\fB\fBNOTE\fR\fBPATH\fR\fR -.ad -.RS 12n -specify paths to be searched for annotation files. Paths are separated by -colons (":"). -.RE - -.SH SEE ALSO -.sp -.LP -\fBNOTE\fR(3EXT) diff --git a/usr/src/man/man4/notrouter.4 b/usr/src/man/man4/notrouter.4 deleted file mode 100644 index 4fc79a35e0..0000000000 --- a/usr/src/man/man4/notrouter.4 +++ /dev/null @@ -1,24 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 NOTROUTER 4 "Sep 10, 2004" -.SH NAME -notrouter \- flag to turn off IPv4 routing -.SH SYNOPSIS -.LP -.nf -\fB/etc/notrouter\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/etc/notrouter\fR file is no longer used as of the current release of -the Solaris operating system. IPv4 forwarding is disabled by default and can be -enabled using \fBrouteadm\fR(1M). -.SH SEE ALSO -.sp -.LP -\fBrouteadm\fR(1M) diff --git a/usr/src/man/man4/nscd.conf.4 b/usr/src/man/man4/nscd.conf.4 deleted file mode 100644 index be0b415b61..0000000000 --- a/usr/src/man/man4/nscd.conf.4 +++ /dev/null @@ -1,202 +0,0 @@ -'\" te -.\" Copyright (c) 2004 Sun Microsystems, Inc. All Rights Reserved -.\" 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 NSCD.CONF 4 "Mar 6, 2017" -.SH NAME -nscd.conf \- name service cache daemon configuration -.SH SYNOPSIS -.LP -.nf -\fB/etc/nscd.conf\fR -.fi - -.SH DESCRIPTION -.LP -The \fBnscd.conf\fR file contains the configuration information for -\fBnscd\fR(1M). Each line specifies either an \fIattribute\fR and a -\fIvalue\fR, or an \fIattribute\fR, \fIcachename\fR, and a \fIvalue\fR. Fields -are separated either by SPACE or TAB characters. A `\fB#\fR' (number sign) -indicates the beginning of a comment; characters up to the end of the line are -not interpreted by \fBnscd\fR. -.sp -.LP -\fIcachename\fR is represented by \fBhosts\fR, \fBipnodes\fR, \fBpasswd\fR, -\fBgroup\fR, \fBexec_attr\fR, \fBprof_attr\fR, \fBuser_attr\fR, \fBethers\fR, -\fBrpc\fR, \fBprotocols\fR, \fBnetworks\fR, \fBbootparams\fR, -\fBauth_attr\fR, \fBservices\fR, \fBnetmasks\fR, \fBprinters\fR, or -\fBproject\fR. -.sp -.LP -The \fIattribute\fR field supports the following: -.sp -.ne 2 -.na -\fB\fBcheck-files\fR \fIcachename value\fR\fR -.ad -.sp .6 -.RS 4n -Enables or disables checking the file belonging to the specified -\fIcachename\fR for changes. If enabled (which is the default), changes in the -corresponding file cause the cache to be invalidated within 10 seconds. Can be -disabled if files are never modified for a slight performance boost, -particularly over \fBNFS\fR. \fIvalue\fR may be either \fByes\fR or \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdebug-level\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -Sets the debug level desired. \fIvalue\fR may range from \fB0\fR (the default) -to \fB10\fR. Use of this option causes \fBnscd\fR(1M) to run in the foreground -and not become a daemon. Note that the output of the debugging command is not -likely to remain the same from release-to-release; scripts should \fInot\fR -rely on its format. -.RE - -.sp -.ne 2 -.na -\fB\fBenable-cache\fR \fIcachename value\fR\fR -.ad -.sp .6 -.RS 4n -Enables or disables the specified cache. \fIvalue\fR may be either \fByes\fR or -\fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBenable-per-user-lookup\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -Enables or disables the ability of \fBnscd\fR to create a per-user \fBnscd\fR. -A per-user \fBnscd\fR performs per-user lookups and manages the per-user cache. -The per-user lookups might not be possible if the corresponding name service -switch backends do not support it or are not configured to do so. The value of -this attribute can be either \fByes\fR or \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBkeep-hot-count\fR \fIcachename value\fR\fR -.ad -.sp .6 -.RS 4n -This attribute allows the administrator to set the number of entries -\fBnscd\fR(1M) is to keep current in the specified cache. \fIvalue\fR is an -integer number which should approximate the number of entries frequently used -during the day. -.RE - -.sp -.ne 2 -.na -\fB\fBlogfile\fR \fIdebug-file-name\fR\fR -.ad -.sp .6 -.RS 4n -Specifies name of the file to which debug info should be written. Use -\fB/dev/tty\fR for standard output. -.RE - -.sp -.ne 2 -.na -\fB\fBmaximum-per-user-nscd\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -Sets the maximum number of per-user \fBnscd\fRs that can be created and managed -by the main \fBnscd\fR daemon. The value is an integer. -.RE - -.sp -.ne 2 -.na -\fB\fBnegative-time-to-live\fR \fIcachename value\fR\fR -.ad -.sp .6 -.RS 4n -Sets the time-to-live for negative entries (unsuccessful queries) in the -specified cache. \fIvalue\fR is in integer seconds. Can result in significant -performance improvements if there are several files owned by uids (user IDs) -not in system databases; should be kept small to reduce cache coherency -problems. -.RE - -.sp -.ne 2 -.na -\fB\fBper-user-nscd-time-to-live\fR \fIvalue\fR\fR -.ad -.sp .6 -.RS 4n -Sets the time-to-live value for a per-user \fBnscd\fR based on the last time -the per-user \fBnscd\fR was active. The value is an integer that specifies a -number of seconds. -.RE - -.sp -.ne 2 -.na -\fB\fBpositive-time-to-live\fR \fIcachename value\fR\fR -.ad -.sp .6 -.RS 4n -Sets the time-to-live for positive entries (successful queries) in the -specified cache. \fIvalue\fR is in integer seconds. Larger values increase -cache hit rates and reduce mean response times, but increase problems with -cache coherence. Note that sites that push (update) NIS maps nightly can set -the value to be the equivalent of 12 hours or more with very good performance -implications. -.RE - -.sp -.ne 2 -.na -\fB\fBsuggested-size\fR \fIcachename value\fR\fR -.ad -.sp .6 -.RS 4n -Sets the suggested number of hash buckets in the specified cache. This -parameter should be changed only if the number of entries in the cache exceeds -the suggested size by more than a factor of four or five. Since this is the -internal hash table size, \fIvalue\fR should remain a prime number for optimum -efficiency. -.sp -This attribute is obsolete and will be silently ignored. \fBnscd\fR now -automatically adjusts the hash table size. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Availibility SUNWcsu -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.LP -\fBnscd\fR(1M), \fBauth_attr\fR(4), \fBbootparams\fR(4), -\fBethers\fR(4), \fBexec_attr\fR(4), \fBgroup\fR(4), \fBhosts\fR(4), -\fBnetmasks\fR(4), \fBnetworks\fR(4), \fBpasswd\fR(4), \fBprinters\fR(4), -\fBprof_attr\fR(4), \fBproject\fR(4), \fBprotocols\fR(4), \fBrpc\fR(4), -\fBservices\fR(4), \fBuser_attr\fR(4), \fBattributes\fR(5) diff --git a/usr/src/man/man4/nsmbrc.4 b/usr/src/man/man4/nsmbrc.4 deleted file mode 100644 index 26bb380eb5..0000000000 --- a/usr/src/man/man4/nsmbrc.4 +++ /dev/null @@ -1,415 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" 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] -.\" Copyright 2018 Nexenta Systems, Inc. All rights reserved. -.TH NSMBRC 4 "November 22, 2021" -.SH NAME -nsmbrc \- configuration file for Solaris CIFS client requests -.SH SYNOPSIS -.nf -\fB$HOME/.nsmbrc\fR -.fi - -.SH DESCRIPTION -Global behavior of the Solaris CIFS client is defined by property values that -are stored in the Service Management Facility (SMF). The \fB\&.nsmbrc\fR file -can be used to customize the behavior of the Solaris CIFS client on a per-user -basis. Settings in the \fB$HOME/.nsmbrc\fR file are used unless they have -security implications. -.sp -.LP -An authorized user can use the \fBsharectl\fR command to set global values for -these properties in SMF. See \fBsharectl\fR(1M). -.sp -.LP -A regular user can change the global values when granted the "SMBFS Management" -rights profile in the \fB/etc/user_attr\fR file. See \fBuser_attr\fR(4) and -\fBrbac\fR(5). -.sp -.LP -The SMBFS library first reads from SMF and then the \fB$HOME/.nsmbrc\fR file -when determining which policy to apply to a particular server, user, or share. -\fB$HOME/.nsmbrc\fR entries take precedence with the exception of the -\fBminauth\fR property value. For \fBminauth\fR, the strongest authentication -level specified is used. Sections are applied so that more specific sections -override less specific sections. Not all keywords are valid in all sections. -.sp -.LP -The configuration file is comprised of these four section types. Each section -can include zero or more properties and associated values. The sections also -have a hierarchical relationship with each other, as shown by the order of the -following list: -.RS +4 -.TP -.ie t \(bu -.el o -\fBDefault section.\fR Specifies the default property values to be used by all -other sections unless specifically overridden. -.sp -The section name appears in the \fB\&.nsmbrc\fR file as \fB[default]\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBServer section.\fR Specifies the property values to be used by sections that -are related to the named server. These property values can be specifically -overridden by a related user section or share section. -.sp -The section name appears in the \fB\&.nsmbrc\fR file as -\fB[\fIserver-name\fR]\fR. \fIserver-name\fR must use uppercase characters to -match. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBUser section.\fR Specifies the property values to be used by sections that -are related to the named server and user. These property values can be -specifically overridden by a related share section. -.sp -The section name appears in the \fB\&.nsmbrc\fR as -\fB[\fIserver-name\fR:\fIusername\fR]\fR. Both \fIserver-name\fR and -\fIusername\fR must use uppercase characters to match. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBShare section.\fR Specifies the property values to be used by sections that -are related to the named server, user, and share. -.sp -The section name appears in the \fB\&.nsmbrc\fR as -\fB[\fIserver-name\fR:\fIusername\fR:\fIshare-name\fR]\fR. Both -\fIserver-name\fR and \fIusername\fR must use uppercase characters to match. -.RE -.sp -.LP -The end of each section is marked either by the start of a new section or by an -end of file (EOF). -.sp -.LP -The following list describes the properties and states in which sections they -can be set: -.sp -.ne 2 -.na -\fB\fBaddr\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the DNS name or IP address of the CIFS server. This property can only -be set in a server section. If this property is specified, it must specify a -value as there is no default. -.RE - -.sp -.ne 2 -.na -\fB\fBdomain\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the Windows domain name to use when authenticating with a server. The -default value is \fBWORKGROUP\fR. This property can only be set in the default -and server sections. -.RE - -.sp -.ne 2 -.na -\fB\fBminauth\fR\fR -.ad -.sp .6 -.RS 4n -Is the minimum authentication level required, which can be one of -\fBkerberos\fR, \fBntlmv2\fR, \fBntlm\fR, \fBlm\fR, or \fBnone\fR. If -\fBminauth\fR is set globally and in a user's \fB\&.nsmbrc\fR file, the -stronger authentication setting are used whether set by the user or globally. -This property can only be set in the default and server sections. The default -value is \fBntlm\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBmin_protocol\fR\fR -.ad -.sp .6 -.RS 4n -Is the minimum SMB protocol level that will be negotiated, -which must be one of: \fB1\fR, \fB2.1\fR -This property can only be set in the default and server sections. -The default value is \fB1\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBmax_protocol\fR\fR -.ad -.sp .6 -.RS 4n -Is the maximum SMB protocol level that will be negotiated, -which must be one of: \fB1\fR, \fB2.1\fR -This property can only be set in the default and server sections. -The default value is \fB2.1\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnbns\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the DNS name or IP address of the NetBIOS/WINS name server. This -property can \fBonly\fR be set by an administrator by using the \fBsharectl\fR -command. This property can only be set in the default section. The default -value is empty, \fBnbns=""\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnbns_broadcast\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to perform NetBIOS/WINS broadcast lookups. Broadcast lookups -are less secure than unicast lookups. To prevent broadcast lookups, set the -value to \fBno\fR. This property has no effect if the \fBnbns_enable\fR -property is set to \fBno\fR or \fBfalse\fR. This property can \fBonly\fR be set -by an administrator by using the \fBsharectl\fR command. This property can only -be set in the default section. Valid values are \fByes\fR, \fBtrue\fR, -\fBno\fR, and \fBfalse\fR. The default value is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnbns_enable\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether to perform NetBIOS/WINS name lookups. To force all lookups to -be done through the name service switch (see \fBnsswitch.conf\fR(4)), set the -value to \fBno\fR. This property can \fBonly\fR be set by an administrator by -using the \fBsharectl\fR command. This property can only be set in the default -section. Valid values are \fByes\fR, \fBtrue\fR, \fBno\fR, and \fBfalse\fR. The -default value is \fByes\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpassword\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the password to use when authenticating a server. The \fBpassword\fR -property value is used as long as the \fB\&.nsmbrc\fR file can \fBonly\fR be -read and written by the owner. This property can be set in the default, server, -user, and share sections. -.sp -If you assign the hashed password from the \fBsmbutil crypt\fR command to the -\fBpassword\fR property, be sure to escape the special characters in the -password. -.RE - -.sp -.ne 2 -.na -\fB\fBsigning\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether communications are digitally signed by SMB security -signatures for the Solaris CIFS client. This property can only be set in the -default and server sections. Valid values are \fBdisabled\fR, \fBenabled\fR, -and \fBrequired\fR. The default value is \fBdisabled\fR. -.sp -When set to \fBdisabled\fR, the client permits the use of SMB security -signatures only if the server requires signing. In such an instance, the -Solaris CIFS client ignores local property values. -.sp -When set to \fBenabled\fR, the client permits, but does not require, the use of -SMB security signatures. -.sp -When set to \fBrequired\fR, the client requires the use of SMB security -signatures. So, if SMB security signatures are disabled on a CIFS server and a -client has signing required, the client cannot connect to that server. -.RE - -.sp -.ne 2 -.na -\fB\fBtimeout\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the CIFS request timeout. By default, the timeout is 15 seconds. This -property can only be set in the default, server, and share sections. -.RE - -.sp -.ne 2 -.na -\fB\fBuser\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the user name to use when authenticating a server. The default value -is the Solaris account name of the user performing the authentication. This -property can only be set in the default and server sections. -.RE - -.sp -.ne 2 -.na -\fB\fBworkgroup\fR\fR -.ad -.sp .6 -.RS 4n -Is supported for compatibility purposes and is a synonym for the \fBdomain\fR -property. Use the \fBdomain\fR property instead. -.RE - -.SH EXAMPLES -The examples in this section show how to use the \fB\&.nsmbrc\fR file and the -\fBsmbutil\fR command to configure the \fBexample.com\fR environment. -.sp -.LP -The \fBexample.com\fR environment is described by means of these sections and -settings: -.RS +4 -.TP -.ie t \(bu -.el o -The \fBdefault\fR section describes the default domain, which is called -\fBMYDOMAIN\fR, and sets a default user of \fBMYUSER\fR. These default settings -are inherited by other sections unless property values are overridden. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBFSERVER\fR is a server section that defines a server called -\fBfserv.example.com\fR. It is part of the \fBSALES\fR domain. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBRSERVER\fR is a server section that defines a server called -\fBrserv.example.com\fR that belongs to a new domain called \fBREMGROUP\fR. -.RE -.LP -\fBExample 1 \fRUsing the \fB$HOME/.nsmbrc\fR Configuration File -.sp -.LP -The following example shows how a user can configure the \fBexample.com\fR -environment by creating the \fB\&.nsmbrc\fR file. - -.sp -.LP -All lines that begin with the \fB#\fR character are comments and are not -parsed. - -.sp -.in +2 -.nf -# Configuration file for example.com -# Specify the Windows account name to use everywhere. -[default] -domain=MYDOMAIN -user=MYUSER - -# The 'FSERVER' is server in our domain. -[FSERVER] -addr=fserv.example.com - -# The 'RSERVER' is a server in another domain. -[RSERVER] -domain=REMGROUP -addr=rserv.example.com -.fi -.in -2 - -.LP -\fBExample 2 \fRUsing the \fBsharectl\fR Command -.sp -.LP -The following example shows how an authorized user can use \fBsharectl\fR -commands to configure global settings for the \fBexample.com\fR environment in SMF. - -.sp -.in +2 -.nf -# \fBsharectl set -p section=default -p domain=MYDOMAIN \e --p user=MYUSER smbfs\fR -# \fBsharectl set -p section=FSERVER -p addr=fserv.example.com smbfs\fR -# \fBsharectl set -p section=RSERVER -p domain=REMGROUP \e --p addr=rserv.example.com smbfs\fR -.fi -.in -2 -.sp - -.LP -\fBExample 3 \fRUsing the \fBsharectl\fR Command to Show Current Settings -.sp -.LP -The following example shows how an authorized user can use the \fBsharectl -get\fR command to view the global settings for \fBsmbfs\fR in SMF. The values -shown are those set by the previous example. - -.sp -.in +2 -.nf -# \fBsharectl get smbfs\fR -[default] - domain=MYDOMAIN - user=MYUSER -[FSERVER] - addr=fserv.example.com -[RSERVER] - domain=REMGROUP - addr=rserv.example.com -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB$HOME/.nsmbrc\fR\fR -.ad -.sp .6 -.RS 4n -User-settable mount point configuration file to store the description for each -connection. -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -\fBsmbutil\fR(1), \fBmount_smbfs\fR(1M), \fBsharectl\fR(1M), -\fBnsswitch.conf\fR(4), \fBuser_attr\fR(4), \fBattributes\fR(5), \fBrbac\fR(5), -\fBsmbfs\fR(7FS) -.SH NOTES -By default, passwords stored in the \fB\&.nsmbrc\fR file are ignored unless -\fBonly\fR the file owner has read and write permission. diff --git a/usr/src/man/man4/nss.4 b/usr/src/man/man4/nss.4 deleted file mode 100644 index 1274b55b31..0000000000 --- a/usr/src/man/man4/nss.4 +++ /dev/null @@ -1,80 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. -.\" All Rights Reserved. -.\" 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 NSS 4 "Feb 25, 2017" -.SH NAME -nss \- configuration file for initgroups -.SH SYNOPSIS -.LP -.nf -\fB/etc/default/nss\fR -.fi - -.SH DESCRIPTION -.LP -The \fB/etc/default/nss\fR configuration file provides methods for -\fBinitgroups\fR(3C) lookup method. The file also provides a method to disable -address sorting by name lookup functions. The file controls the behavior of the -name service switch routines outside of the source database mappings provided -by the \fB/etc/nsswitch.conf\fR file. -.sp -.LP -\fB/etc/default/nss\fR supports the following options: -.sp -.ne 2 -.na -\fB\fBNETID_AUTHORITATIVE\fR\fR -.ad -.RS 23n -Changes the behavior of the name service lookups to use the \fBnetid\fR table -in response to the \fBinitgroups()\fR call. By default, -\fBinitgroups()\fR uses the \fBgroup\fR table. When \fBNETID_AUTHORITATIVE\fR -is set to TRUE, \fBinitgroups()\fR uses \fBnetid\fR as the source for -supplementary groups rather than the \fBgroup\fR table. -.sp -The name service administrator must ensure that the \fBnetid\fR table contains -valid supplementary group information for users. Not all name services can -automatically keep the members listed in the \fBgroup\fR table in sync with the -\fBnetid\fR table. -.RE - -.sp -.ne 2 -.na -\fB\fBSORT_ADDRS\fR\fR -.ad -.RS 23n -If this option is set to FALSE, the sorting of addresses is disabled on -addresses that are returned by name lookup functions such as -\fBinitgroups()\fR, \fBgethostbyname\fR(3NSL), \fBnetdir_getbyname\fR(3NSL), -\fBgetaddrinfo\fR(3SOCKET), and \fBgetipnodebyname\fR(3SOCKET). Setting this -option to FALSE is useful when the order of addresses returned by the -nameserver needs to be maintained. To use the DNS round robin feature, for -example, address sorting by name lookup functions should be disabled. -.sp -By default, address sorting is enabled. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.LP -\fBgetaddrinfo\fR(3SOCKET), \fBgethostbyname\fR(3NSL), -\fBgetipnodebyname\fR(3SOCKET), \fBinitgroups\fR(3C), -\fBnetdir_getbyname\fR(3NSL), \fBnsswitch.conf\fR(4), \fBattributes\fR(5) diff --git a/usr/src/man/man4/nsswitch.conf.4 b/usr/src/man/man4/nsswitch.conf.4 deleted file mode 100644 index ea46118b9d..0000000000 --- a/usr/src/man/man4/nsswitch.conf.4 +++ /dev/null @@ -1,800 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 NSSWITCH.CONF 4 "Mar 6, 2017" -.SH NAME -nsswitch.conf \- configuration file for the name service switch -.SH SYNOPSIS -.LP -.nf -\fB/etc/nsswitch.conf\fR -.fi - -.SH DESCRIPTION -.LP -The operating system uses a number of databases of information about hosts, -ipnodes, users (\fBpasswd\fR(4), \fBshadow\fR(4), and \fBuser_attr\fR(4)), and -groups. Data for these can come from a variety of sources: hostnames and host -addresses, for example, can be found in \fB/etc/hosts\fR, \fBNIS\fR, -\fBLDAP\fR, \fBDNS\fR or Multicast \fBDNS\fR. Zero or more sources -can be used for each database; the sources and their lookup order are specified -in the \fB/etc/nsswitch.conf\fR file. -.sp -.LP -The following databases use the \fBswitch\fR file: -.sp - -.sp -.TS -c c -l l . -Database Used By -\fBaliases\fR \fBsendmail\fR(1M) -\fBauth_attr\fR \fBgetauthnam\fR(3SECDB) -\fBautomount\fR \fBautomount\fR(1M) -\fBbootparams\fR \fBrpc.bootparamd\fR(1M) -\fBethers\fR \fBethers\fR(3SOCKET) -\fBgroup\fR \fBgetgrnam\fR(3C) -\fBhosts\fR T{ -\fBgethostbyname\fR(3NSL), \fBgetaddrinfo\fR(3SOCKET). See \fBInteraction with netconfig\fR. -T} -\fBipnodes\fR Same as \fBhosts\fR. -\fBnetgroup\fR \fBinnetgr\fR(3C) -\fBnetmasks\fR \fBifconfig\fR(1M) -\fBnetworks\fR \fBgetnetbyname\fR(3SOCKET) -\fBpasswd\fR T{ -\fBgetpwnam\fR(3C), \fBgetspnam\fR(3C), \fBgetusernam\fR(3SECDB) -T} -\fBprinters\fR T{ -\fBlp\fR(1), \fBlpstat\fR(1), \fBcancel\fR(1), \fBlpr\fR(1B), \fBlpq\fR(1B), \fBlprm\fR(1B), \fBin.lpd\fR(1M), \fBlpadmin\fR(1M), \fBlpget\fR(1M), \fBlpset\fR(1M) -T} -\fBprof_attr\fR \fBgetprofnam\fR(3SECDB), \fBgetexecprof\fR(3SECDB) -\fBproject\fR T{ -\fBgetprojent\fR(3PROJECT), \fBgetdefaultproj\fR(3PROJECT), \fBinproj\fR(3PROJECT), \fBnewtask\fR(1), \fBsetproject\fR(3PROJECT) -T} -\fBprotocols\fR \fBgetprotobyname\fR(3SOCKET) -\fBpublickey\fR \fBgetpublickey\fR(3NSL), \fBsecure_rpc\fR(3NSL) -\fBrpc\fR \fBgetrpcbyname\fR(3NSL) -\fBservices\fR \fBgetservbyname\fR(3SOCKET). - See \fBInteraction with netconfig\fR. -\fBuser_attr\fR \fBgetuserattr\fR(3SECDB) -.TE - -.sp -.LP -The following sources can be used: -.sp - -.sp -.TS -c c -l l . -Source Uses -\fBfiles\fR T{ -\fB/etc/hosts\fR, \fB/etc/passwd\fR, \fB/etc/inet/ipnodes\fR, \fB/etc/shadow\fR, \fB/etc/security/auth_attr\fR, \fB/etc/user_attr\fR -T} -\fBnis\fR \fBNIS\fR(\fBYP\fR) -\fBldap\fR \fBLDAP\fR -\fBad\fR Active Directory -\fBdns\fR T{ -Valid only for hosts and ipnodes. Uses the Internet Domain Name Service. -T} -\fBmdns\fR T{ -Valid only for hosts and ipnodes. Uses the Multicast Domain Name Service. -T} -\fBcompat\fR T{ -Valid only for \fBpasswd\fR and \fBgroup\fR. Implements \fB+\fR and \fB-.\fR See \fBInteraction with +/- syntax\fR. -T} -\fBuser\fR T{ -Valid only for printers. Implements support for \fB${HOME}/.printers\fR. -T} -.TE - -.sp -.LP -Note that \fB/etc/inet/ipnodes\fR is a symbolic link to \fB/etc/hosts\fR. -.sp -.LP -There is an entry in \fB/etc/nsswitch.conf\fR for each database. Typically -these entries are simple, such as \fBprotocols: files\fR. However, when -multiple sources are specified, it is sometimes necessary to define precisely -the circumstances under which each source is tried. A source can return one -of the following codes: -.sp - -.sp -.TS -c c -l l . -Status Meaning -\fBSUCCESS\fR Requested database entry was found. -\fBUNAVAIL\fR T{ -Source is not configured on this system or internal failure. -T} -\fBNOTFOUND\fR Source responded "\fBno such entry\fR" -\fBTRYAGAIN\fR T{ -Source is busy or not responding, might respond to retries. -T} -.TE - -.sp -.LP -For each status code, two actions are possible: -.sp - -.sp -.TS -c c -l l . -Action Meaning -\fBcontinue\fR Try the next source in the list. -\fBreturn\fR Return now. -.TE - -.sp -.LP -Additionally, for \fBTRYAGAIN\fR only, the following actions are possible: -.sp - -.sp -.TS -c c -l l . -Action Meaning -\fBforever\fR Retry the current source forever. -\fIn\fR T{ -Retry the current source \fIn\fR more times, where \fIn\fR is an integer between \fB0\fR and \fBMAX_INT\fR (that is, 2.14 billion). After \fIn\fR retries has been exhausted, the \fBTRYAGAIN\fR action transitions to \fBcontinue\fR, until a future request receives a response, at which time \fBTRYAGAIN\fR=\fIn\fR is restored. -T} -.TE - -.sp -.LP -The complete syntax of an entry is: -.sp -.in +2 -.nf -<entry> ::= <database> ":" [<source> [<criteria>]]* -<criteria> ::= "[" <criterion>+ "]" -<criterion> ::= <status> "=" <action> -<status> ::= "success" | "notfound" | "unavail" | "tryagain" -.fi -.in -2 - -.sp -.LP -For every status except \fBTRYAGAIN\fR, the action syntax is: -.sp -.in +2 -.nf -<action> ::= "return" | "continue" -.fi -.in -2 - -.sp -.LP -For the \fBTRYAGAIN\fR status, the action syntax is: -.sp -.in +2 -.nf -<action> ::= "return" | "continue" | "forever" | <n> -<n> ::= 0...MAX_INT -.fi -.in -2 - -.sp -.LP -Each entry occupies a single line in the file. Lines that are blank, or that -start with white space, are ignored. Everything on a line following a \fB#\fR -character is also ignored; the \fB#\fR character can begin anywhere in a line, -to be used to begin comments. The <database> and <source> names are -case-sensitive, but <action> and <status> names are case-insensitive. -.sp -.LP -The library functions contain compiled-in default entries that are used if the -appropriate entry in \fBnsswitch.conf\fR is absent or syntactically incorrect. -.sp -.LP -The default criteria for \fBDNS\fR and the \fBNIS\fR server in "DNS-forwarding -mode" is [\fBSUCCESS\fR=return \fBNOTFOUND\fR=continue \fBUNAVAIL\fR=continue -\fBTRYAGAIN\fR=3]. -.sp -.LP -The default criteria for all other sources is [\fBSUCCESS\fR=return -\fBNOTFOUND\fR=continue \fBUNAVAIL\fR=continue \fBTRYAGAIN\fR=forever]. -.sp -.LP -The default, or explicitly specified, criteria are meaningless following the -last source in an entry; and they are ignored, since the action is always to -return to the caller irrespective of the status code the source returns. -.SS "Interaction with \fBnetconfig\fR" -.LP -In order to ensure that they all return consistent results, -\fBgethostbyname\fR(3NSL), \fBgetaddrinfo\fR(3SOCKET), -\fBgetservbyname\fR(3SOCKET), and \fBnetdir_getbyname\fR(3NSL) functions are -all implemented in terms of the same internal library function. This function -obtains the system-wide source lookup policy for \fBhosts\fR, \fBipnodes\fR, -and \fBservices\fR based on the \fBinet\fR family entries in \fBnetconfig\fR(4) -and uses the switch entries only if the \fBnetconfig\fR entries have a \fB-\fR -(hyphen) in the last column for \fBnametoaddr\fR libraries. See the Notes -section in \fBgethostbyname\fR(3NSL) and \fBgetservbyname\fR(3SOCKET) for -details. -.SS "Interaction with server in DNS-forwarding Mode" -.LP -The \fBNIS\fR (\fBYP\fR) server can be run in DNS-forwarding mode, where it -forwards lookup requests to \fBDNS\fR for host-names and -addresses that do not -exist in its database. In this case, specifying \fBnis\fR as a source for -\fBhosts\fR is sufficient to get \fBDNS\fR lookups; \fBdns\fR need not be -specified explicitly as a source. -.SS "Interaction with Password Aging" -.LP -When password aging is turned on, only a limited set of possible name services -are permitted for the \fBpasswd\fR: database in the \fB/etc/nsswitch.conf\fR -file: -.sp -.ne 2 -.na -\fBpasswd:\fR -.ad -.RS 18n -files -.RE - -.sp -.ne 2 -.na -\fBpasswd:\fR -.ad -.RS 18n -files nis -.RE - -.sp -.ne 2 -.na -\fBpasswd:\fR -.ad -.RS 18n -files ldap -.RE - -.sp -.ne 2 -.na -\fBpasswd:\fR -.ad -.RS 18n -compat -.RE - -.sp -.ne 2 -.na -\fBpasswd_compat:\fR -.ad -.RS 18n -ldap -.RE - -.sp -.LP -You can add the \fBad\fR keyword to any of the \fBpasswd\fR configurations -listed above. However, you cannot use the \fBpasswd\fR command to change the -password of an Active Directory (AD) user. If the \fBad\fR keyword is found in -the \fBpasswd\fR entry during a password update operation, it is ignored. To -update the password of an AD user, use the \fBkpasswd\fR(1) command. -.sp -.LP -Any other settings causes the \fBpasswd\fR(1) command to fail when it attempts -to change the password after expiration and prevents the user from logging in. -These are the \fBonly\fR permitted settings when password aging has been turned -on. Otherwise, you can work around incorrect \fBpasswd\fR: lines by using the -\fB-r repository\fR argument to the \fBpasswd\fR(1) command and using \fBpasswd --r repository\fR to override the \fBnsswitch.conf\fR settings and specify in -which name service you want to modify your password. -.SS "Interaction with +/- syntax" -.LP -Releases prior to SunOS 5.0 did not have the name service switch but did allow -the user some policy control. In \fB/etc/passwd\fR one could have entries of -the form \fI+user\fR (include the specified user from \fBNIS\fR passwd.byname), -\fI-user\fR (exclude the specified user) and \fB+\fR (include everything, -except excluded users, from \fBNIS\fR passwd.byname). The desired behavior was -often \fBeverything in the file followed by everything in NIS\fR, expressed by -a solitary \fB+\fR at the end of \fB/etc/passwd\fR. The switch provides an -alternative for this case (\fBpasswd: files nis\fR) that does not require -\fB+\fR entries in \fB/etc/passwd\fR and \fB/etc/shadow\fR (the latter is a new -addition to SunOS 5.0, see \fBshadow\fR(4)). -.sp -.LP -If this is not sufficient, the \fBNIS/YP\fR compatibility source provides full -+/- semantics. It reads \fB/etc/passwd\fR for \fBgetpwnam\fR(3C) functions and -\fB/etc/shadow\fR for \fBgetspnam\fR(3C) functions and, if it finds +/- -entries, invokes an appropriate source. By default, the source is \fBnis\fR, -but this can be overridden by specifying \fBldap\fR as the -source for the pseudo-database \fBpasswd_compat\fR. -.sp -.LP -Note that in compat mode, for every \fB/etc/passwd\fR entry, there must be a -corresponding entry in the \fB/etc/shadow\fR file. -.sp -.LP -The NIS/YP compatibility source also provides full +/- semantics for -\fBgroup\fR; the relevant pseudo-database is \fBgroup_compat\fR. -.SS "Useful Configurations" -.LP -The compiled-in default entries for all databases use \fBNIS (YP)\fR as the -enterprise level name service and are identical to those in the default -configuration of this file: -.sp -.ne 2 -.na -\fBpasswd:\fR -.ad -.RS 15n -files nis -.RE - -.sp -.ne 2 -.na -\fBgroup:\fR -.ad -.RS 15n -files nis -.RE - -.sp -.ne 2 -.na -\fBhosts:\fR -.ad -.RS 15n -nis [NOTFOUND=return] files -.RE - -.sp -.ne 2 -.na -\fBipnodes:\fR -.ad -.RS 15n -nis [NOTFOUND=return] files -.RE - -.sp -.ne 2 -.na -\fBnetworks:\fR -.ad -.RS 15n -nis [NOTFOUND=return] files -.RE - -.sp -.ne 2 -.na -\fBprotocols:\fR -.ad -.RS 15n -nis [NOTFOUND=return] files -.RE - -.sp -.ne 2 -.na -\fBrpc:\fR -.ad -.RS 15n -nis [NOTFOUND=return] files -.RE - -.sp -.ne 2 -.na -\fBethers:\fR -.ad -.RS 15n -nis [NOTFOUND=return] files -.RE - -.sp -.ne 2 -.na -\fBnetmasks:\fR -.ad -.RS 15n -nis [NOTFOUND=return] files -.RE - -.sp -.ne 2 -.na -\fBbootparams:\fR -.ad -.RS 15n -nis [NOTFOUND=return] files -.RE - -.sp -.ne 2 -.na -\fBpublickey:\fR -.ad -.RS 15n -nis [NOTFOUND=return] files -.RE - -.sp -.ne 2 -.na -\fBnetgroup:\fR -.ad -.RS 15n -nis -.RE - -.sp -.ne 2 -.na -\fBautomount:\fR -.ad -.RS 15n -files nis -.RE - -.sp -.ne 2 -.na -\fBaliases:\fR -.ad -.RS 15n -files nis -.RE - -.sp -.ne 2 -.na -\fBservices:\fR -.ad -.RS 15n -files nis -.RE - -.sp -.ne 2 -.na -\fBprinters:\fR -.ad -.RS 15n -user files nis -.RE - -.sp -.ne 2 -.na -\fBauth_attr\fR -.ad -.RS 15n -files nis -.RE - -.sp -.ne 2 -.na -\fBprof_attr\fR -.ad -.RS 15n -files nis -.RE - -.sp -.ne 2 -.na -\fBproject\fR -.ad -.RS 15n -files nis -.RE - -.sp -.LP -Note that the \fBfiles\fR source for the \fBipnodes\fR and \fBhosts\fR -databases is identical, as \fB/etc/inet/ipnodes\fR is a symbolic link to -\fB/etc/hosts\fR. Because other sources for the \fBipnodes\fR and \fBhosts\fR -databases are different, do not remove the \fBipnodes\fR line from the -\fB/etc/nsswitch.conf\fR file. -.sp -.LP -The policy \fBnis [NOTFOUND=return] files\fR implies: if \fBnis\fR is -\fBUNAVAIL\fR, continue on to \fBfiles\fR, and if \fBnis\fR returns -\fBNOTFOUND\fR, return to the caller. In other words, treat \fBnis\fR as the -authoritative source of information and try \fBfiles\fR only if \fBnis\fR is -down. This, and other policies listed in the default configuration above, are -identical to the hard-wired policies in SunOS releases prior to 5.0. -.sp -.LP -If compatibility with the +/- syntax for \fBpasswd\fR and \fBgroup\fR is -required, simply modify the entries for \fBpasswd\fR and \fBgroup\fR to: -.sp -.ne 2 -.na -\fBpasswd:\fR -.ad -.RS 11n -compat -.RE - -.sp -.ne 2 -.na -\fBgroup:\fR -.ad -.RS 11n -compat -.RE - -.sp -.LP -If \fBLDAP\fR is the enterprise level name service, the default configuration -should be modified to use \fBldap\fR instead of \fBnis\fR for every database on -client machines. The file \fB/etc/nsswitch.ldap\fR contains a sample -configuration that can be copied to \fB/etc/nsswitch.conf\fR to set this -policy. -.sp -.LP -When using Active Directory, \fBdns\fR is required to perform hosts resolution. -.sp -.LP -If the use of +/- syntax is desired in conjunction with \fBLDAP\fR, use the -following four entries: -.sp -.ne 2 -.na -\fBpasswd:\fR -.ad -.RS 18n -compat -.RE - -.sp -.ne 2 -.na -\fBpasswd_compat:\fR -.ad -.RS 18n -ldap -.RE - -.sp -.ne 2 -.na -\fBgroup:\fR -.ad -.RS 18n -compat -.RE - -.sp -.ne 2 -.na -\fBgroup_compat:\fR -.ad -.RS 18n -ldap -.RE - -.sp -.LP -In order to get information from the Internet Domain Name Service for hosts -that are not listed in the enterprise level name service, such as -\fBLDAP\fR, use the following configuration and set up the -\fB/etc/resolv.conf\fR file (see \fBresolv.conf\fR(4) for more details): -.sp -.ne 2 -.na -\fBhosts:\fR -.ad -.RS 10n -ldap dns [NOTFOUND=return] files -.RE - -.SS "Enumeration - \fBgetXXXent()\fR" -.LP -Many of the databases have enumeration functions: \fBpasswd\fR has -\fBgetpwent()\fR, \fBhosts\fR has \fBgethostent()\fR, and so on. These were -reasonable when the only source was \fBfiles\fR but often make little sense for -hierarchically structured sources that contain large numbers of entries, much -less for multiple sources. The interfaces are still provided and the -implementations strive to provide reasonable results, but the data returned can -be incomplete (enumeration for \fBhosts\fR is simply not supported by the -\fBdns\fR source), inconsistent (if multiple sources are used), formatted in an -unexpected fashion, -or very expensive (enumerating a \fBpasswd\fR database of 5,000 users is -probably a bad idea). Furthermore, multiple threads in the same process using -the same reentrant enumeration function (\fBgetXXXent_r()\fR are supported -beginning with SunOS 5.3) share the same enumeration position; if they -interleave calls, they enumerate disjoint subsets of the same database. -.sp -.LP -In general, the use of the enumeration functions is deprecated. In the case of -\fBpasswd\fR, \fBshadow\fR, and \fBgroup\fR, it might sometimes be appropriate -to use \fBfgetgrent()\fR, \fBfgetpwent()\fR, and \fBfgetspent()\fR (see -\fBgetgrnam\fR(3C), \fBgetpwnam\fR(3C), and \fBgetspnam\fR(3C), respectively), -which use only the \fBfiles\fR source. -.SH FILES -.LP -A source named SSS is implemented by a shared object named \fBnss_SSS.so.1\fR -that resides in \fB/usr/lib\fR. -.sp -.ne 2 -.na -\fB\fB/etc/nsswitch.conf\fR\fR -.ad -.RS 29n -Configuration file. -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/nss_compat.so.1\fR\fR -.ad -.RS 29n -Implements \fBcompat\fR source. -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/nss_dns.so.1\fR\fR -.ad -.RS 29n -Implements \fBdns\fR source. -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/nss_files.so.1\fR\fR -.ad -.RS 29n -Implements \fBfiles\fR source. -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/nss_mdns.so.1\fR\fR -.ad -.RS 29n -Implements \fBmdns\fR source. -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/nss_nis.so.1\fR\fR -.ad -.RS 29n -Implements \fBnis\fR source. -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/nss_ldap.so.1\fR\fR -.ad -.RS 29n -Implements \fBldap\fR source. -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/nss_ad.so.1\fR\fR -.ad -.RS 29n -Implements ad source. -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/nss_user.so.1\fR\fR -.ad -.RS 29n -Implements \fBuser\fR source. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/netconfig\fR\fR -.ad -.RS 29n -Configuration file for \fBnetdir\fR(3NSL) functions that redirects -hosts/devices policy to the switch. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/nsswitch.files\fR\fR -.ad -.RS 29n -Sample configuration file that uses \fBfiles\fR only. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/nsswitch.nis\fR\fR -.ad -.RS 29n -Sample configuration file that uses \fBfiles\fR and \fBnis\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/nsswitch.ldap\fR\fR -.ad -.RS 29n -Sample configuration file that uses \fBfiles\fR and \fBldap\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/nsswitch.ad\fR\fR -.ad -.RS 29n -Sample configuration file that uses \fBfiles\fR and \fBad\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/nsswitch.dns\fR\fR -.ad -.RS 29n -Sample configuration file that uses \fBfiles\fR, \fBdns\fR and \fBmdns\fR -(\fBdns\fR and \fBmdns\fR only for hosts). -.RE - -.SH SEE ALSO -.LP -\fBkpasswd\fR(1), \fBldap\fR(1), \fBnewtask\fR(1), -\fBpasswd\fR(1), \fBautomount\fR(1M), \fBifconfig\fR(1M), \fBmdnsd\fR(1M), -\fBrpc.bootparamd\fR(1M), \fBsendmail\fR(1M), -\fBgetgrnam\fR(3C), \fBgetnetgrent\fR(3C), -\fBgetpwnam\fR(3C), \fBgetspnam\fR(3C), \fBgethostbyname\fR(3NSL), -\fBgetpublickey\fR(3NSL), \fBgetrpcbyname\fR(3NSL), \fBnetdir\fR(3NSL), -\fBsecure_rpc\fR(3NSL), \fBgetprojent\fR(3PROJECT), -\fBgetdefaultproj\fR(3PROJECT), \fBinproj\fR(3PROJECT), -\fBsetproject\fR(3PROJECT), \fBgetauthnam\fR(3SECDB), -\fBgetexecprof\fR(3SECDB), \fBgetprofnam\fR(3SECDB), \fBgetuserattr\fR(3SECDB), -\fBgetusernam\fR(3SECDB), \fBethers\fR(3SOCKET), \fBgetaddrinfo\fR(3SOCKET), -\fBgetnetbyname\fR(3SOCKET), \fBgetprotobyname\fR(3SOCKET), -\fBgetservbyname\fR(3SOCKET), \fBauth_attr\fR(4), \fBhosts\fR(4), -\fBnetconfig\fR(4), \fBproject\fR(4), \fBresolv.conf\fR(4), \fBuser_attr\fR(4), -\fBypfiles\fR(4), \fBad\fR(5) -.SH NOTES -.LP -Within each process that uses \fBnsswitch.conf\fR, the entire file is read only -once; if the file is later changed, the process continues using the old -configuration. -.sp -.LP -Do not use the \fBldap\fR and \fBad\fR keywords together when the Solaris LDAP -client uses schema mapping to talk to Active Directory. -.sp -.LP -Misspelled names of sources and databases are treated as legitimate names of -(most likely nonexistent) sources and databases. -.sp -.LP -The following functions do \fBnot\fR use the switch: \fBfgetgrent\fR(3C), -\fBfgetprojent\fR(3PROJECT), \fBfgetpwent\fR(3C), \fBfgetspent\fR(3C), -\fBgetpw\fR(3C), \fBputpwent\fR(3C), \fBshadow\fR(4). diff --git a/usr/src/man/man4/overlay_files.4 b/usr/src/man/man4/overlay_files.4 deleted file mode 100644 index b9e5387871..0000000000 --- a/usr/src/man/man4/overlay_files.4 +++ /dev/null @@ -1,187 +0,0 @@ -.\" -.\" 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, Joyent, Inc. -.\" -.Dd Apr 13, 2015 -.Dt OVERLAY_FILES 4 -.Os -.Sh NAME -.Nm overlay_files -.Nd Overlay files plugin file format -.Sh DESCRIPTION -The -.Sy files -plugin provides a means for a dynamic overlay where the destinations are -determined based on a static description contained in a -.Sy JSON -file. -This manual describes the format of the file used by the -.Sy files/config -property. -To create and manage overlays with the -.Sy files -plugin, use -.Xr dladm 1M . -For more information on overlays, see -.Xr overlay 5 . -.Pp -Using the -.Sy files -module, a static and simple overlay network can be created. -This network does not support the use of -.Em broadcast -or -.Em multicast -traffic. -Both ARP and NDP traffic are proxied by the plugin itself. -In addition, the plugin allows for DHCP. -Instead of providing a traditional DHCP proxy, when an initial DHCP broadcast -goes out to a broadcast address, it will get rewritten to target a specific MAC -address. -The -.Sy files -plugin is useful as proof of concept and for simple static networks -where addresses do not need to be reconfigured. -If more advanced topologies or more streamlined updates are required, consider -a different plugin. -.Pp -The file format is encoded as a series of -.Sy JSON -objects. -Each object has a key, which is a MAC address on the -.Sy overlay -network. -It has multiple values, some required, some optional, which describe various -properties. -The valid properties are: -.Bl -hang -width Ds -.It Sy ip -.Bd -filled -compact -The -.Sy ip -key indicates the IP address on the -.Sy underlay -network that houses the MAC address in question. -Packets directed for the MAC address will be encapsulated and set to this -address. -This field is required. -.Pp -The value is a -.Em JSON String . -Both IPv4 and IPv6 addresses are supported and should be written out in their -traditional forms. -Follow the guidelines for writing addresses in -.Xr inet_aton 3SOCKET . -.Ed -.It Sy port -.Bd -filled -compact -The -.Sy port -key indicates the port on the -.Sy underlay -network that houses the MAC address in question. -This property is required if the encapsulation module requires a port for its -destination. -The value is a -.Em JSON Number . -.Ed -.It Sy arp -.Bd -filled -compact -The -.Sy arp -key stores the IPv4 address that corresponds to this MAC address on the -.Sy overlay -network. -This will be used to respond to ARP queries that would traditionally have been -received by the OS kernel. -If this address is not present, no IPv4 packets directed to this IP address will -be received by the network interface that has this MAC address, regardless of -what is configured on top of it. -.Pp -The value is a -.Em JSON String -and should be written out following the guidelines for IPv4 addresses in -.Xr inet_aton 3SOCKET . -.Ed -.It Sy ndp -.Bd -filled -compact -The -.Sy ndp -key stores the IPv6 address that corresponds to this MAC address on the -.Sy overlay -network. -This will be used to respond to NDP queries that would traditionally have been -received by the OS kernel. -If this address is not present, no IPv6 packets directed to this IP address will -be received by the network interface that has this MAC address, regardless of -what is configured on top of it. -.Pp -The value is a -.Em JSON String -and should be written out following the guidelines for IPv6 addresses in -.Xr inet_aton 3SOCKET . -.Ed -.It Sy dhcp-proxy -.Bd -filled -compact -The -.Sy dhcp-proxy -key stores a MAC address that DHCP messages directed to a broadcast address get -rewritten to be sent to. -This can be viewed as a form of proxy DHCP, but is different in mechanism from a -traditional proxy. -The value is a -.Em JSON String -and should be written as a traditional MAC address string as described by -.Xr ether_aton 3SOCKET . -.Ed -.El -.Sh EXAMPLES -.Sy Example 1 -Sample configuration file -.Pp -This configuration file provides information for three different MAC -addresses. -Each MAC address has an entry which describes what its IPv4 -and IPv6 address is, as well as the IP address and port of the host on -the underlay network. -Finally, one host has a DHCP proxy entry to demonstrate how one might -configure DHCP. -.Bd -literal -offset indent -{ - "de:ad:be:ef:00:00": { - "arp": "10.55.55.2", - "ip": "10.88.88.69", - "ndp": "fe80::3", - "port": 4789 - }, - "de:ad:be:ef:00:01": { - "arp": "10.55.55.3", - "dhcp-proxy": "de:ad:be:ef:00:00", - "ip": "10.88.88.70", - "ndp": "fe80::4", - "port": 4789 - }, - "de:ad:be:ef:00:02": { - "arp": "10.55.55.4", - "ip": "10.88.88.71", - "ndp": "fe80::5", - "port": 4789 - } -} -.Ed -.Sh STABILITY -This file format is -.Sy committed ; -however, keys that are not listed here are reserved for future use. -.Sh SEE ALSO -.Xr dladm 1M , -.Xr overlay 5 diff --git a/usr/src/man/man4/packingrules.4 b/usr/src/man/man4/packingrules.4 deleted file mode 100644 index bc8c891541..0000000000 --- a/usr/src/man/man4/packingrules.4 +++ /dev/null @@ -1,182 +0,0 @@ -'\" te -.\" Copyright (c) 1996 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2015 Nexenta Systems, Inc. All rights reserved. -.\" 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 PACKINGRULES 4 "Sep 8, 2015" -.SH NAME -packingrules \- packing rules file for filesync -.SH SYNOPSIS -.LP -.nf -\fB$\fR\fBHOME\fR\fB/.packingrules\fR -.fi - -.SH DESCRIPTION -.LP -\fB$\fR\fBHOME\fR\fB/.packingrules\fR is a packing rules file for -\fBfilesync\fR. \fB$\fR\fBHOME\fR\fB/.packingrules\fR -contains a list of directories and files that are to be packed and -synchronized. It also contains a list of directories and files that are to be -specifically excluded from packing and synchronization. See \fBfilesync\fR(1). -.LP -The \fB$\fR\fBHOME\fR\fB/.packingrules\fR file is automatically created if -users invoke \fBfilesync\fR with filename arguments. By using \fBfilesync\fR -options, users can augment the packing rules in -\fB$\fR\fBHOME\fR\fB/.packingrules\fR. -.LP -Many users choose to manually create the packing rules file and edit it by -hand. Users can edit \fB$\fR\fBHOME\fR\fB/.packingrules\fR (using any editor) -to permanently change the \fB$\fR\fBHOME\fR\fB/.packingrules\fR file, or to -gain access to more powerful options that are not available from the command -line (such as \fBIGNORE\fR commands). It is much easier to enter complex -wildcard expressions by editing the \fB$\fR\fBHOME\fR\fB/.packingrules\fR file. -.LP -Blank lines and lines that begin with a pound sign (`\fB#\fR') are ignored. -.LP -Any line can be continued by placing a backslash (`\fB\e\fR\&') immediately -before the \fBNEWLINE.\fR -.LP -All other lines in the \fB$\fR\fBHOME\fR\fB/.packingrules\fR file have one of -the following formats: -.sp -.ne 2 -.na -\fB\fBPACKINGRULES\fR\fR -.ad -.sp .6 -.RS 4n -\fImajor\fR. \fIminor\fR. This line is not actually required, but it should be -the first line of every packing rules file. This line identifies the packing -rules file for the \fBfile\fR(1) command and specifies a format version -number. The current version number is 1.1. See \fBfile\fR(1). -.RE - -.sp -.ne 2 -.na -\fB\fBBASE\fR \fIdirectory-1\fR [\fIdirectory-2\fR]\fR -.ad -.sp .6 -.RS 4n -This line identifies a directory (or pair of directories) under which files -should be packed and synchronized. At least one directory name must be -specified. For rules that are to be used by \fBfilesync\fR a second directory -name (where the copies are to be kept) must also be specified. The arguments -must be fully qualified path names, and may include environment variables. -.RE - -.sp -.ne 2 -.na -\fB\fBLIST\fR \fIname\fR \|.\|.\|.\fR -.ad -.sp .6 -.RS 4n -This line enumerates a list of files and sub-directories (beneath the current -\fBBASE)\fR that are to be kept synchronized. This specification is recursive, -in that specifying the name of a directory automatically includes all files and -subdirectories it contains. Regular expressions (as described in \fBglob\fR -and \fBgmatch\fR) are permitted. See \fBglob\fR(1) and \fBgmatch\fR(3GEN). -.RE - -.sp -.ne 2 -.na -\fB\fBIGNORE\fR \fIname\fR \|.\|.\|.\fR -.ad -.sp .6 -.RS 4n -This line enumerates a list of files that are not to be kept synchronized. -Regular expressions (using \fBglob\fR and \fBgmatch\fR) are permitted. -.RE - -.sp -.LP -There are important differences between the arguments to \fBLIST\fR and -\fBIGNORE\fR statements. The arguments to a \fBLIST\fR statement can contain -slashes and are interpreted as file names relative to the \fBBASE\fR -directories. The arguments to an \fBIGNORE\fR statement are simpler names or -expressions that cannot contain slashes. An \fBIGNORE\fR statement will not -override a \fBLIST\fR statement. \fBIGNORE\fR statements only exclude files -that are found beneath \fBLISTed\fR directories. -.sp -.LP -If the first name argument to a \fBLIST\fR statement begins with an -exclamation point (`\fB!\fR'), the remainder of the statement will be executed -as a command. The command will be run in the current \fBBASE\fR directory. The -output of the command will be treated as a list of newline separated file -names to be packed/synchronized. The resulting file names will be interpreted -relative to the enclosing \fBBASE\fR directory. -.sp -.LP -If the first name argument to an \fBIGNORE\fR statement begins with an -exclamation point (`\fB!\fR'), the remainder of the statement will be executed -as a command. The command will be run in the current \fBBASE\fR directory. The -command will be expected to figure out which names should not be synchronized. -The output of the command will be treated as a list of newline separated file -names that should be excluded from the packing and synchronization list. -.sp -.LP -Commands will be broken into distinct arguments and run directly with \fBsh -\fR\fB-c\fR. Blanks can be embedded in an argument by escaping them with a -backslash (`\fB\e\fR\&') or enclosing the argument in double quotes (` -\fB"\fR '). Double quotes can be passed in arguments by escaping the double quotes with -a backslash (`\fB\e\fR\&'). -.sp -.LP -\fBLIST\fR lines only apply to the \fBBASE\fR statement that precedes them. -\fBIGNORE\fR lines can appear before any \fBBASE\fR statement (in which case -they apply to all \fBBASEs)\fR or after a \fBBASE\fR statement (in which case -they only apply to the \fBBASE\fR that precedes them). Any number of these -statements can occur in any combination. The order is not important. -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample \fB$\fR\fBHOME\fR\fB\&.packingrules\fR file. -.sp -.LP -The use of these statements is illustrated in the following -\fB$\fR\fBHOME\fR\fB\&.packingrules\fR file. - -.sp -.in +2 -.nf -# -# junk files, not worth copying -# -IGNORE core *.o *.bak *% -# -# most of the stuff I want to keep in sync is in my $HOME -# -BASE /net/bigserver/export/home/myname $HOME -# everything in my work sub-directory should be maintained -LIST work -# a few of my favorite mail boxes should be replicated -LIST m/incoming -LIST m/action -LIST m/pending -# -# I like to carry around a couple of project directories -# but skip all the postscript output -# -BASE /net/bigserver/export/projects $HOME/projects -LIST poindexter epiphany -IGNORE *.ps -# -# the foonly package should always be kept on every machine -# -BASE /net/bigserver/opt/foonly /opt/foonly -LIST !cat .packinglist -# -# and the latest executables for the standard build environment -# -BASE /net/bigserver/export/buildenv $HOME/buildenv -LIST !find . -type f -a -perm -111 -a -print -.fi -.in -2 -.sp - -.SH SEE ALSO -.LP -\fBfile\fR(1), \fBfilesync\fR(1) diff --git a/usr/src/man/man4/pam.conf.4 b/usr/src/man/man4/pam.conf.4 deleted file mode 100644 index 959030f496..0000000000 --- a/usr/src/man/man4/pam.conf.4 +++ /dev/null @@ -1,462 +0,0 @@ -'\" te -.\" Copyright (C) 2006, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 PAM.CONF 4 "Mar 4, 2017" -.SH NAME -pam.conf \- configuration file for pluggable authentication modules -.SH SYNOPSIS -.LP -.nf -\fB/etc/pam.conf\fR -.fi - -.SH DESCRIPTION -.LP -\fBpam.conf\fR is the configuration file for the Pluggable Authentication -Module architecture, or \fBPAM\fR. A \fBPAM\fR module provides functionality -for one or more of four possible services: authentication, account management, -session management, and password management. -.sp -.ne 2 -.na -\fBauthentication service module\fR -.ad -.sp .6 -.RS 4n -Provides functionality to authenticate a user and set up user credentials. -.RE - -.sp -.ne 2 -.na -\fBaccount management module\fR -.ad -.sp .6 -.RS 4n -Provides functionality to determine if the current user's account is valid. -This includes checking for password and account expiration, as well as -verifying access hour restrictions. -.RE - -.sp -.ne 2 -.na -\fBsession management module\fR -.ad -.sp .6 -.RS 4n -Provides functionality to set up and terminate login sessions. -.RE - -.sp -.ne 2 -.na -\fBpassword management module\fR -.ad -.sp .6 -.RS 4n -Provides functionality to change a user's authentication token or password. -.RE - -.sp -.LP -Each of the four service modules can be implemented as a shared library object -which can be referenced in the \fBpam.conf\fR configuration file. -.SS "Simplified pam.conf Configuration File" -.LP -The \fBpam.conf\fR file contains a listing of services. Each service is paired -with a corresponding service module. When a service is requested, its -associated module is invoked. Each entry may be a maximum of 256 characters, -including the end of line, and has the following format: -.sp -.in +2 -.nf -\fIservice_name module_type control_flag module_path options\fR -.fi -.in -2 -.sp - -.sp -.LP -The following is an example of a \fBpam.conf\fR configuration file with support -for authentication, account management, session management and password -management modules (See the \fBpam.conf\fR file that is shipped with your -system for the contents of this file): -.sp -.in +2 -.nf -login auth requisite pam_authtok_get.so.1 -login auth required pam_dhkeys.so.1 -login auth required pam_unix_auth.so.1 -login auth required pam_dial_auth.so.1 - -other account requisite pam_roles.so.1 -other account required pam_unix_account.so.1 - -other session required pam_unix_session.so.1 - -other password required pam_dhkeys.so.1 -other password requisite pam_authtok_get.so.1 -other password requisite pam_authtok_check.so.1 -other password required pam_authtok_store.so.1 -.fi -.in -2 - -.sp -.LP -\fIservice_name\fR denotes the service (for example, \fBlogin\fR, -\fBdtlogin\fR, or \fBrlogin\fR). -.sp -.LP -The keyword, "\fBother\fR," indicates the module that all other applications -which have not been specified should use. The "\fBother\fR" keyword can also be -used if all services of the same \fImodule_type\fR have the same requirements. -.sp -.LP -In the example, since all of the services use the same session module, they -could have been replaced by a single \fBother\fR line. -.sp -.LP -\fImodule_type\fR denotes the service module type: authentication (\fBauth\fR), -account management (\fBaccount\fR), session management (\fBsession\fR), or -password management (\fBpassword\fR). -.sp -.LP -The \fIcontrol_flag\fR field determines the behavior of stacking. -.sp -.LP -The \fImodule_path\fR field specifies the relative pathname to a shared library -object, or an included \fBPAM\fR configuration file, which implements the -service functionality. If the pathname is not absolute, shared library objects -are assumed to be relative to \fB/usr/lib/security/$ISA/\fR, and included -\fBPAM\fR configuration files are assumed to be relative to -\fB/usr/lib/security/\fR. -.sp -.LP -The \fBISA\fR token is replaced by an implementation defined directory name -which defines the path relative to the calling program's instruction set -architecture. -.sp -.LP -The \fIoptions\fR field is used by the \fBPAM\fR framework layer to pass module -specific options to the modules. It is up to the module to parse and interpret -the options. -.sp -.LP -This field can be used by the modules to turn on debugging or to pass any -module specific parameters such as a \fBTIMEOUT\fR value. The options supported -by the modules are documented in their respective manual pages. -.SS "Integrating Multiple Authentication Services With Stacking" -.LP -When a \fIservice_name\fR of the same \fImodule_type\fR is defined more than -once, the service is said to be stacked. Each module referenced in the -\fImodule_path\fR for that service is then processed in the order that it -occurs in the configuration file. The \fIcontrol_flag\fR field specifies the -continuation and failure semantics of the modules, and can contain one of the -following values: -.sp -.ne 2 -.na -\fB\fBbinding\fR\fR -.ad -.RS 14n -If the service module returns success and no preceding \fBrequired\fR modules -returned failures, immediately return success without calling any subsequent -modules. If a failure is returned, treat the failure as a \fBrequired\fR module -failure, and continue to process the \fBPAM\fR stack. -.RE - -.sp -.ne 2 -.na -\fB\fBinclude\fR\fR -.ad -.RS 14n -Process the lines from the \fBPAM\fR configuration file that is specified in -the \fImodule_path\fR at this point in the \fBPAM\fR stack. The ``\fBother\fR'' -keyword is used if the specified service_name is not found. 32 levels of -included \fBPAM\fR configuration files are supported. Any options are ignored. -.RE - -.sp -.ne 2 -.na -\fB\fBoptional\fR\fR -.ad -.RS 14n -If the service module returns success, record the success, and continue to -process the \fBPAM\fR stack. If a failure is returned, and it is the first -\fBoptional\fR module failure, save the failure code as an \fBoptional\fR -failure. Continue to process the \fBPAM\fR stack. -.RE - -.sp -.ne 2 -.na -\fB\fBrequired\fR\fR -.ad -.RS 14n -If the service module returns success, record the success, and continue to -process the \fBPAM\fR stack. If a failure is returned, and it is the first -\fBrequired\fR failure, save the failure code as a \fBrequired\fR failure. -Continue to process the \fBPAM\fR stack. -.RE - -.sp -.ne 2 -.na -\fB\fBrequisite\fR\fR -.ad -.RS 14n -If the service module returns success, record the success, and continue to -process the \fBPAM\fR stack. If a failure is returned, immediately return the -first non-optional failure value recorded without calling any subsequent -modules. That is, return this failure unless a previous required service module -failed. If a previous required service module failed, then return the first of -those values. -.RE - -.sp -.ne 2 -.na -\fB\fBsufficient\fR\fR -.ad -.RS 14n -If the service module return success and no preceding required modules returned -failures, immediately return success without calling any subsequent modules. If -a failure is returned, treat the failure as an optional module failure, and -continue to process the \fBPAM\fR stack. -.RE - -.sp -.LP -If the \fBPAM\fR stack runs to completion, that is, neither a \fBrequisite\fR -module failed, nor a \fBbinding\fR or \fBsufficient\fR module success stops it, -success is returned if no required modules failed and at least one required, -requisite, optional module succeeded. If no module succeeded and a required or -binding module failed, the first of those errors is returned. If no required or -binding module failed and an optional module failed, the first of the option -module errors is returned. If no module in the stack succeeded or failed, that -is, all modules returned an ignore status, a default error based on module -type, for example, "User account expired," is returned. -.sp -.LP -All errors in \fBpam.conf\fR entries are logged to \fBsyslog\fR as -\fBLOG_AUTH\fR | \fBLOG_ERR\fR errors. The use of a service with an error noted -in the \fBpam.conf\fR entry for that service will fail. The system -administrator will need to correct the noted errors before that service may be -used. If no services are available or the \fBpam.conf\fR file is missing, the -system administrator may enter system maintenance mode to correct or restore -the file. -.sp -.LP -The following is a sample configuration file that stacks the \fBsu\fR, -\fBlogin\fR, and \fBrlogin\fR services. -.sp -.in +2 -.nf -su auth required pam_inhouse.so.1 -su auth requisite pam_authtok_get.so.1 -su auth required pam_dhkeys.so.1 -su auth required pam_unix_auth.so.1 - -login auth requisite pam_authtok_get.so.1 -login auth required pam_dhkeys.so.1 -login auth required pam_unix_auth.so.1 -login auth required pam_dial_auth.so.1 -login auth optional pam_inhouse.so.1 - -rlogin auth sufficient pam_rhosts_auth.so.1 -rlogin auth requisite pam_authtok_get.so.1 -rlogin auth required pam_dhkeys.so.1 -rlogin auth required pam_unix_auth.so.1 -.fi -.in -2 - -.sp -.LP -In the case of \fBsu\fR, the user is authenticated by the \fBinhouse\fR and -\fBauthtok_get\fR, \fBdhkeys\fR, and \fBunix_auth\fR authentication modules. -Because the \fBinhouse\fR and the other authentication modules are -\fBrequired\fR and \fBrequisite\fR, respectively, an error is returned back to -the application if any module fails. In addition, if the \fBrequisite\fR -authentication (\fBpam_authtok_get\fR authentication) fails, the other -authentication modules are never invoked, and the error is returned immediately -back to the application. -.sp -.LP -In the case of \fBlogin\fR, the \fBrequired\fR keyword for \fIcontrol_flag\fR -requires that the user be allowed to login only if the user is authenticated by -all the service modules. If \fBpam_unix_auth\fR authentication fails, control -continues to proceed down the stack, and the \fBinhouse\fR authentication -module is invoked. \fBinhouse\fR authentication is optional by virtue of the -optional keyword in the \fIcontrol_flag\fR field. The user can still log in -even if \fBinhouse\fR authentication fails, assuming the modules stacked above -succeeded. -.sp -.LP -In the case of \fBrlogin\fR, the \fBsufficient\fR keyword for -\fIcontrol_flag\fR specifies that if the \fBrhosts\fR authentication check -succeeds, then \fBPAM\fR should return success to \fBrlogin\fR and \fBrlogin\fR -should not prompt the user for a password. The other authentication modules, -which are in the stack, will only be invoked if the \fBrhosts\fR check fails. -This gives the system administrator the flexibility to determine if -\fBrhosts\fR alone is sufficient enough to authenticate a remote user. -.sp -.LP -Some modules return \fBPAM_IGNORE\fR in certain situations. In these cases the -\fBPAM\fR framework ignores the entire entry in \fBpam.conf\fR regardless of -whether or not it is \fBbinding\fR, \fBrequisite\fR, \fBrequired\fR, -\fBoptional\fR, or \fBsufficient\fR. -.SS "Utilities and Files" -.LP -The specific service names and module types for each service should be -documented in the man page for that service. For instance, the \fBsshd\fR(1M) -man page lists all of the \fBPAM\fR service names and module types for the -\fBsshd\fR command. -.sp -.LP -The \fBPAM\fR configuration file does not dictate either the name or the -location of the service specific modules. The convention, however, is the -following: -.sp -.ne 2 -.na -\fB\fBpam_module_name.so.x\fR\fR -.ad -.RS 29n -File that implements various function of specific authentication services. As -the relative pathname specified, \fB/usr/lib/security/$ISA\fR is prepended to -it. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/pam.conf\fR\fR -.ad -.RS 29n -Configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/$ISA/libpam.so.1\fR\fR -.ad -.RS 29n -File that implements the \fBPAM\fR framework library -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRUsing the include control flag -.sp -.LP -The following example collects the common Unix modules into a single file to be -included as needed in the example of a \fBpam.conf\fR file. The common Unix -module file is named \fBunix_common\fR and consists of: - -.sp -.in +2 -.nf -OTHER auth requisite pam_authtok_get.so.1 -OTHER auth required pam_dhkeys.so.1 -OTHER auth required pam_unix_auth.so.1 -OTHER auth required pam_unix_cred.so.1 -OTHER account requisite pam_roles.so.1 -OTHER account required pam_unix_account.so.1 -OTHER session required pam_unix_session.so.1 -OTHER password required pam_dhkeys.so.1 -OTHER password requisite pam_authtok_get.so.1 -OTHER password requisite pam_authtok_check.so.1 -OTHER password required pam_authtok_store.so.1 -.fi -.in -2 -.sp - -.sp -.LP -The \fBpam.conf\fR file and consists of: - -.sp -.in +2 -.nf -# Authentication management -# -# login service (explicit because of pam_dial_auth) -# -login auth include unix_common -login auth required pam_dial_auth.so.1 -# -# rlogin service (explicit because of pam_rhost_auth) -# -rlogin auth sufficient pam_rhosts_auth.so.1 -rlogin auth include unix_common -# -# Default definitions for Authentication management -# Used when service name is not explicitly mentioned -# -OTHER auth include unix_common -# -# Default definition for Account management -# Used when service name is not explicitly mentioned -# -OTHER account include unix_common -# -# Default definition for Session management -# Used when service name is not explicitly mentioned -# -OTHER session include unix_common -# -# Default definition for Password management -# Used when service name is not explicitly mentioned -# -OTHER password include unix_common -.fi -.in -2 -.sp - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability See Below. -.TE - -.sp -.LP -The format is Stable. The contents has no stability attributes. -.SH SEE ALSO -.LP -\fBlogin\fR(1), \fBpasswd\fR(1), \fBin.rlogind\fR(1M), -\fBin.rshd\fR(1M), \fBin.telnetd\fR(1M), \fBin.uucpd\fR(1M), \fBinit\fR(1M), -\fBsac\fR(1M), \fBttymon\fR(1M), \fBsu\fR(1M), -\fBpam\fR(3PAM), \fBsyslog\fR(3C), \fBlibpam\fR(3LIB), \fBattributes\fR(5), -\fBenviron\fR(5), \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5), -\fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_krb5\fR(5), -\fBpam_passwd_auth\fR(5), \fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5), -\fBpam_unix_session\fR(5) -.SH NOTES -.LP -The \fBpam_unix\fR module is no longer supported. Similar functionality is -provided by \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5), -\fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_passwd_auth\fR(5), -\fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5), and -\fBpam_unix_session\fR(5). -.sp -.LP -With the removal of the \fBpam_unix\fR module, the SunOS delivered PAM service -modules no longer need or support the "\fBuse_first_pass\fR" or -"\fBtry_first_pass\fR" options. This functionality is provided by stacking -\fBpam_authtok_get\fR(5) above a module that requires a password. diff --git a/usr/src/man/man4/passwd.4 b/usr/src/man/man4/passwd.4 deleted file mode 100644 index 168afb7c54..0000000000 --- a/usr/src/man/man4/passwd.4 +++ /dev/null @@ -1,347 +0,0 @@ -'\" te -.\" Copyright (c) 2013 Gary Mills -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 PASSWD 4 "Feb 25, 2017" -.SH NAME -passwd \- password file -.SH SYNOPSIS -.LP -.nf -\fB/etc/passwd\fR -.fi - -.SH DESCRIPTION -.LP -The file \fB/etc/passwd\fR is a local source of information about users' -accounts. The password file can be used in conjunction with other naming -sources, such as the \fBNIS\fR maps \fBpasswd.byname\fR and \fBpasswd.bygid\fR, -or password data stored on an LDAP -server. Programs use the \fBgetpwnam\fR(3C) routines to access this -information. -.sp -.LP -Each \fBpasswd\fR entry is a single line of the form: -.sp -.in +2 -.nf -\fIusername\fR\fB:\fR\fIpassword\fR\fB:\fR\fIuid\fR\fB:\fR -\fIgid\fR\fB:\fR\fIgcos-field\fR\fB:\fR\fIhome-dir\fR\fB:\fR -\fIlogin-shell\fR -.fi -.in -2 -.sp - -.sp -.LP -where -.sp -.ne 2 -.na -\fB\fIusername\fR\fR -.ad -.RS 15n -is the user's login name. -.sp -The login (\fBlogin\fR) and role (\fBrole\fR) fields accept a string of no more -than 32 bytes consisting of characters from the set of alphabetic -characters, numeric characters, period (\fB\&.\fR), underscore (\fB_\fR), and -hyphen (\fB-\fR). The first character should be alphabetic and the field should -contain at least one lower case alphabetic character. A warning message is -displayed if these restrictions are not met. -.sp -The \fBlogin\fR and \fBrole\fR fields must contain at least one character and -must not contain a colon (\fB:\fR) or a newline (\fB\en\fR). -.RE - -.sp -.ne 2 -.na -\fB\fIpassword\fR\fR -.ad -.RS 15n -is an empty field. The encrypted password for the user is in the corresponding -entry in the \fB/etc/shadow\fR file. \fBpwconv\fR(1M) relies on a special value -of '\fBx\fR' in the password field of \fB/etc/passwd\fR. If this value -of '\fBx\fR' exists in the password field of \fB/etc/passwd\fR, this indicates -that the password for the user is already in \fB/etc/shadow\fR and should not -be modified. -.RE - -.sp -.ne 2 -.na -\fB\fIuid\fR\fR -.ad -.RS 15n -is the user's unique numerical \fBID\fR for the system. -.RE - -.sp -.ne 2 -.na -\fB\fIgid\fR\fR -.ad -.RS 15n -is the unique numerical \fBID\fR of the group that the user belongs to. -.RE - -.sp -.ne 2 -.na -\fB\fIgcos-field\fR\fR -.ad -.RS 15n -is the user's real name, along with information to pass along in a mail-message -heading. (It is called the gcos-field for historical reasons.) An ``\fB&\fR\&'' -(ampersand) in this field stands for the login name (in cases where the login -name appears in a user's real name). -.RE - -.sp -.ne 2 -.na -\fB\fIhome-dir\fR\fR -.ad -.RS 15n -is the pathname to the directory in which the user is initially positioned upon -logging in. -.RE - -.sp -.ne 2 -.na -\fB\fIlogin-shell\fR\fR -.ad -.RS 15n -is the user's initial shell program. If this field is empty, the default shell -is \fB/usr/bin/sh\fR. -.RE - -.sp -.LP -The maximum value of the \fIuid\fR and \fIgid\fR fields is \fB2147483647\fR. To -maximize interoperability and compatibility, administrators are recommended to -assign users a range of \fBUID\fRs and \fBGID\fRs below \fB60000\fR where -possible. (\fBUID\fRs from \fB0\fR-\fB99\fR inclusive are reserved by the -operating system vendor for use in future applications. Their use by end system -users or vendors of layered products is not supported and may cause security -related issues with future applications.) -.sp -.LP -The password file is an \fBASCII\fR file that resides in the \fB/etc\fR -directory. Because the encrypted passwords on a secure system are always kept -in the \fBshadow\fR file, \fB/etc/passwd\fR has general read permission on all -systems and can be used by routines that map between numerical user \fBID\fRs -and user names. -.sp -.LP -Blank lines are treated as malformed entries in the \fBpasswd\fR file and cause -consumers of the file , such as \fBgetpwnam\fR(3C), to fail. -.sp -.LP -The password file can contain entries beginning with a `+' (plus sign) or '-' -(minus sign) to selectively incorporate entries from another naming service -source, such as NIS or LDAP. -.sp -.LP -A line beginning with a '+' means to incorporate entries from the naming -service source. There are three styles of the '+' entries in this file. A -single + means to insert all the entries from the alternate naming service -source at that point, while a +\fIname\fR means to insert the specific entry, -if one exists, from the naming service source. A +@\fInetgroup\fR means to -insert the entries for all members of the network group \fInetgroup\fR from the -alternate naming service. If a +\fIname\fR entry has a non-null \fBpassword\fR, -\fIgcos\fR, \fIhome-dir\fR, or \fIlogin-shell\fR field, the value of that field -overrides what is contained in the alternate naming service. The \fIuid\fR and -\fIgid\fR fields cannot be overridden. -.sp -.LP -A line beginning with a `\(mi' means to disallow entries from the alternate -naming service. There are two styles of `-` entries in this file. -\fIname\fR -means to disallow any subsequent entries (if any) for \fIname\fR (in this file -or in a naming service), and -@\fInetgroup\fR means to disallow any subsequent -entries for all members of the network group \fInetgroup\fR. -.sp -.LP -This is also supported by specifying ``passwd : compat'' in -\fBnsswitch.conf\fR(4). The "compat" source might not be supported in future -releases. The preferred sources are \fBfiles\fR followed by the identifier of a -name service, such as \fBnis\fR or \fBldap\fR. This has the effect of -incorporating the entire contents of the naming service's \fBpasswd\fR database -or password-related information after the \fBpasswd\fR file. -.sp -.LP -Note that in compat mode, for every \fB/etc/passwd\fR entry, there must be a -corresponding entry in the \fB/etc/shadow\fR file. -.sp -.LP -Appropriate precautions must be taken to lock the \fB/etc/passwd\fR file -against simultaneous changes if it is to be edited with a text editor; -\fBvipw\fR(1B) does the necessary locking. -.SH EXAMPLES -.LP -\fBExample 1 \fRSample \fBpasswd\fR File -.sp -.LP -The following is a sample \fBpasswd\fR file: - -.sp -.in +2 -.nf -root:x:0:1:Super-User:/:/sbin/sh -fred:6k/7KCFRPNVXg:508:10:& Fredericks:/usr2/fred:/bin/csh -.fi -.in -2 -.sp - -.sp -.LP -and the sample password entry from \fBnsswitch.conf\fR: - -.sp -.in +2 -.nf -passwd: files ldap -.fi -.in -2 -.sp - -.sp -.LP -In this example, there are specific entries for users \fBroot\fR and \fBfred\fR -to assure that they can login even when the system is running single-user. In -addition, anyone whose password information is stored on an LDAP server will be -able to login with their usual password, shell, and home directory. - -.sp -.LP -If the password file is: - -.sp -.in +2 -.nf -root:x:0:1:Super-User:/:/sbin/sh -fred:6k/7KCFRPNVXg:508:10:& Fredericks:/usr2/fred:/bin/csh -+ -.fi -.in -2 -.sp - -.sp -.LP -and the password entry in \fBnsswitch.conf\fR is: - -.sp -.in +2 -.nf -passwd: compat -.fi -.in -2 -.sp - -.sp -.LP -then all the entries listed in the \fBNIS\fR \fBpasswd.byuid\fR and -\fBpasswd.byname\fR maps will be effectively incorporated after the entries for -\fBroot\fR and \fBfred\fR. If the password entry in \fBnsswitch.conf\fR is: - -.sp -.in +2 -.nf -passwd_compat: ldap -passwd: compat -.fi -.in -2 - -.sp -.LP -then all password-related entries stored on the LDAP server will be -incorporated after the entries for \fBroot\fR and \fBfred\fR. - -.sp -.LP -The following is a sample \fBpasswd\fR file when \fBshadow\fR does not exist: - -.sp -.in +2 -.nf -root:q.mJzTnu8icf.:0:1:Super-User:/:/sbin/sh -fred:6k/7KCFRPNVXg:508:10:& Fredericks:/usr2/fred:/bin/csh -+john: -+@documentation:no-login: -+::::Guest -.fi -.in -2 -.sp - -.sp -.LP -The following is a sample \fBpasswd\fR file when \fBshadow\fR does exist: - -.sp -.in +2 -.nf -root:##root:0:1:Super-User:/:/sbin/sh -fred:##fred:508:10:& Fredericks:/usr2/fred:/bin/csh -+john: -+@documentation:no-login: -+::::Guest -.fi -.in -2 -.sp - -.sp -.LP -In this example, there are specific entries for users \fBroot\fR and -\fBfred\fR, to assure that they can log in even when the system is running -standalone. The user \fBjohn\fR will have his password entry in the naming -service source incorporated without change, anyone in the netgroup -\fBdocumentation\fR will have their password field disabled, and anyone else -will be able to log in with their usual password, shell, and home directory, -but with a \fIgcos\fR field of \fBGuest\fR - -.SH FILES -.ne 2 -.na -\fB\fB/etc/nsswitch.conf\fR\fR -.ad -.RS 22n - -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/passwd\fR\fR -.ad -.RS 22n - -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/shadow\fR\fR -.ad -.RS 22n - -.RE - -.SH SEE ALSO -.LP -\fBchgrp\fR(1), \fBchown\fR(1), \fBfinger\fR(1), \fBgroups\fR(1), -\fBlogin\fR(1), \fBnewgrp\fR(1), \fBpasswd\fR(1), -\fBsh\fR(1), \fBsort\fR(1), \fBdomainname\fR(1M), \fBgetent\fR(1M), -\fBpassmgmt\fR(1M), \fBpwck\fR(1M), \fBpwconv\fR(1M), -\fBsu\fR(1M), \fBuseradd\fR(1M), \fBuserdel\fR(1M), \fBusermod\fR(1M), -\fBa64l\fR(3C), \fBcrypt\fR(3C), \fBgetpw\fR(3C), \fBgetpwnam\fR(3C), -\fBgetspnam\fR(3C), \fBputpwent\fR(3C), \fBgroup\fR(4), \fBhosts.equiv\fR(4), -\fBnsswitch.conf\fR(4), \fBshadow\fR(4), \fBenviron\fR(5), -\fBunistd.h\fR(3HEAD) -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR diff --git a/usr/src/man/man4/path_to_inst.4 b/usr/src/man/man4/path_to_inst.4 deleted file mode 100644 index af77f404dd..0000000000 --- a/usr/src/man/man4/path_to_inst.4 +++ /dev/null @@ -1,140 +0,0 @@ -'\" te -.\" Copyright 1992 Sun Microsystems Inc. -.\" 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 PATH_TO_INST 4 "May 18, 2007" -.SH NAME -path_to_inst \- device instance number file -.SH SYNOPSIS -.LP -.nf -\fB/etc/path_to_inst\fR -.fi - -.SH DESCRIPTION -.sp -.LP -\fB/etc/path_to_inst\fR records mappings of physical device names to instance -numbers. -.sp -.LP -The instance number of a device is encoded in its minor number, and is the way -that a device driver determines which of the possible devices that it may drive -is referred to by a given special file. -.sp -.LP -In order to keep instance numbers persistent across reboots, the system records -them in \fB/etc/path_to_inst\fR. -.sp -.LP -This file is read only at boot time, and is updated by \fBadd_drv\fR(1M) and -\fBdevfsadm\fR(1M). -.sp -.LP -Note that it is generally not necessary for the system administrator to change -this file, as the system will maintain it. -.sp -.LP -The system administrator can change the assignment of instance numbers by -editing this file and doing a reconfiguration reboot. However, any changes made -in this file will be lost if \fBadd_drv\fR(1M) or \fBdevfsadm\fR(1M) is run -before the system is rebooted. -.sp -.LP -Each instance entry is a single line of the form: -.sp -.in +2 -.nf -\fB"\fR\fIphysical name\fR\fB"\fR \fIinstance\fR \fInumber\fR \fB"\fR\fIdriver binding name\fR\fB"\fR -.fi -.in -2 - -.sp -.LP -where -.sp -.ne 2 -.na -\fB\fIphysical\fR \fIname\fR\fR -.ad -.RS 23n -is the absolute physical pathname of a device. This pathname must be enclosed -in double quotes. -.RE - -.sp -.ne 2 -.na -\fB\fIinstance number\fR\fR -.ad -.RS 23n -is a decimal or hexadecimal number. -.RE - -.sp -.ne 2 -.na -\fB\fIdriver binding name\fR\fR -.ad -.RS 23n -is the name used to determine the driver for the device. This name may be a -driver alias or a driver name. The driver binding name must be enclosed in -double quotes. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRSample \fBpath_to_inst\fR Entries -.sp -.LP -Here are some sample \fBpath_to_inst\fR entries: - -.sp -.in +2 -.nf -"/iommu@f,e0000000" 0 "iommu" -"/iommu@f,e0000000/sbus@f,e0001000" 0 "sbus" -"/iommu@f,e0000000/sbus@f,e0001000/sbusmem@e,0" 14 "sbusmem" -"/iommu@f,e0000000/sbus@f,e0001000/sbusmem@f,0" 15 "sbusmem" -"/iommu@f,e0000000/sbus@f,e0001000/ledma@f,400010" 0 "ledma" -"/obio/serial@0,100000" 0 "zs" -"/SUNW,sx@f,80000000" 0 "SUNW,sx" -.fi -.in -2 -.sp - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/path_to_inst\fR\fR -.ad -.RS 21n -Mapping of physical device names to instance numbers. -.RE - -.SH SEE ALSO -.sp -.LP -\fBadd_drv\fR(1M), \fBboot\fR(1M), \fBdevfsadm\fR(1M), \fBmknod\fR(1M) -.SH WARNINGS -.sp -.LP -If the file is removed the system may not be bootable (as it may rely on -information found in this file to find the root, usr or swap device). If it -does successfully boot, it will regenerate the file, but after rebooting -devices may end up having different minor numbers than they did before, and -special files created via \fBmknod\fR(1M) may refer to different devices than -expected. -.sp -.LP -For the same reasons, changes should not be made to this file without careful -consideration. -.SH NOTES -.sp -.LP -This document does not constitute an API. \fBpath_to_inst\fR may not exist or -may have a different content or interpretation in a future release. The -existence of this notice does not imply that any other documentation that lacks -this notice constitutes an API. diff --git a/usr/src/man/man4/pci.4 b/usr/src/man/man4/pci.4 deleted file mode 100644 index 7df0d6be9a..0000000000 --- a/usr/src/man/man4/pci.4 +++ /dev/null @@ -1,271 +0,0 @@ -'\" te -.\" Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved -.\" 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 PCI 4 "May 13, 2017" -.SH NAME -pci, pcie \- configuration files for PCI and PCI Express device drivers -.SH DESCRIPTION -.LP -The Peripheral Component Interconnect (PCI) bus is a little endian bus. PCI -Express (PCIe) and PCI-X are successors to PCI. All three types of devices -share the same configuration parameters. What is specified here for PCI devices -applies to PCI-X 1.0 devices as well. All three types of devices are -self-identifying, which means that these devices provide configuration -parameters to the system that allow the system to identify the device and its -driver. The configuration parameters are represented in the form of name-value -pairs that can be retrieved using the \fBDDI\fR property interfaces. See -\fBddi_prop_lookup\fR(9F) for details. -.sp -.LP -The bus properties of PCI devices or logical bus properties of PCIe devices are -derived from PCI configuration space, or supplied by the Fcode \fBPROM\fR, if -it exists. Therefore, driver configuration files are not necessary for these -devices. -.sp -.LP -On some occasions, drivers for \fBPCI\fR and PCIe devices can use driver -configuration files to provide driver private properties through the global -property mechanism. See \fBdriver.conf\fR(4) for further details. Driver -configuration files can also be used to augment or override properties for a -specific instance of a driver. -.sp -.LP -All bus drivers of PCI and PCIe devices recognize the following properties: -.sp -.ne 2 -.na -\fB\fBreg\fR\fR -.ad -.RS 14n -An arbitrary length array where each element of the array consists of a 5-tuple -of 32-bit values. Each array element describes a logically contiguous mappable -resource on the \fBPCI\fR bus or PCIe device tree. -.sp -The first three values in the 5-tuple describe the \fBPCI\fR address of the -mappable resource. The first tuple contains the following information: -.sp - -.sp -.TS -l l l -l l l . -Bits 0 - 7 8-bit register number -Bits 8 - 10 3-bit function number -Bits 11 - 15 5-bit device number -Bits 16 - 23 8-bit bus number -Bits 24 - 25 2-bit address space type identifier -Bits 31 - 28 T{ -Register number extended bits 8:11 for extended config space. Zero for conventional configuration space. -T} -.TE - -The address space type identifier can be interpreted as follows: -.sp - -.sp -.TS -l l l -l l l . -0x0 configuration space -0x1 I/O space -0x2 32-bit memory space address -0x3 64-bit memory space address -.TE - -The bus number is a unique identifying number assigned to each \fBPCI\fR bus or -PCIe logical bus within its domain. -.sp -The device number is a unique identifying number assigned to each device on a -\fBPCI\fR bus or PCIe logical bus. Note that a device number is unique only -within the set of device numbers for a particular bus or logical bus. -.sp -Each \fBPCI\fR or PCIe device can have one to eight logically independent -functions, each with its own independent set of configuration registers. Each -function on a device is assigned a function number. For a device with only one -function, the function number must be \fB0\fR. -.sp -The register number fields select a particular register within the set of -configuration registers corresponding to the selected function. When the -address space type identifier indicates configuration space, non-zero register -number extended bits select registers in extended configuration space. -.sp -The second and third values in the \fBreg\fR property 5-tuple specify the -64-bit address of the mappable resource within the \fBPCI\fR or PCIe address -domain. The second 32-bit tuple corresponds to the high order four bytes of the -64-bit address. The third 32-bit tuple corresponds to the low order bytes. -.sp -The fourth and fifth 32-bit values in the 5-tuple \fBreg\fR property specify -the size of the mappable resource. The size is a 64-bit value, where the fourth -tuple corresponds to the high order bytes of the 64-bit size and the fifth -corresponds to the low order. -.sp -The driver can refer to the elements of this array by index, and construct -kernel mappings to these addresses using \fBddi_regs_map_setup\fR(9F). The -index into the array is passed as the \fIrnumber\fR argument of -\fBddi_regs_map_setup\fR(9F). -.sp -At a high-level interrupt context, you can use the \fBddi_get*\fR and -\fBddi_put*\fR family of functions to access I/O and memory space. However, -access to configuration space is not allowed when running at a high-interrupt -level. -.RE - -.sp -.ne 2 -.na -\fB\fBinterrupts\fR\fR -.ad -.RS 14n -This property consists of a single-integer element array. Valid interrupt -property values are \fB1\fR, \fB2\fR, \fB3\fR, and \fB4\fR. This value is -derived directly from the contents of the device's configuration-interrupt-pin -register. -.sp -A driver should use an index value of \fB0\fR when registering its interrupt -handler with the DDI interrupt interfaces. -.RE - -.sp -.LP -All \fBPCI\fR and PCIe devices support the \fBreg\fR property. The device -number and function number as derived from the \fBreg\fR property are used to -construct the address part of the device name under \fB/devices\fR. -.sp -.LP -Only devices that generate interrupts support an \fBinterrupts\fR property. -.sp -.LP -Occasionally it might be necessary to override or augment the configuration -information supplied by a \fBPCI\fR or PCIe device. This change can be achieved -by writing a driver configuration file that describes a prototype device node -specification containing the additional properties required. -.sp -.LP -For the system to merge the prototype node specification into an actual device -node, certain conditions must be met. -.RS +4 -.TP -.ie t \(bu -.el o -First, the \fBname\fR property must be identical. The value of the \fBname\fR -property needs to match the binding name of the device. The binding name is the -name chosen by the system to bind a driver to a device and is either an alias -associated with the driver or the hardware node name of the device. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Second, the parent property must identify the PCI bus or PCIe logical bus. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Third, the unit-address property must identify the card. The format of the -unit-address property is: -.RE -.sp -.LP -\fBDD[,F]\fR -.sp -.LP -where \fBDD\fR is the device number and \fBF\fR is the function number. If the -function number is 0, only \fBDD\fR is specified. -.SH EXAMPLES -.LP -\fBExample 1 \fRSample Configuration File -.sp -.LP -An example configuration file called \fBACME,scsi-hba.conf\fR for a \fBPCI\fR -driver called \fBACME,scsi-hba\fR follows: - -.sp -.in +2 -.nf -# -# Copyright (c) 1995, ACME SCSI Host Bus Adaptor -# ident "@(#)ACME,scsi-hba.conf 1.1 96/02/04" -name="ACME,scsi-hba" parent="/pci@1,0/pci@1f,4000" - unit-address="3" scsi-initiator-id=6; -hba-advanced-mode="on"; -hba-dma-speed=10; -.fi -.in -2 -.sp - -.sp -.LP -In this example, a property \fBscsi-initiator-id\fR specifies the \fBSCSI\fR -bus initiator id that the adapter should use, for just one particular instance -of adapter installed in the machine. The \fBname\fR property identifies the -driver and the parent property to identify the particular bus the card is -plugged into. This example uses the parent's full path name to identify the -bus. The unit-address property identifies the card itself, with device number -of 3 and function number of 0. - -.sp -.LP -Two global driver properties are also created: \fBhba-advanced-mode\fR (which -has the string value \fBon\fR) and \fBhba-dma-speed\fR (which has the value -\fB10\fR M bit/s). These properties apply to all device nodes of the -\fBACME,scsi-hba\fR. - -.sp -.LP -Configuration files for PCIe devices are similar. Shown below is an example -configuration file called \fBACME,pcie-widget.conf\fR for a PCIe driver called -\fBACME,pcie-widget\fR. - -.sp -.in +2 -.nf -# -# Copyright (c) 2005, ACME PCIe Widget Adapter -# ident "@(#)ACME,pcie-widget.conf 1.1 05/11/14" -name="ACME,pcie-widget" parent="/pci@780" unit-address="2,1" -debug-mode=12; -.fi -.in -2 -.sp - -.sp -.LP -In this example, we provide a property \fBdebug-mode\fR for a particular PCIe -device. As before, the logical bus is identified by the pathname of the parent -of the device. The device has a device number of 2, and a function number of 1. - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC, x86 -.TE - -.SH SEE ALSO -.LP -\fBdriver.conf\fR(4), \fBattributes\fR(5), \fBddi_intr_add_handler\fR(9F), -\fBddi_prop_lookup\fR(9F), \fBddi_regs_map_setup\fR(9F) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIIEEE 1275 PCI Bus Binding\fR -.SH NOTES -.LP -PCIe devices support an extended configuration space unavailable to PCI -devices. While PCIe devices can be operated using a PCI device driver, -operating them using a PCIe device driver can make use of the extended -properties and features made available only in the extended configuration -space. diff --git a/usr/src/man/man4/phones.4 b/usr/src/man/man4/phones.4 deleted file mode 100644 index 06f8f42dc8..0000000000 --- a/usr/src/man/man4/phones.4 +++ /dev/null @@ -1,59 +0,0 @@ -'\" te -.\" Copyright (c) 1992, Sun Microsystems, Inc. -.\" 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 PHONES 4 "Jan 14, 1992" -.SH NAME -phones \- remote host phone number database -.SH SYNOPSIS -.LP -.nf -\fB/etc/phones\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The file \fB/etc/phones\fR contains the system-wide private phone numbers for -the \fBtip\fR(1) program. \fB/etc/phones\fR is normally unreadable, and so may -contain privileged information. The format of \fB/etc/phones\fR is a series of -lines of the form: -.sp -.in +2 -.nf -\fB<\fR\fIsystem-name\fR\fB>[ \et]*<\fR\fIphone-number\fR\fB>.\fR -.fi -.in -2 - -.sp -.LP -The system name is one of those defined in the \fBremote\fR(4) file and the -phone number is constructed from \fB[0123456789\(mi=*%]\fR. The `\fB=\fR' and -`\fB*\fR' characters are indicators to the auto call units to pause and wait -for a second dial tone (when going through an exchange). The `\fB=\fR' is -required by the \fBDF02-AC\fR and the `\fB*\fR' is required by the -\fBBIZCOMP\fR 1030. -.sp -.LP -Comment lines are lines containing a `\fB#\fR' sign in the first column of the -line. -.sp -.LP -Only one phone number per line is permitted. However, if more than one line in -the file contains the same system name \fBtip\fR(1) will attempt to dial each -one in turn, until it establishes a connection. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/phones\fR\fR -.ad -.RS 15n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBtip\fR(1), \fBremote\fR(4) diff --git a/usr/src/man/man4/pkginfo.4 b/usr/src/man/man4/pkginfo.4 deleted file mode 100644 index 3dd34ea876..0000000000 --- a/usr/src/man/man4/pkginfo.4 +++ /dev/null @@ -1,748 +0,0 @@ -'\" te -.\" Copyright 2017 Peter Tribble -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 PKGINFO 4 "Nov 26, 2017" -.SH NAME -pkginfo \- package characteristics file -.SH DESCRIPTION -.LP -\fBpkginfo\fR is an \fBASCII\fR file that describes the characteristics of the -package along with information that helps control the flow of installation. It -is created by the software package developer. -.sp -.LP -Each entry in the \fBpkginfo\fR file is a line that establishes the value of a -parameter in the following form: -.sp -.in +2 -.nf -PARAM="\fIvalue\fR" -.fi -.in -2 - -.sp -.LP -There is no required order in which the parameters must be specified within the -file. The \fBPKG\fR, \fBNAME\fR, \fBARCH\fR, \fBVERSION\fR and \fBCATEGORY\fR -parameters are mandatory. Other parameters are optional. -.sp -.LP -\fBpkginfo\fR provides optional parameters and an environment variable in -support of the zones (multiple Solaris environments) feature. See -\fBzones\fR(5). -.sp -.LP -The following parameters are mandatory: -.sp -.ne 2 -.na -\fB\fBARCH\fR\fR -.ad -.sp .6 -.RS 4n -A comma-separated list of alphanumeric tokens that indicate the architecture -associated with the package. The \fBpkgmk\fR(1) tool can be used to create or -modify this value when actually building the package. The maximum length of a -token is 16 characters and it cannot include a comma. -.sp -Solaris's installation software meaningfully uses only one architecture token -of the form: -.sp -.in +2 -.nf -<\fIinstruction_set_architecture\fR>[.<\fIplatform_group\fR>] -.fi -.in -2 - -where \fIplatform_group\fR is intended only for Solaris installation packages. -Third party application software should restrict itself to \fBARCH\fR values -from the following Solaris-supported instruction set architectures (\fBuname --p\fR): \fBsparc\fR, \fBi386\fR, and \fBppc\fR. Examples of Solaris' platform -groups (\fBuname -m\fR) are \fBsun4u\fR for the \fBSPARC\fR instruction set and -\fBi86pc\fR for the i386 instruction set. See \fBuname\fR(1) and -\fBisalist\fR(1) for more details. -.RE - -.sp -.ne 2 -.na -\fB\fBCATEGORY\fR\fR -.ad -.sp .6 -.RS 4n -A comma-separated list of categories under which a package can be displayed. A -package must at least belong to the system or application category. Categories -are case-insensitive and can contain only alphanumerics. Each category is -limited in length to 16 characters. -.RE - -.sp -.ne 2 -.na -\fB\fBNAME\fR\fR -.ad -.sp .6 -.RS 4n -Text that specifies the package name (maximum length of 256 \fBASCII\fR -characters). Use the \fBNAME\fR parameter as the foundation for describing the -functionality and purpose of the package; spell out any acronyms and avoid -internal product/project code names. The \fBDESC\fR parameter can then be used -to expand the descriptive information. Use the \fBNAME\fR parameter to state as -specifically as possible the use of the package, why a user would need to load -it, and so on. -.RE - -.sp -.ne 2 -.na -\fB\fBPKG\fR\fR -.ad -.sp .6 -.RS 4n -Abbreviation for the package being installed. All characters in the -abbreviation must be alphanumeric. You can also use the \fB\(mi\fR and \fB+\fR -characters in the abbreviation. The first character cannot be numeric, a -\fB+\fR or a \fB-\fR. -.sp -The abbreviation is limited to a maximum length of 32 characters. -\fBinstall\fR, \fBnew\fR, and \fBall\fR are reserved abbreviations. It is -customary to make the first four letters unique to your company, such as the -company's stock symbol. -.RE - -.sp -.ne 2 -.na -\fB\fBVERSION\fR\fR -.ad -.sp .6 -.RS 4n -Text that specifies the current version associated with the software package. -The maximum length is 256 \fBASCII\fR characters and the first character cannot -be a left parenthesis. The \fBpkgmk\fR(1) tool can be used to create or modify -this value when actually building the package. Traditional Solaris -practice was to assign this parameter monotonically increasing Dewey decimal -values of the form: -.sp -.in +2 -.nf -<\fImajor_revision\fR>.<\fIminor_revision\fR>[.<\fImicro_revision\fR>] -.fi -.in -2 - -where all the revision fields are integers. The versioning fields can be -extended to an arbitrary string of numbers in Dewey-decimal format, if -necessary. -.RE - -.sp -.LP -The following parameters are optional: -.sp -.ne 2 -.na -\fB\fBBASEDIR\fR\fR -.ad -.sp .6 -.RS 4n -The pathname to a default directory where "relocatable" files can be installed. -If blank, the package is not relocatable and any files that have relative -pathnames are not installed. An administrator can override the default -directory. -.RE - -.sp -.ne 2 -.na -\fB\fBCLASSES\fR\fR -.ad -.sp .6 -.RS 4n -A space-separated list of classes defined for a package. The order of the list -determines the order in which the classes are installed. Classes listed first -are installed first (on a media by media basis). This parameter can be modified -by the request script. -.RE - -.sp -.ne 2 -.na -\fB\fBDESC\fR\fR -.ad -.sp .6 -.RS 4n -Text that describes the package (maximum length of 256 \fBASCII\fR characters). -This parameter value is used to provide the installer with a description of -what the package contains and should build on the description provided in the -\fBNAME\fR parameter. Try to make the two parameters work together so that a -\fBpkginfo\fR \fB-l\fR provides a fairly comprehensive textual description of -the package. -.RE - -.sp -.ne 2 -.na -\fB\fBEMAIL\fR\fR -.ad -.sp .6 -.RS 4n -An electronic address where further information is available or bugs can be -reported (maximum length of 256 \fBASCII\fR characters). -.RE - -.sp -.ne 2 -.na -\fB\fBHOTLINE\fR\fR -.ad -.sp .6 -.RS 4n -Phone number and/or mailing address where further information can be received -or bugs can be reported (maximum length of 256 \fBASCII\fR characters). -.RE - -.sp -.ne 2 -.na -\fB\fBINTONLY\fR\fR -.ad -.sp .6 -.RS 4n -Indicates that the package should only be installed interactively when set to -any non-null value. -.RE - -.sp -.ne 2 -.na -\fB\fBISTATES\fR\fR -.ad -.sp .6 -.RS 4n -A list of allowable run states for package installation (for example, "\fBS s -1\fR" allows run states of \fBS\fR, \fBs\fR or \fB1\fR). The Solaris operating -environment supports the run levels \fBs\fR, \fBS\fR, \fB0\fR, \fB1\fR, -\fB2\fR, \fB3\fR, \fB5\fR, and \fB6\fR. Applicable run levels for this -parameter are \fBs\fR, \fBS\fR, \fB1\fR, \fB2\fR, and \fB3\fR. See -\fBinit\fR(1M) for details. -.RE - -.sp -.ne 2 -.na -\fB\fBMAXINST\fR\fR -.ad -.sp .6 -.RS 4n -The maximum number of package instances that should be allowed on a machine at -the same time. By default, only one instance of a package is allowed. This -parameter must be set in order to have multiple instances of a package. In -order to support multiple instances of packages (for example, packages that -differ in their \fBARCH\fR or \fBVERSION\fR parameter value), the value of this -parameter must be high enough to allow for all instances of a given package, -including multiple versions coexisting on a software server. -.RE - -.sp -.ne 2 -.na -\fB\fBORDER\fR\fR -.ad -.sp .6 -.RS 4n -A list of classes defining the order in which they should be put on the medium. -Used by \fBpkgmk\fR(1) in creating the package. Classes not defined in this -field are placed on the medium using the standard ordering procedures. -.RE - -.sp -.ne 2 -.na -\fB\fBPSTAMP\fR\fR -.ad -.sp .6 -.RS 4n -Production stamp used to mark the \fBpkgmap\fR(4) file on the output volumes. -Provides a means for distinguishing between production copies of a version if -more than one is in use at a time. If \fBPSTAMP\fR is not defined, the default -is used. The default consists of the UNIX system machine name followed by the -string "\fIYYYYMMDDHHMMSS\fR" (year, month, date, hour, minutes, seconds). -.RE - -.sp -.ne 2 -.na -\fB\fBRSTATES\fR\fR -.ad -.sp .6 -.RS 4n -A list of allowable run states for package removal (for example, "\fBS s 1\fR" -allows run states of \fBS\fR, \fBs\fR or \fB1\fR). The Solaris operating -environment supports the run levels \fBs\fR, \fBS\fR, \fB0\fR, \fB1\fR, -\fB2\fR, \fB3\fR, \fB5\fR, and \fB6\fR. Applicable run levels for this -parameter are \fBs\fR, \fBS\fR, \fB1\fR, \fB2\fR, and \fB3\fR See -\fBinit\fR(1M) for details. -.RE - -.sp -.ne 2 -.na -\fB\fBSUNW_ISA\fR\fR -.ad -.sp .6 -.RS 4n -Solaris-only optional parameter that indicates a software package contains -64-bit objects if it is set to \fBsparcv9\fR. If this parameter is not set, the -default \fBISA\fR (instruction set architecture) is set to the value of the -\fBARCH\fR parameter. -.RE - -.sp -.ne 2 -.na -\fB\fBSUNW_PKG_DIR\fR\fR -.ad -.sp .6 -.RS 4n -A value set by \fBpkgadd\fR that contains the location of the installing -package. This value is provided to any install time package procedure scripts -that need to know where the installing package is located. This parameter -should never be set manually from within a \fBpkginfo\fR file. -.RE - -.sp -.ne 2 -.na -\fB\fBSUNW_PKG_ALLZONES\fR\fR -.ad -.sp .6 -.RS 4n -Defines whether a package, when installed, must be installed and must be -identical in all zones. Assigned value can be \fBtrue\fR or \fBfalse\fR. The -default value is \fBfalse\fR. The setting of \fBSUNW_PKG_ALLZONES\fR has the -effects described below. -.sp -If set to \fBtrue\fR, the following conditions are in effect: -.RS +4 -.TP -.ie t \(bu -.el o -The package must be installed in the global zone. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The package must be installed in any non-global zone that is created. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The package must be identical in all zones. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The package can be installed only by the global zone administrator. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The package cannot be installed by a non-global zone administrator. -.RE -If set to \fBfalse\fR, the following conditions are in effect: -.RS +4 -.TP -.ie t \(bu -.el o -The package is not required to be installed in all zones. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The package is not required to be identical across all zones. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The package can be installed by the global zone administrator or by a -non-global zone administrator. -.RE -Packages that must be identical across all zones must set this variable to -\fBtrue\fR. This would include packages that deliver components that are part -of the core operating system, or that are dependent on interfaces exported by -the core operating system, or that deliver device drivers, or runtime libraries -that use or export operating system interfaces that are not guaranteed to be -stable across minor releases. -.sp -Packages that deliver components that are not part of the core operating system -(such as application programs) that can be different between any two zones must -set this variable to \fBfalse\fR. -.sp -With respect to \fBSUNW_PKG_ALLZONES\fR, keep in mind the following: -.RS +4 -.TP -.ie t \(bu -.el o -Use of \fBpkgadd\fR in the global zone installs packages in all zones unless -\fB-G\fR is specified, in which case packages are installed in the global zone -only. The setting of \fBSUNW_PKG_ALLZONES\fR does not change this behavior. For -example, a package that has a setting of \fBSUNW_PKG_ALLZONES=false\fR is not -installed in the global zone only. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The \fBSUNW_PKG_ALLZONES\fR attribute controls whether a package \fBmust\fR be -installed in all zones (and must be the same in all zones) when it is -installed. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Use of the \fB-G\fR option to \fBpkgadd\fR with a package that has -\fBSUNW_PKG_ALLZONES=true\fR is an error and causes installation of that -package to fail. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBSUNW_PKG_HOLLOW\fR\fR -.ad -.sp .6 -.RS 4n -Defines whether a package should be visible in any non-global zone if that -package is required to be installed and be identical in all zones (for example, -a package that has \fBSUNW_PKG_ALLZONES=true\fR). Assigned value can be -\fBtrue\fR or \fBfalse\fR. The default value is \fBfalse\fR. The package is not -required to be installed, but if it is installed, the setting of -\fBSUNW_PKG_HOLLOW\fR has the effects described below. -.sp -If set to \fBfalse\fR, the following conditions are in effect: -.RS +4 -.TP -.ie t \(bu -.el o -If installed in the global zone, the package content and installation -information are required in all non-global zones. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Software delivered by the package is visible in all non-global zones. An -example of such a a package is the package that delivers the \fBtruss\fR(1) -command. -.RE -If set to \fBtrue\fR, the following conditions are in effect: -.RS +4 -.TP -.ie t \(bu -.el o -The package content is not delivered on any non-global zone. However, the -package installation information is required on all non-global zones. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The package delivers software that should not be visible in all non-global -zones. Examples include kernel drivers and system configuration files that work -only in the global zone. This setting allows the non-global zone to resolve -dependencies on packages that are installed only in the global zone without -actually installing the package data. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -In the global zone, the package is recognized as having been installed, and all -components of the package are installed. Directories are created, files are -installed, and class action and other scripts are run as appropriate when the -package is installed. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -In a non-global zone, the package is recognized as having been installed, but -no components of the package are installed. No directories are created, no -files are installed, and no class action or other install scripts are run when -the package is installed. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -When removed from the global zone, the package is recognized as having been -completely installed. Appropriate directories and files are removed, and class -action or other install scripts are run when the package is removed. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -When removed from a non-global zone, the package is recognized as not having -been completely installed. No directories are removed, no files are removed, -and no class action or other install scripts are run when the package is -removed. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The package is recognized as being installed in all zones for purposes of -dependency checking by other packages that rely on this package being -installed. -.RE -If \fBSUNW_PKG_ALLZONES\fR is set to \fBfalse\fR, the value of this variable -has no meaning. It is a package construction error to set -\fBSUNW_PKG_ALLZONES\fR to \fBfalse\fR, then set \fBSUNW_PKG_HOLLOW\fR to -\fBtrue\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBSUNW_PKG_THISZONE\fR\fR -.ad -.sp .6 -.RS 4n -Defines whether a package must be installed in the current zone only. Assigned -value can be \fBtrue\fR or \fBfalse\fR. The default value is \fBfalse\fR. The -setting of \fBSUNW_PKG_THISZONE\fR has the effects described below. -.sp -If set to true, the following conditions are in effect: -.RS +4 -.TP -.ie t \(bu -.el o -The package is installed in the current zone only. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -If installed in the global zone, the package is not added to any currently -existing or yet-to-be-created non-global zones. This is the same behavior that -would occur if the \fB-G\fR option were specified to \fBpkgadd\fR. -.RE -If set to false, the following conditions are in effect: -.RS +4 -.TP -.ie t \(bu -.el o -If \fBpkgadd\fR is run in a non-global zone, the package is installed in the -current zone only. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -If \fBpkgadd\fR is run in the global zone, the package is installed in the -global zone, and is also installed in all currently installed non-global zones. -In addition, the package will be propagated to all future, newly installed -non-global zones. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBSUNW_PKGVERS\fR\fR -.ad -.sp .6 -.RS 4n -Solaris-only parameter indicating of version of the Solaris operating -environment package interface. -.sp -.in +2 -.nf -SUNW_PKGVERS="<\fIsunw_package_version\fR>" -.fi -.in -2 - -where <\fIsunw_package_version\fR> has the form \fIx.y[.z]\fR and \fIx\fR, -\fIy\fR, and z are integers. For packages built for this release and previous -releases, use \fBSUNW_PKGVERS="\fI1.0\fR"\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBSUNW_PRODNAME\fR\fR -.ad -.sp .6 -.RS 4n -Solaris-only parameter indicating the name of the product this package is a -part of or comprises (maximum length of 256 \fBASCII\fR characters). A few -examples of \fBSUNW_PRODNAME\fR values are: \fB"SunOS"\fR, -\fB"OpenWindows"\fR, and \fB"Common Desktop Environment"\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBSUNW_PRODVERS\fR\fR -.ad -.sp .6 -.RS 4n -Solaris-only parameter indicating the version or release of the product -described in \fBSUNW_PRODNAME\fR (maximum length of 256 \fBASCII\fR -characters). For example, where \fBSUNW_PRODNAME="\fR\fISunOS\fR\fB"\fR, and -the Solaris 2.x Beta release, this string could be \fB"5.x BETA"\fR, while for -the Solaris 2.x FCS release, the string would be \fB"5.x"\fR. For Solaris 10, -the string is \fB"5.10"\fR. If the \fBSUNW_PRODNAME\fR parameter is \fINULL\fR, -so should be the \fBSUNW_PRODVERS\fR parameter. -.RE - -.sp -.ne 2 -.na -\fB\fBULIMIT\fR\fR -.ad -.sp .6 -.RS 4n -If set, this parameter is passed as an argument to the \fBulimit\fR(1) command -(see \fBlimit\fR(1)), which establishes the maximum size of a file during -installation. -.RE - -.sp -.ne 2 -.na -\fB\fBVENDOR\fR\fR -.ad -.sp .6 -.RS 4n -Used to identify the vendor that holds the software copyright (maximum length -of 256 \fBASCII\fR characters). -.RE - -.sp -.ne 2 -.na -\fB\fBVSTOCK\fR\fR -.ad -.sp .6 -.RS 4n -The vendor stock number, if any, that identifies this product (maximum length -of 256 \fBASCII\fR characters). -.RE - -.sp -.LP -For further discussion of the zones-related parameters described above, see -\fISystem Administration Guide: Virtualization Using the Solaris Operating -System\fR. - -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample \fBpkginfo\fR File -.sp -.LP -Here is a sample \fBpkginfo\fR file: - -.sp -.in +2 -.nf -SUNW_PRODNAME="SunOS" -SUNW_PRODVERS="5.5" -SUNW_PKG_ALLZONES=false -SUNW_PKG_HOLLOW=false -PKG="SUNWesu" -NAME="Extended System Utilities" -VERSION="11.5.1" -ARCH="sparc" -VENDOR="Sun Microsystems, Inc." -HOTLINE="Please contact your local service provider" -EMAIL="" -VSTOCK="0122c3f5566" -CATEGORY="system" -ISTATES="S 2" -RSTATES="S 2" -.fi -.in -2 - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability See entries below -_ -PKG value Evolving -_ -VERSION value Evolving -_ -NAME value Evolving -_ -DESC value Evolving -_ -ARCH value Evolving -_ -CATEGORY value Evolving -_ -BASEDIR value Evolving -_ -ISTATES value Evolving -_ -RSTATES value Evolving -_ -MAXINST value Evolving -_ -SUNW_PKG_ALLZONES Evolving -_ -SUNW_PKG_HOLLOW Evolving -_ -SUNW_PKG_THISZONE Evolving -_ -SUNW_PRODNAME Evolving -_ -SUNW_PRODVERS Evolving -_ -SUNW_PKGVERS Evolving -_ -SUNW_PKG_DIR Evolving -.TE - -.SH SEE ALSO -.LP -\fBisalist\fR(1), \fBlimit\fR(1), \fBpkgmk\fR(1), \fBuname\fR(1), -\fBinit\fR(1M), \fBpkgmap\fR(4), \fBattributes\fR(5), \fBzones\fR(5) -.sp -.LP -\fIApplication Packaging Developer\&'s Guide\fR -.sp -.LP -\fISystem Administration Guide: Virtualization Using the Solaris Operating -System\fR -.SH NOTES -.LP -Developers can define their own installation parameters by adding a definition -to this file. A developer-defined parameter must begin with a capital letter. -.sp -.LP -Trailing white space after any parameter value is ignored. For example, -\fBVENDOR="Sun Microsystems, Inc."\fR is the same as \fBVENDOR="Sun -Microsystems, Inc. "\fR. diff --git a/usr/src/man/man4/pkgmap.4 b/usr/src/man/man4/pkgmap.4 deleted file mode 100644 index aa3199cc68..0000000000 --- a/usr/src/man/man4/pkgmap.4 +++ /dev/null @@ -1,364 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved -.\" 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 PKGMAP 4 "Jul 12, 2006" -.SH NAME -pkgmap \- package contents description file -.SH DESCRIPTION -.sp -.LP -\fBpkgmap\fR is an \fBASCII\fR file that provides a complete listing of the -package contents. It is automatically generated by \fBpkgmk\fR(1) using the -information in the \fBprototype\fR(4) file. -.sp -.LP -Each entry in \fBpkgmap\fR describes a single ``deliverable object file.'' A -deliverable object file includes shell scripts, executable objects, data files, -directories, and so forth. The entry consists of several fields of information, -each field separated by a space. The fields are described below and must appear -in the order shown. -.sp -.ne 2 -.na -\fB\fIpart\fR\fR -.ad -.RS 12n -An optional field designating the part number in which the object resides. A -part is a collection of files and is the atomic unit by which a package is -processed. A developer can choose the criteria for grouping files into a part -(for example, based on class). If no value is defined in this field, part 1 is -assumed. -.RE - -.sp -.ne 2 -.na -\fB\fIftype\fR\fR -.ad -.RS 12n -A one-character field that indicates the file type. Valid values are listed -below. File types are divided between those that are not to be modified and -those that are modifiable. -.sp -Files of the following types must never be modified: -.sp -.ne 2 -.na -\fB\fBb\fR\fR -.ad -.RS 5n -block special device -.RE - -.sp -.ne 2 -.na -\fB\fBc\fR\fR -.ad -.RS 5n -character special device -.RE - -.sp -.ne 2 -.na -\fB\fBd\fR\fR -.ad -.RS 5n -directory -.RE - -.sp -.ne 2 -.na -\fB\fBf\fR\fR -.ad -.RS 5n -a standard executable file, data file, or other type of file, the contents of -which must never be modified. -.RE - -.sp -.ne 2 -.na -\fB\fBi\fR\fR -.ad -.RS 5n -information file (such as a file containing a copyright, list of dependencies, -or package information) or installation script (such as checkinstall, class -action [\fBi.\fR], pre/post install/remove), the contents of which must never -be modified. -.RE - -.sp -.ne 2 -.na -\fB\fBl\fR\fR -.ad -.RS 5n -linked file -.RE - -.sp -.ne 2 -.na -\fB\fBp\fR\fR -.ad -.RS 5n -named pipe -.RE - -.sp -.ne 2 -.na -\fB\fBs\fR\fR -.ad -.RS 5n -symbolic link -.RE - -.sp -.ne 2 -.na -\fB\fBx\fR\fR -.ad -.RS 5n -an exclusive directory accessible only by this package -.RE - -Files of the following types can be modified: -.sp -.ne 2 -.na -\fB\fBe\fR\fR -.ad -.RS 5n -An editable file, intended to be edited (selectively modified) after -installation. An editable file is expected to change on installation or -removal, can be shared by several packages, and must be installed by a class -action script. Examples are a configuration file or a list of users. -.RE - -.sp -.ne 2 -.na -\fB\fBv\fR\fR -.ad -.RS 5n -A volatile file, intended to be overwritten or appended to after installation. -A volatile file is not expected to change on installation or removal, is not -preserved between installations, and can be installed by a class action script. -Examples are a log file or a lock file. -.RE - -Following package installation, the contents of files of all types except -\fBe\fR and \fBv\fR must not change. Any file that is subject to change should -be marked as \fBe\fR or \fBv\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIclass\fR\fR -.ad -.RS 12n -The installation class to which the file belongs. This name must contain only -alphanumeric characters and be no longer than 12 characters. It is not -specified if the \fIftype\fR is \fBi\fR (information file). -.RE - -.sp -.ne 2 -.na -\fB\fIpathname\fR\fR -.ad -.RS 12n -\fIpathname\fR may contain variables of the form \fB$\fR\fIvariable\fR that -support install-time configuration of the file. \fIvariable\fR may be embedded -in the pathname structure. (See \fBprototype\fR(4) for definitions of variable -specifications.) -.sp -Do not use the following reserved words in \fIpathname\fR, since they are -applied by \fBpkgadd\fR(1M) using a different mechanism: -.sp -.in +2 -.nf -PKG_INSTALL_ROOT -BASEDIR -CLIENT_BASEDIR -.fi -.in -2 -.sp - -.RE - -.sp -.ne 2 -.na -\fB\fImajor\fR\fR -.ad -.RS 12n -The major device number. The field is only specified for block or character -special devices. -.RE - -.sp -.ne 2 -.na -\fB\fIminor\fR\fR -.ad -.RS 12n -The minor device number. The field is only specified for block or character -special devices. -.RE - -.sp -.ne 2 -.na -\fB\fImode\fR\fR -.ad -.RS 12n -The octal mode of the file (for example, 0664). A question mark (\fB?\fR) -indicates that the mode will be left unchanged, implying that the file already -exists on the target machine. This field is not used for linked files, -packaging information files, or non-installable files. -.sp -The mode can contain a variable specification. (See \fBprototype\fR(4) for -definitions of variable specifications.) -.RE - -.sp -.ne 2 -.na -\fB\fIowner\fR\fR -.ad -.RS 12n -The owner of the file (for example, \fBbin\fR or \fBroot\fR). The field is -limited to 14 characters in length. A question mark (\fB?\fR) indicates that -the owner will be left unchanged or changed to the owner stored in the package -database, which could be different from what is on the file system. When the -question mark is used, it implies that the file is already on the file system. -This field is not used for linked files or non-installable files. It is used -optionally with a package information file. If used, it indicates with what -owner an installation script will be executed. -.sp -The owner can contain a variable specification. (See \fBprototype\fR(4) for -definitions of variable specifications.) -.RE - -.sp -.ne 2 -.na -\fB\fIgroup\fR\fR -.ad -.RS 12n -The group to which the file belongs (for example, \fBbin\fR or \fBsys\fR). The -field is limited to 14 characters in length. A question mark (\fB?\fR) -indicates that the group will be left unchanged or changed to the owner stored -in the package database, which could be different from what is on the file -system. When the question mark is used, it implies that the file is already on -the file system. This field is not used for linked files or non-installable -files. It is used optionally with a package information file. If used, it -indicates with what group an installation script will be executed. -.sp -The group can contain a variable specification. (See \fBprototype\fR(4) for -definitions of variable specifications.) -.RE - -.sp -.ne 2 -.na -\fB\fIsize\fR\fR -.ad -.RS 12n -The actual size of the file in bytes. This field is not specified for named -pipes, special devices, directories or linked files. -.RE - -.sp -.ne 2 -.na -\fB\fIcksum\fR\fR -.ad -.RS 12n -The checksum of the file contents. This field is not specified for named pipes, -special devices, directories, or linked files. -.RE - -.sp -.ne 2 -.na -\fB\fImodtime\fR\fR -.ad -.RS 12n -The time of last modification, as reported by the \fBstat\fR(2) function call. -This field is not specified for named pipes, special devices, directories, or -linked files. -.RE - -.sp -.LP -Each \fBpkgmap\fR file must have one line that provides information about the -number of parts, maximum size of parts that make up the package, and, -optionally, the size of the package after compression (where size is given in -512-byte blocks). This line is in the following format: -.sp -.LP -\fB:\fR \fInumber_of_parts\fR \fImaximum_part_size\fR \fIcompressed_pkg_size\fR -.sp -.LP -Lines that begin with ``\fB#\fR'' are comment lines and are ignored. -.sp -.LP -When files are saved during installation before they are overwritten, they are -normally just copied to a temporary pathname. However, for files whose mode -includes execute permission (but which are not editable), the existing version -is linked to a temporary pathname and the original file is removed. This allows -processes which are executing during installation to be overwritten. -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample \fBpkgmap\fR File -.sp -.in +2 -.nf -\fB: 2 500 -1 i pkginfo 237 1179 541296672 -1 b class1 /dev/diskette 17 134 0644 root other -1 c class1 /dev/rdiskette 17 134 0644 root other -1 d none bin 0755 root bin -1 f none bin/INSTALL 0755 root bin 11103 17954 541295535 -1 f none bin/REMOVE 0755 root bin 3214 50237 541295541 -1 l none bin/UNINSTALL=bin/REMOVE -1 f none bin/cmda 0755 root bin 3580 60325 541295567 -1 f none bin/cmdb 0755 root bin 49107 51255 541438368 -1 f class1 bin/cmdc 0755 root bin 45599 26048 541295599 -1 f class1 bin/cmdd 0755 root bin 4648 8473 541461238 -1 f none bin/cmde 0755 root bin 40501 1264 541295622 -1 f class2 bin/cmdf 0755 root bin 2345 35889 541295574 -1 f none bin/cmdg 0755 root bin 41185 47653 541461242 -2 d class2 data 0755 root bin -2 p class1 data/apipe 0755 root other -2 d none log 0755 root bin -2 v none log/logfile 0755 root bin 41815 47563 541461333 -2 d none save 0755 root bin -2 d none spool 0755 root bin -2 d none tmp 0755 root bin\fR -.fi -.in -2 -.sp - -.SH SEE ALSO -.sp -.LP -\fBpkgmk\fR(1), \fBpkgadd\fR(1M), \fBstat\fR(2), \fBpkginfo\fR(4), -\fBprototype\fR(4) -.sp -.LP -\fIApplication Packaging Developer\&'s Guide\fR -.SH NOTES -.sp -.LP -The \fBpkgmap\fR file may contain only one entry per unique pathname. diff --git a/usr/src/man/man4/policy.conf.4 b/usr/src/man/man4/policy.conf.4 deleted file mode 100644 index 4c933fbfc4..0000000000 --- a/usr/src/man/man4/policy.conf.4 +++ /dev/null @@ -1,251 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 POLICY.CONF 4 "Feb 25, 2008" -.SH NAME -policy.conf \- configuration file for security policy -.SH SYNOPSIS -.LP -.nf -/etc/security/policy.conf -.fi - -.SH DESCRIPTION - -.LP -The \fBpolicy.conf\fR file provides the security policy configuration for -user-level attributes. Each entry consists of a key/value pair in the form: -.sp -.LP -key=value -.sp -.LP -The following keys are defined: -.sp -.ne 2 -.na -\fB\fBAUTHS_GRANTED\fR\fR -.ad -.sp .6 -.RS 4n -Specify the default set of authorizations granted to all users. This entry is -interpreted by \fBchkauthattr\fR(3SECDB). The value is zero or more -comma-separated authorizations defined in \fBauth_attr\fR(4). -.RE - -.sp -.ne 2 -.na -\fB\fBPROFS_GRANTED\fR\fR -.ad -.sp .6 -.RS 4n -Specify the default set of profiles granted to all users. This entry is -interpreted by \fBchkauthattr\fR(3SECDB) and \fBgetexecuser\fR(3SECDB). The -value is zero or more comma-separated profiles defined in \fBprof_attr\fR(4). -.RE - -.sp -.ne 2 -.na -\fB\fBCONSOLE_USER\fR\fR -.ad -.sp .6 -.RS 4n -Specify an additional default set of profiles granted to the \fIconsole user\fR -user. This entry is interpreted by \fBchkauthattr\fR(3SECDB) and -\fBgetexecuser\fR(3SECDB). The value is zero or more comma-separated profiles -defined in \fBprof_attr\fR(4). -.RE - -.sp -.ne 2 -.na -\fB\fBPRIV_DEFAULT\fR and \fBPRIV_LIMIT\fR\fR -.ad -.sp .6 -.RS 4n -Settings for these keys determine the default privileges that users have. (See -\fBprivileges\fR(5).) If these keys are not set, the default privileges are -taken from the inherited set. \fBPRIV_DEFAULT\fR determines the default set on -login. \fBPRIV_LIMIT\fR defines the limit set on login. Users can have -privileges assigned or taken away through use of \fBuser_attr\fR(4). Privileges -can also be assigned to profiles, in which case users who have those profiles -can exercise the assigned privileges through \fBpfexec\fR(1). -.sp -For maximum future compatibility, the privilege specifications should always -include \fBbasic\fR or \fBall\fR. Privileges should then be removed using -negation. See EXAMPLES. By assigning privileges in this way, you avoid a -situation where, following an addition of a currently unprivileged operation to -the basic privilege set, a user unexpectedly does not have the privileges he -needs to perform that now-privileged operation. -.sp -Note that removing privileges from the limit set requires \fBextreme\fR care, -as any set-uid root program might suddenly fail because it lacks certain -privilege(s). Note also that dropping \fBbasic\fR privileges from the default -privilege set can cause unexpected failure modes in applications. -.RE - -.sp -.ne 2 -.na -\fB\fBLOCK_AFTER_RETRIES=YES|NO\fR\fR -.ad -.sp .6 -.RS 4n -Specifies whether a local account is locked after the count of failed logins -for a user equals or exceeds the allowed number of retries as defined by -\fBRETRIES\fR in \fB/etc/default/login\fR. The default value for users is -\fBNO\fR. Individual account overrides are provided by \fBuser_attr\fR(4). -.RE - -.sp -.ne 2 -.na -\fB\fBCRYPT_ALGORITHMS_ALLOW\fR\fR -.ad -.sp .6 -.RS 4n -Specify the algorithms that are allowed for new passwords and is enforced only -in \fBcrypt_gensalt\fR(3C). -.RE - -.sp -.ne 2 -.na -\fB\fBCRYPT_ALGORITHMS_DEPRECATE\fR\fR -.ad -.sp .6 -.RS 4n -Specify the algorithm for new passwords that is to be deprecated. For example, -to deprecate use of the traditional UNIX algorithm, specify -\fBCRYPT_ALGORITHMS_DEPRECATE=__unix__\fR and change \fBCRYPT_DEFAULT=\fR to -another algorithm, such as \fBCRYPT_DEFAULT=1\fR for BSD and Linux MD5. -.RE - -.sp -.ne 2 -.na -\fB\fBCRYPT_DEFAULT\fR\fR -.ad -.sp .6 -.RS 4n -Specify the default algorithm for new passwords. The Solaris default was once -the traditional UNIX algorithm. This is not listed in \fBcrypt.conf\fR(4) since -it is internal to \fBlibc\fR. The reserved name \fB__unix__\fR is used to refer -to it. -.RE - -.sp -.LP -The key/value pair must appear on a single line, and the key must start the -line. Lines starting with \fB#\fR are taken as comments and ignored. Option -name comparisons are case-insensitive. -.sp -.LP -Only one \fBCRYPT_ALGORITHMS_ALLOW\fR or \fBCRYPT_ALGORITHMS_DEPRECATE\fR value -can be specified. Whichever is listed first in the file takes precedence. The -algorithm specified for \fBCRYPT_DEFAULT\fR must either be specified for -\fBCRYPT_ALGORITHMS_ALLOW\fR or not be specified for -\fBCRYPT_ALGORITHMS_DEPRECATE\fR. If \fBCRYPT_DEFAULT\fR is not specified, the -default is \fB__unix__\fR. -.SH EXAMPLES -.LP -\fBExample 1 \fRDefining a Key/Value Pair -.sp -.in +2 -.nf -\fBAUTHS_GRANTED=solaris.date\fR -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRSpecifying Privileges -.sp -.LP -As noted above, you should specify privileges through negation, specifying -\fBall\fR for \fBPRIV_LIMIT\fR and \fBbasic\fR for \fBPRIV_DEFAULT\fR, then -subtracting privileges, as shown below. - -.sp -.in +2 -.nf -PRIV_LIMIT=all,!sys_linkdir -PRIV_DEFAULT=basic,!file_link_any -.fi -.in -2 - -.sp -.LP -The first line, above, takes away only the \fBsys_linkdir\fR privilege. The -second line takes away only the \fBfile_link\fR privilege. These privilege -specifications are unaffected by any future addition of privileges that might -occur. - -.SH FILES - -.ne 2 -.na -\fB\fB/etc/user_attr\fR\fR -.ad -.RS 29n -Defines extended user attributes. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/security/auth_attr\fR\fR -.ad -.RS 29n -Defines authorizations. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/security/prof_attr\fR\fR -.ad -.RS 29n -Defines profiles. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/security/policy.conf\fR\fR -.ad -.RS 29n -Defines policy for the system. -.RE - -.SH ATTRIBUTES - -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH SEE ALSO - -.LP -\fBlogin\fR(1), \fBpfexec\fR(1), \fBchkauthattr\fR(3SECDB), -\fBgetexecuser\fR(3SECDB), \fBauth_attr\fR(4), \fBcrypt.conf\fR(4), -\fBprof_attr\fR(4), \fBuser_attr\fR(4), \fBattributes\fR(5), -\fBprivileges\fR(5) -.SH NOTES - -.LP -The \fIconsole user\fR is defined as the owner of \fB/dev/console\fR. diff --git a/usr/src/man/man4/power.conf.4 b/usr/src/man/man4/power.conf.4 deleted file mode 100644 index 56f841fe23..0000000000 --- a/usr/src/man/man4/power.conf.4 +++ /dev/null @@ -1,815 +0,0 @@ -'\" te -.\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved -.\" 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 POWER.CONF 4 "June 20, 2021" -.SH NAME -power.conf \- Power Management configuration information file -.SH SYNOPSIS -.nf -\fB/etc/power.conf\fR -.fi - -.SH DESCRIPTION -The \fBpower.conf\fR file is used by the Power Management configuration program -\fBpmconfig\fR(1M), to initialize the settings for Power Management. If you -make changes to this file, you must run \fBpmconfig\fR(1M) manually for the -changes to take effect. -.sp -.LP -Power Management addresses two specific management scenarios: management of -individual devices and management of the whole system. An individual device is -power managed if the device supports multiple power levels and if the device -driver uses Power Management interfaces provided by the kernel to save device -power when the device is idle. -.sp -.LP -All entries in the \fBpower.conf\fR file are processed in the order that they -occur in the file. -.SS "Automatic Device Power Management" -Devices with drivers that use the automatic device Power Management interfaces -are automatically power managed if the \fBautopm\fR entry is enabled. The -\fBautopm\fR entry is described near the end of this section. The -\fBpm-components\fR property describes the Power Management model of a device -driver to the Power Management framework. See \fBpm-components\fR(9P) for more -information. -.sp -.LP -When a component has been idle at a given power level for its threshold time, -the power level of the component is reduced to the next lower power level of -that component, if any. For devices which implement multiple components, each -component is power-managed independently. -.sp -.LP -Default thresholds for components of automatically power managed devices are -computed by the Power Management framework based on the system idleness -threshold. By default, all components of the device are powered off if they -have all been idle for the system's idleness threshold. The default system -idleness threshold is determined by the applicable United States Environmental -Protection Agency's (EPA) \fIEnergy Star Memorandum of Understanding\fR. See -the \fBNOTES\fR section of this manual page for more information. -.sp -.LP -To set the system idleness \fIthreshold\fR, use one of the following entries: -.sp -.in +2 -.nf -system-threshold \fIthreshold\fR -.fi -.in -2 - -.sp -.in +2 -.nf -system-threshold \fBalways-on\fR -.fi -.in -2 - -.sp -.LP -where \fIthreshold\fR is the value of the system idleness threshold in hours, -minutes or seconds as indicated by a trailing \fBh\fR, \fBm\fR or \fBs\fR -(defaulting to seconds if only a number is given). If \fBalways-on\fR is -specified, then by default, all devices are left at full power. -.sp -.LP -The \fBsystem-threshold\fR entry is applicable to CPU Power Management only -when CPU Power Management has been configured to operate in poll-mode, which is -expressed through the \fBcpupm\fR keyword. -.sp -.LP -If a system has power manageable CPUs, these can be managed independently of -the system idleness threshold by using one of the following entries: -.sp -.in +2 -.nf -cpu-threshold \fIthreshold\fR -.fi -.in -2 - -.sp -.in +2 -.nf -cpu-threshold \fBalways-on\fR -.fi -.in -2 - -.sp -.LP -where \fIthreshold\fR is the value of the CPU idleness threshold in hours, -minutes or seconds as indicated by a trailing \fBh\fR, \fBm\fR or \fBs\fR -(defaulting to seconds if only a number is given). If \fBalways-on\fR is -specified, then by default, all CPUs are left at full power. -.sp -.LP -The \fBcpu-threshold\fR keyword is used only when CPU Power Management has been -configured to operate in poll-mode, which is expressed through the \fBcpupm\fR -keyword. -.sp -.LP -If no \fBcpu-threshold\fR entry is specified, then the system idleness -threshold is used. -.sp -.LP -To override the default device component thresholds assigned by the Power -Management framework, a \fBdevice-thresholds\fR entry can be used. A -\fBdevice-thresholds\fR entry sets thresholds for a specific automatically -power-managed device or disables automatic Power Management for the specific -device. -.sp -.LP -A \fBdevice-thresholds\fR entry has the form: -.sp -.in +2 -.nf -device-thresholds \fIphys_path\fR \fI(threshold ...) ...\fR -.fi -.in -2 - -.sp -.LP -or -.sp -.in +2 -.nf -device-thresholds \fIphys_path\fR \fIthreshold\fR -.fi -.in -2 - -.sp -.LP -or -.sp -.in +2 -.nf -device-thresholds \fIphys_path\fR \fBalways-on\fR -.fi -.in -2 - -.sp -.LP -where \fIphys_path\fR specifies the physical path (\fBlibdevinfo\fR(3LIB)) of a -specific device. For example, -\fB/pci@8,600000/scsi@4/ssd@w210000203700c3ee,0\fR specifies the physical path -of a disk. A symbolic link into the \fB/devices\fR tree, for example -\fB/dev/dsk/c1t1d0s0\fR, is also accepted. The thresholds apply (or keeping the -device always on applies) to the specific device only. -.sp -.LP -In the first form above, each \fIthreshold\fR value represents the number of -hours, minutes or seconds, depending on a trailing \fBh\fR, \fBm\fR or \fBs\fR -with a default to seconds, to spend idle at the corresponding power level -before power is reduced to the next lower level of that component. Parentheses -are used to group thresholds per component, with the first (leftmost) group -being applied to component \fB0\fR, the next to component \fB1\fR, and the -like. Within a group, the last (rightmost) number represents the time to be -idle in the highest power level of the component before going to the -next-to-highest level, while the first (leftmost) number represents the time to -be idle in the next-to-lowest power level before going to the lowest power -level. -.sp -.LP -If the number of groups does not match the number of components exported by the -device (by means of \fBpm-components\fR(9P) property), or the number of -thresholds in a group is not one less than the number of power levels the -corresponding component supports, then an error message is printed and the -entry is ignored. -.sp -.LP -For example, assume a device called \fBxfb\fR exports the components \fBFrame -Buffer\fR and \fBMonitor\fR. Component \fBFrame Buffer\fR has two power levels: -\fBOff\fR and \fBOn\fR. Component \fBMonitor\fR has four power levels: -\fBOff\fR, \fBSuspend, Standby\fR, and \fBOn\fR. -.sp -.LP -The following \fBdevice-thresholds\fR entry: -.sp -.in +2 -.nf -device-thresholds \fI/pci@f0000/xfb@0 (0) (3m 5m 15m)\fR -.fi -.in -2 - -.sp -.LP -would set the \fIthreshold\fR time for the \fBMonitor\fR component of the -specific \fBxfb\fR card to go from \fBOn\fR to \fBStandby in\fR 15 minutes, the -\fIthreshold\fR for \fBMonitor\fR to go from \fBStandby\fR to \fBSuspend\fR in 5 -minutes, and the \fIthreshold\fR for \fBMonitor\fR to go from \fBSuspend\fR to -\fBOff\fR in 3 minutes. The threshold for \fBFrame Buffer\fR to go from -\fBOn\fR to \fBOff\fR is 0 seconds. -.sp -.LP -In the second form above, where a single threshold value is specified without -parentheses, the threshold value represents a maximum overall time within which -the entire device should be powered down if it is idle. Because the system does -not know about any internal dependencies there can be among a device's -components, the device can actually be powered down sooner than the specified -\fIthreshold\fR, but does take longer than the specified \fIthreshold\fR, -provided that all device components are idle. -.sp -.LP -In the third form above, all components of the device are left at full power. -.sp -.LP -Device Power Management entries are only effective if there is no user process -controlling the device directly. For example, X Windows systems directly -control frame buffers. The entries in the \fBpower.conf\fR file are effective -only when X Windows is not running. -.sp -.LP -Dependencies among devices can also be defined. A device depends upon another -if none of its components might have their power levels reduced unless all -components of the other device are powered off. A dependency can be indicated -by an entry of the form: -.sp -.in +2 -.nf -device-dependency \fIdependent_phys_path phys_path [ phys_path ... ]\fR -.fi -.in -2 - -.sp -.LP -where \fIdependent_phys_path\fR is the path name (as above) of the device that -is kept up by the others, and the \fIphys_path\fR entries specify the devices -that keep it up. A symbolic link into the \fB/devices\fR tree, such as -\fB/dev/fb\fR, is also accepted. This entry is needed only for logical -dependents for the device. A logical dependent is a device that is not -physically connected to the power managed device (for example, the display and -the keyboard). Physical dependents are automatically considered and need not be -included. -.sp -.LP -In addition to listing dependents by physical path, an arbitrary group of -devices can be made dependent upon another device by specifying a property -dependency using the following syntax: -.sp -.in +2 -.nf -device-dependency-property \fIproperty\fR \fIphys_path\fR [\fIphys_path\fR ...] -.fi -.in -2 -.sp - -.sp -.LP -where each device that exports the property \fIproperty\fR is kept up by the -devices named by \fIphys_path\fR(s). A symbolic link into the \fB/devices\fR -tree (such as \fB/dev/fb\fR) is accepted as well as a pathname for -\fIphys_path\fR. -.sp -.LP -For example, the following entry ensures that every device that exports the -boolean property named \fBremovable-media\fR is kept up when the console -framebuffer is up. See \fBremovable-media\fR(9P). -.sp -.in +2 -.nf -# This entry keeps removable media from being powered down unless the -# console framebuffer and monitor are powered down -# (See removable-media(9P)) -# -device-dependency-property removable-media /dev/fb -.fi -.in -2 - -.sp -.LP -An \fBautopm\fR entry can be used to enable or disable automatic device Power -Management on a system-wide basis. The format of the \fBautopm\fR entry is: -.sp -.in +2 -.nf -autopm \fIbehavior\fR -.fi -.in -2 - -.sp -.LP -Acceptable behavior values are described as follows: -.sp -.ne 2 -.na -\fB\fBdefault\fR\fR -.ad -.RS 11n -The behavior of the system depends upon its model. Desktop models that fall -under the United States Environmental Protection Agency's \fIEnergy Star -Memorandum of Understanding #3\fR have automatic device Power Management -enabled, and all others do not. See the \fBNOTES\fR section of this manual page -for more information. -.RE - -.sp -.ne 2 -.na -\fB\fBenable\fR\fR -.ad -.RS 11n -Automatic device Power Management is started when this entry is encountered. -.RE - -.sp -.ne 2 -.na -\fB\fBdisable\fR\fR -.ad -.RS 11n -Automatic device Power Management is stopped when this entry is encountered. -.RE - -.sp -.LP -A \fBcpupm\fR entry can be used to enable or disable Power Management of CPUs -on a system-wide basis, independent of \fBautopm\fR. The format of the -\fBcpupm\fR entry is: -.sp -.in +2 -.nf -cpupm \fIbehavior\fR -.fi -.in -2 - -.sp -.LP -Acceptable behavior values and their meanings are : -.sp -.ne 2 -.na -\fB\fBenable\fR\fR -.ad -.RS 11n -CPU Power Management is started when this entry is encountered. -.sp -Where the behavior is \fBenable\fR, an optional \fImode\fR argument can be -specified: -.sp -.in +2 -.nf -cpupm enable \fImode\fR -.fi -.in -2 - -Acceptable \fImode\fR values and their meanings are: -.sp -.ne 2 -.na -\fB\fBevent-mode\fR\fR -.ad -.RS 14n -CPU power state transitions is driven by thread scheduler/dispatcher events. -The \fBcpu-threshold\fR, and \fBsystem-threshold\fR keywords are not used for -CPUs in this mode. -.RE - -.sp -.ne 2 -.na -\fB\fBpoll-mode\fR\fR -.ad -.RS 14n -The Power Management framework polls the idleness of the system's CPUs, and -manages their power once idle for the period of time specified by either the -\fBsystem-threshold\fR or \fBcpu-threshold\fR. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBdisable\fR\fR -.ad -.RS 11n -CPU Power Management is stopped when this entry is encountered. -.RE - -.sp -.LP -If supported by the platform, a \fBcpu_deep_idle\fR entry can be used to enable -or disable automatic use of power saving cpu idle states. The format of the -\fBcpu_deep_idle\fR entry is: -.sp -.in +2 -.nf -\fBcpu_deep_idle\fR \fIbehavior\fR -.fi -.in -2 -.sp - -.sp -.LP -Acceptable values for \fIbehavior\fR are: -.sp -.ne 2 -.na -\fB\fBdefault\fR\fR -.ad -.RS 11n -Advanced cpu idle power saving features are enabled on hardware which supports -it. On X86 systems this can translate to the use of ACPI C-States beyond C1. -.RE - -.sp -.ne 2 -.na -\fB\fBenable\fR\fR -.ad -.RS 11n -Enables the system to automatically use idle cpu power saving features. -.RE - -.sp -.ne 2 -.na -\fB\fBdisable\fR\fR -.ad -.RS 11n -The system does not automatically use idle cpu power saving features. This -option can be used when maximum performance is required at the expense of -power. -.RE - -.sp -.ne 2 -.na -\fB\fBabsent\fR\fR -.ad -.RS 11n -It the \fBcpu_deep_idle\fR keyword is absent from \fBpower.conf\fR the behavior -is the same as the default case. -.RE - -.sp -.LP -Once every device is at its lowest possible power state, additional power -savings can be obtained by putting the system into a sleep state (if the -platform hardware is capable of doing so). -.SS "S3 Support" -Because of reliability problems encountered in BIOS implementations of X86 -systems not produced by Sun Microsystems, by default, only X86 workstation -products produced by Sun are considered to support S3 (suspend to RAM). To -override this default, an S3-support entry (of the format S3-support -\fBbehavior\fR) can be used to indicate if the system supports S3. -.sp -.LP -Acceptable behavior values are: -.sp -.ne 2 -.na -\fBenable\fR -.ad -.RS 11n -The system supports entry into S3 state. If the BIOS of a system enabled using -an \fBS3-support enable\fR entry does not support entry into S3, the attempt -fails and the system returns to normal operation. If support for S3 in the BIOS -of a system enabled via an S3-support entry contains bugs, the system can be -unable to enter S3 or resume successfully, so use this entry with caution. -.RE - -.sp -.ne 2 -.na -\fBdisable\fR -.ad -.RS 11n -The system does not support entry into S3 state. -.RE - -.SS "Automatic Entry Into S3" -If supported by your platform, an autoS3 entry can be used to enable or disable -automatic entry into the S3 state. When in the S3 state, the power button, -keyboard and mouse activity or network traffic (depending upon the capabilities -of the platform hardware) can wake the system, returning it to the state it was -in upon entry to the S3 state. If the platform doesn't support S3, the entry -has no effect. -.sp -.LP -The format of the autoS3 entry is autoS3 \fBbehavior\fR. -.sp -.LP -Acceptable behavior values are: -.sp -.ne 2 -.na -\fBdefault\fR -.ad -.RS 11n -System behavior depends upon model. Sun X86 desktop and workstation models that -fall under the United States Environmental Protection Agency's \fIEnergy Star -Memorandum of Understanding #3\fR have automatic entry into the S3 state -enabled. Non-Sun systems do not. See \fBNOTES\fR for more information. -.RE - -.sp -.ne 2 -.na -\fBenable\fR -.ad -.RS 11n -Enables the system to automatically enter the S3 state if autopm is enabled and -every device is at its lowest power state. -.RE - -.sp -.ne 2 -.na -\fBdisable\fR -.ad -.RS 11n -The system does not automatically enter the S3 state. -.RE - -.SS "System Power Management" -The system Power Management entries control Power Management of the entire -system using the suspend-resume feature. When the system is suspended, the -complete current state is saved on the disk before power is removed. On reboot, -the system automatically starts a resume operation and the system is restored -to the state it was in prior to suspend. -.sp -.LP -The system can be configured to do an automatic shutdown (autoshutdown) using -the suspend-resume feature by an entry of the following form: -.sp -.in +2 -.nf -autoshutdown \fIidle_time\fR \fIstart_time\fR \fIfinish_time\fR \fIbehavior\fR -.fi -.in -2 - -.sp -.LP -\fIidle_time\fR specifies the time in minutes that system must have been idle -before it is automatically shutdown. System idleness is determined by the -inactivity of the system and can be configured as discussed below. -.sp -.LP -\fIstart_time\fR and \fIfinish_time\fR (each in \fBhh:mm\fR) specify the time -period during which the system can be automatically shutdown. These times are -measured from the start of the day (12:00 a.m.). If the \fIfinish_time\fR is -less than or equal to the \fIstart_time\fR, the period span from midnight to -the \fIfinish_time\fR and from the \fIstart_time\fR to the following midnight. -To specify continuous operation, the \fIfinish_time\fR can be set equal to the -\fIstart_time\fR. -.sp -.LP -Acceptable behavior values are described as follows: -.sp -.ne 2 -.na -\fB\fBshutdown\fR\fR -.ad -.RS 16n -The system is shut down automatically when it has been idle for the number of -minutes specified in the \fIidle_time\fR value and the time of day falls -between the \fIstart_time\fR and \fIfinish_time\fR values. -.RE - -.sp -.ne 2 -.na -\fB\fBnoshutdown\fR\fR -.ad -.RS 16n -The system is never shut down automatically. -.RE - -.sp -.ne 2 -.na -\fB\fBautowakeup\fR\fR -.ad -.RS 16n -If the hardware has the capability to do \fBautowakeup\fR, the system is shut -down as if the value were \fBshutdown\fR and the system is restarted -automatically the next time the time of day equals \fIfinish_time\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault\fR\fR -.ad -.RS 16n -The behavior of the system depends upon its model. Desktop models that fall -under the United States Environmental Protection Agency's \fIEnergy Star -Memorandum of Understanding #2\fR have automatic \fBshutdown\fR enabled, as if -\fIbehavior\fR field were set to \fBshutdown\fR, and all others do not. See -\fBNOTES\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBunconfigured\fR\fR -.ad -.RS 16n -The system does not be shut down automatically. If the system has just been -installed or upgraded, the value of this field is changed upon the next reboot. -.RE - -.sp -.LP -You can use the following format to configure the system's notion of idleness: -.sp -.LP -\fBidleness_parameter\fR \fIvalue\fR -.sp -.LP -Where \fBidleness_parameter\fR can be: -.sp -.ne 2 -.na -\fB\fBttychars\fR\fR -.ad -.RS 15n -If the \fBidleness_parameter\fR is \fBttychars\fR, the \fIvalue\fR field is -interpreted as the maximum number of tty characters that can pass through the -\fBldterm\fR module while still allowing the system to be considered idle. This -value defaults to \fB0\fR if no entry is provided. -.RE - -.sp -.ne 2 -.na -\fB\fBloadaverage\fR\fR -.ad -.RS 15n -If the \fBidleness_parameter\fR is \fBloadaverage\fR, the (floating point) -\fIvalue\fR field is interpreted as the maximum load average that can be seen -while still allowing the system to be considered idle. This value defaults to -\fB0.04\fR if no entry is provided. -.RE - -.sp -.ne 2 -.na -\fB\fBdiskreads\fR\fR -.ad -.RS 15n -If the \fBidleness_parameter\fR is \fBdiskreads\fR, the \fIvalue\fR field is -interpreted as the maximum number of disk reads that can be perform by the -system while still allowing the system to be considered idle. This value -defaults to \fB0\fR if no entry is provided. -.RE - -.sp -.ne 2 -.na -\fB\fBnfsreqs\fR\fR -.ad -.RS 15n -If the \fBidleness_parameter\fR is \fBnfsreqs\fR, the \fIvalue\fR field is -interpreted as the maximum number of NFS requests that can be sent or received -by the system while still allowing the system to be considered idle. Null -requests, access requests, and \fBgetattr\fR requests are excluded from this -count. This value defaults to \fB0\fR if no entry is provided. -.RE - -.sp -.ne 2 -.na -\fB\fBidlecheck\fR\fR -.ad -.RS 15n -If the \fBidleness_parameter\fR is \fBidlecheck\fR, the \fIvalue\fR must be -pathname of a program to be executed to determine if the system is idle. If -\fBautoshutdown\fR is enabled and the console keyboard, mouse, tty, CPU (as -indicated by load average), network (as measured by NFS requests) and disk (as -measured by read activity) have been idle for the amount of time specified in -the \fBautoshutdown\fR entry specified above, and the time of day falls between -the start and finish times, then this program is executed to check for other -idleness criteria. The \fIvalue\fR of the idle time specified in the above -\fBautoshutdown\fR entry is passed to the program in the environment variable -\fBPM_IDLETIME\fR. The process must terminate with an exit code that represents -the number of minutes that the process considers the system to have been idle. -.sp -There is no default \fIidlecheck\fR entry. -.RE - -.sp -.LP -When the system is suspended, the current system state is saved on the disk in -a statefile. An entry of following form can be used to change the location of -statefile: -.sp -.in +2 -.nf -\fBstatefile\fR \fIpathname\fR -.fi -.in -2 - -.sp -.LP -where \fIpathname\fR identifies a block special file, for example, -\fB/dev/dsk/c1t0d0s2\fR, or is the absolute pathname of a local \fBufs\fR file. -If the pathname specifies a block special file, it can be a symbolic link as -long as it does not have a file system mounted on it. If pathname specifies a -local ufs file, it cannot be a symbolic link. If the file does not exist, it is -created during the \fBsuspend\fR operation. All the directory components of the -path must already exist. -.sp -.LP -The actual size of statefile depends on a variety of factors, including the -size of system memory, the number of loadable drivers/modules in use, the -number and type of processes running, and the amount of user memory that has -been locked down. It is recommended that statefile be placed on a file system -with at least 10 Mbytes of free space. In case there is no statefile entry at -boot time, an appropriate new entry is automatically created by the system. -.SH EXAMPLES -\fBExample 1 \fRDisabling Automatic Device Power Management -.sp -.LP -To disable automatic device Power Management, change the following line in the -\fB/etc/power.conf\fR file - -.sp -.in +2 -.nf -autopm default -.fi -.in -2 - -.sp -.LP -to read: - -.sp -.in +2 -.nf -autopm disable -.fi -.in -2 - -.sp -.LP -Then run \fBpmconfig\fR or reboot. See \fBpmconfig\fR(1M) for more information. - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface stability Committed -.TE - -.SH SEE ALSO -\fBpmconfig\fR(1M), \fBpowerd\fR(1M), \fBuadmin\fR(2), -\fBlibdevinfo\fR(3LIB), \fBattributes\fR(5), \fBcpr\fR(7), \fBldterm\fR(7M), -\fBpm\fR(7D), \fBpm-components\fR(9P), \fBremovable-media\fR(9P) -.sp -.LP -\fIWriting Device Drivers\fR -.SH NOTES -SPARC desktop models first shipped after October 1, 1995 and before July 1, -1999 comply with the United States Environmental Protection Agency's \fIEnergy -Star Memorandum of Understanding #2\fR guidelines and have \fBautoshutdown\fR -enabled by default after 30 minutes of system idleness. This is achieved by -\fBdefault\fR keyword of \fBautoshutdown\fR entry behave as \fBshutdown\fR for -these machines. The user is prompted to confirm this default behavior at system -installation reboot. -.sp -.LP -SPARC desktop models first shipped after July 1, 1999 comply with the United -States Environmental Protection Agency's \fIEnergy Star Memorandum of -Understanding #3\fR guidelines and have \fBautoshutdown\fR disabled by default, -with \fBautopm\fR enabled after 30 minutes of idleness. This is achieved by -interpreting default keyword of \fBautopm\fR entry behavior as \fBenabled\fR -for these machines. User is not prompted to confirm this default behavior. -.sp -.LP -To determine the version of the EPA's \fIEnergy Star Memorandum\fR applicable -to your machine, use: -.sp -.in +2 -.nf -prtconf -pv | grep -i energystar -.fi -.in -2 - -.sp -.LP -Absence of a property indicates no Energy Star guidelines are applicable to -your machine. -.sp -.LP -System Power Management (suspend-resume) is currently supported only on a -limited set of hardware platforms. -.sp -.LP -Sun X86 desktop models first shipped after July 1, 1999 fall within United -States Environmental Protection Agency's \fIEnergy Star Memorandum of -Understanding #3\fR guidelines and have autopm and autoS3 enabled by default, -with entry into S3 after 30 minutes of idleness. This is achieved by -interpreting the default keyword of the autopm and autoS3 behaviors as enabled -for these machines. You are not prompted to confirm the default behavior. On -all other X86 systems, the autopm and autoS3 default keywords are interpreted -as \fBdisable\fR. diff --git a/usr/src/man/man4/printers.4 b/usr/src/man/man4/printers.4 deleted file mode 100644 index d790018360..0000000000 --- a/usr/src/man/man4/printers.4 +++ /dev/null @@ -1,306 +0,0 @@ -'\" te -.\" Copyright (C) 2006, Sun Microsystems, Inc. All Rights Reserved -.\" 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 PRINTERS 4 "Feb 25, 2017" -.SH NAME -printers \- user-configurable printer alias database -.SH SYNOPSIS -.LP -.nf -$HOME/.printers -.fi - -.SH DESCRIPTION -.LP -The \fB$HOME/.printers\fR file is a simplified version of the system -\fB/etc/printers.conf\fR file. See \fBprinters.conf\fR(4). Users create the -\fB$HOME/.printers\fR file in their home directory. This optional file is -customizable by the user. -.sp -.LP -The \fB$HOME/.printers\fR file performs the following functions: -.RS +4 -.TP -1. -Sets personal aliases for all print commands. -.RE -.RS +4 -.TP -2. -Sets the interest list for the \fBlpget\fR, \fBlpstat\fR, and \fBcancel\fR -commands. See \fBlpget\fR(1M), \fBlpstat\fR(1) and \fBcancel\fR(1). -.RE -.RS +4 -.TP -3. -Sets the default printer for the \fBlp\fR, \fBlpr\fR, \fBlpq\fR, and -\fBlprm\fR commands. See \fBlp\fR(1), \fBlpr\fR(1B), \fBlpq\fR(1B), and -\fBlprm\fR(1B). -.RE -.SS "Entries" -.LP -Use a line or full screen editor to create or modify the \fB$HOME/.printers\fR -file. -.sp -.LP -Each entry in \fB$HOME/.printers\fR describes one destination. Entries are one -line consisting of two fields separated by either BLANKs or TABs and terminated -by a NEWLINE. Format for an entry in \fB$HOME/.printers\fR varies according to -the purpose of the entry. -.sp -.LP -Empty lines can be included for readability. Entries can continue on to -multiple lines by adding a backslash (`\fB\e\fR\&') as the last character in -the line. The \fB$HOME/.printers\fR file can include comments. Comments have a -pound sign (`\fB#\fR') as the first character in the line, and are terminated -by a NEWLINE. -.SS "Setting Personal Aliases" -.LP -Specify the alias or aliases in the first field. Separate multiple aliases by a -pipe sign (`\fB|\fR'). Specify the destination in the second field. A -destination names a printer or class of printers, See \fBlpadmin\fR(1M). -Specify the destination using atomic, URI-style -(\fIscheme\fR\fB://\fR\fBendpoint\fR), or POSIX-style -(\fIserver\fR\fB:\fR\fIdestination\fR) names. See \fBprinters.conf\fR(4) for -information regarding the naming conventions for destination names. -.SS "Setting the Interest List for lpget, lpstat and cancel" -.LP -Specify \fB_all\fR in the first field. Specify the list of destinations for the -interest list in the second field. Separate each destinations by a comma -(`\fB,\fR'). Specify destinations using atomic, URI-style -(\fIscheme\fR\fB://\fR\fBendpoint\fR), or POSIX-style -(\fIserver\fR\fB:\fR\fIdestination\fR) names. See \fBprinters.conf\fR(4) for -information regarding the naming conventions for destination names. This list -of destinations can refer to an alias defined in \fB$HOME/.printers\fR. -.SS "Setting the Default Destination" -.LP -Specify \fB_default\fR in the first field. Specify the default destination in -the second field. Specify the default destination using atomic, URI-style -(\fIscheme\fR\fB://\fR\fBendpoint\fR), or POSIX-style -(\fIserver\fR\fB:\fR\fIdestination\fR) names. See \fBprinters.conf\fR(4) for -information regarding the naming conventions for destination names. The default -destination can refer to an alias defined in \fB$HOME/.printers\fR. -.SS "Locating Destination Information" -.LP -The print client commands locate destination information based on the -"printers" database entry in the \fB/etc/nsswitch.conf\fR file. See -\fBnsswitch.conf\fR(4). -.SS "Locating the Personal Default Destination" -.LP -The default destination is located differently depending on the command. -.sp -.LP -The \fBlp\fR command locates the default destination in the following order: -.RS +4 -.TP -1. -\fBlp\fR command's \fB-d\fR \fIdestination\fR option. -.RE -.RS +4 -.TP -2. -\fBLPDEST\fR environment variable. -.RE -.RS +4 -.TP -3. -\fBPRINTER\fR environment variable. -.RE -.RS +4 -.TP -4. -\fB_default\fR destination in \fB$HOME/.printers\fR. -.RE -.RS +4 -.TP -5. -\fB_default\fR destination in \fB/etc/printers.conf\fR. -.RE -.sp -.LP -The \fBlpr\fR, \fBlpq\fR, and \fBlprm\fR commands locate the default -destination in the following order: -.RS +4 -.TP -1. -\fBlpr\fR command's \fB-P\fR \fIdestination\fR option. -.RE -.RS +4 -.TP -2. -\fBPRINTER\fR environment variable. -.RE -.RS +4 -.TP -3. -\fBLPDEST\fR environment variable. -.RE -.RS +4 -.TP -4. -\fB_default\fR destination in \fB$HOME/.printers\fR. -.RE -.RS +4 -.TP -5. -\fB_default\fR destination in \fB/etc/printers.conf\fR. -.RE -.SS "Locating the Interest List for lpget, lpstat, and cancel" -.LP -The \fBlpget\fR, \fBlpstat\fR, and \fBcancel\fR commands locate the interest -list in the following order: -.RS +4 -.TP -1. -\fB_all\fR list in \fB$HOME/.printers\fR. -.RE -.RS +4 -.TP -2. -\fB_all\fR list in \fB/etc/printers.conf\fR. -.RE -.SH EXAMPLES -.LP -\fBExample 1 \fRSetting the Interest List -.sp -.LP -The following entry sets the interest list to destinations \fBps\fR, -\fBsecure\fR, and \fBdog\fR at server \fBwest\fR and \fBfinance_ps\fR: - -.sp -.in +2 -.nf -\fB_all ps,secure,west:dog,lpd://server/printers/queue\fR -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRSetting Aliases to a Printer -.sp -.LP -The following entry sets the aliases \fBps\fR, \fBlp\fR, and \fBlw\fR to -\fBsparc_printer\fR: - -.sp -.in +2 -.nf -\fBps|lp|lw sparc_printer\fR -.fi -.in -2 -.sp - -.LP -\fBExample 3 \fRSetting an Alias as a Default Destination -.sp -.LP -The following entry sets the alias \fBpcl\fR to \fBhplj\fR and sets it as the -default destination: - -.sp -.in +2 -.nf -\fBpcl|_default hplj\fR -.fi -.in -2 -.sp - -.LP -\fBExample 4 \fRSetting an Alias to a Server Destination -.sp -.LP -The following entry sets the alias \fBsecure\fR to destination \fBcatalpa\fR at -server \fBtabloid\fR: - -.sp -.in +2 -.nf -\fBsecure tabloid:catalpa\fR -.fi -.in -2 -.sp - -.LP -\fBExample 5 \fRSetting an Alias to a Site Destination -.sp -.LP -The following entry sets the alias \fBinsecure\fR to destination \fBlegal_ps\fR -using IPP: - -.sp -.in +2 -.nf -\fBinsecure ipp://server/printers/legal_ps\fR -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/etc/printers.conf\fR\fR -.ad -.RS 24n -System printer configuration database -.RE - -.sp -.ne 2 -.na -\fB\fB$HOME/.printers\fR\fR -.ad -.RS 24n -User-configurable printer database -.RE - -.sp -.ne 2 -.na -\fB\fBou=printers\fR\fR -.ad -.RS 24n -LDAP version of \fB/etc/printers.conf\fR -.RE - -.sp -.ne 2 -.na -\fB\fBprinters.conf.byname\fR\fR -.ad -.RS 24n -\fBNIS\fR version of \fB/etc/printers.conf\fR -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Stable -.TE - -.SH SEE ALSO -.LP -\fBcancel\fR(1), \fBlp\fR(1), \fBlpq\fR(1B), \fBlpr\fR(1B), \fBlprm\fR(1B), -\fBlpstat\fR(1), \fBlpadmin\fR(1M), \fBlpget\fR(1M), \fBnsswitch.conf\fR(4), -\fBprinters.conf\fR(4), \fBattributes\fR(5), \fBstandards\fR(5) -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.SH NOTES -.LP -\fB$HOME/.printers\fR is referenced by the printing commands before further -name resolution is made in \fB/etc/printers.conf\fR or the name service. If the -alias references a destination defined in \fB/etc/printers.conf\fR, it is -possible that the destination is defined differently on different systems. This -could cause output to be sent to an unintended destination if the user is -logged in to a different system. diff --git a/usr/src/man/man4/printers.conf.4 b/usr/src/man/man4/printers.conf.4 deleted file mode 100644 index 81318d73ed..0000000000 --- a/usr/src/man/man4/printers.conf.4 +++ /dev/null @@ -1,442 +0,0 @@ -'\" te -.\" Copyright (C) 2006, Sun Microsystems, Inc. All Rights Reserved -.\" 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 PRINTERS.CONF 4 "Feb 25, 2017" -.SH NAME -printers.conf \- system printing configuration database -.SH SYNOPSIS -.LP -.nf -\fB/etc/printers.conf\fR -.fi - -.SS "LDAP" -.LP -.nf -\fBou=printers\fR -.fi - -.SS "NIS" -.LP -.nf -\fBprinters.conf.byname\fR -.fi - -.SH DESCRIPTION -.LP -The \fBprinters.conf\fR file is the system printing configuration database. -System administrators use \fBprinters.conf\fR to describe destinations for the -print client commands and the print protocol adaptor. A destination names a -printer or class of printers. See \fBlpadmin\fR(1M). The \fBLP\fR print spooler -uses private \fBLP\fR configuration data for represented in the -\fBprinters.conf\fR database. -.SS "Entries" -.LP -Each entry in \fBprinters.conf\fR describes one destination. Entries are one -line consisting of any number of fields separated by colons (`\fB:\fR') and -terminated by a NEWLINE. The first field of each entry specifies the name of -the destination and aliases to which the entry describes. Specify one or more -names or aliases of the destination in this first field. Specify the -destination using atomic names. URI-style and POSIX-style names are not -acceptable. See \fBstandards\fR(5). Separate destination names by pipe signs -(`\fB|\fR'). -.sp -.LP -Two destination names are reserved for special use in the first entry. Use -\fB_all\fR to specify the interest list for \fBlpget\fR, \fBlpstat\fR, and -\fBcancel\fR. Use \fB_default\fR to specify the default destination. -.sp -.LP -The remaining fields in an entry are \fIkey\fR\fB=\fR\fIvalue\fR pairs. See -\fBSpecifying Configuration Options\fR for details regarding -\fIkey\fR\fB=\fR\fIvalue\fR pairs. -.sp -.LP -Empty lines can be included for readability. Entries can continue on to -multiple lines by adding a backslash (`\fB\e\fR\&') as the last character in -the line. \fBprinters.conf\fR can include comments. Comments have a pound sign -(`\fB#\fR') as the first character in the line, and are terminated by a -NEWLINE. Use the \fBlpset\fR command to create or modify \fBprinters.conf\fR. -See \fBlpset\fR(1M). Do \fBnot\fR make changes in \fBprinters.conf\fR by using -an editor. -.SS "Specifying Configuration Options" -.LP -\fIkey\fR\fB=\fR\fIvalue\fR pairs are configuration options defined by the -system administrator. \fIkey\fR and \fIvalue\fR can be of arbitrary length. -Separate \fIkey\fR and \fIvalue\fR by the equal (`\fB='\fR) character. -.SS "Client/Server Configuration Options" -.LP -The following client/server configuration options (represented as -\fIkey\fR\fB=\fR\fIvalue\fR pairs) are supported: -.sp -.ne 2 -.na -\fB\fBprinter-uri-supported=\fR\fIscheme\fR\fB://\fR\fIendpoint\fR\fR -.ad -.sp .6 -.RS 4n -Provides the information necessary to contact the print service for the entry. -The scheme generally identifies the print service or protocol to use. Currently -this is limited to \fBlpsched\fR, \fBipp\fR, and \fBlpd\fR but might be -expanded in the future. Each of these schemes imposes a set of restrictions for -specifying the endpoint and the functionality provided. -.sp -.ne 2 -.na -\fB\fBlpsched://\fR\fIlocalhost\fR\fB/printers/queue\fR\fR -.ad -.sp .6 -.RS 4n - This is URI form is used for print queues that are configured under the local -LP service. -.RE - -.sp -.ne 2 -.na -\fB\fBipp://\fR\fIserver\fR[:\fIport\fR\fB]/printers/queue\fR\fR -.ad -.br -.na -\fB\fBhttp://server:631/printers/queue\fR\fR -.ad -.br -.na -\fB\fBipp://\fR\fIserver\fR\fB[:\fR\fIport\fR\fB]/...\fR\fR -.ad -.sp .6 -.RS 4n -This URI form is used for print queues that are remotely accessible by way of -the Internet Print Protocol. This protocol is the preferred method of accessing -remote print queues because it provides the greatest functionality over the -wire. The \fBipp\fR uri scheme is specified in the internet print protocol -specifications and is much more free form than listed above. The actual content -and format of the endpoint is determined by the remote print service. -.RE - -.sp -.ne 2 -.na -\fB\fBlpd://\fR\fIserver\fR\fB/printers/queue[#Solaris]\fR\fR -.ad -.sp .6 -.RS 4n -This URI form is used for print queues that are remotely accessible by way of -the BSD Print Protocol. Though limited in capability, this protocol is widely -used between client and server. It provides maximum interoperability with -remote print services. When used to communicate with print services on a -Solaris print server, the optional \fB#Solaris\fR component of the URI -indicates that Solaris protocol extensions can be used during print job -submission. -.RE - -If an entry does not contain a printer-uri-supported key/value pair, the -bsdaddr value is converted to its equivalent uri form and a -printer-uri-supported key/value pair is added to the resulting data returned to -applications requesting printer configuration data. -.RE - -.sp -.ne 2 -.na -\fB\fBbsdaddr=\fR\fIserver\fR\fB,\fR\fIdestination\fR[\fB,Solaris\fR]\fR -.ad -.sp .6 -.RS 4n -Sets the server and destination name. Sets if the client generates protocol -extensions for use with the \fBlp\fR command (see \fBlp\fR(1)). \fBSolaris\fR -specifies a Solaris print server extension. If \fBSolaris\fR is not specified, -no protocol extensions are generated. \fIserver\fR is the name of the host -containing the queue for \fIdestination\fR. \fIdestination\fR is the atomic -name by which the server knows the destination. If the configuration file -contents are to be shared with legacy systems (Solaris 2.6 - Solaris 10), this -key/value pair should be provided for backward compatibility. -.RE - -.sp -.ne 2 -.na -\fB\fBuse=\fR\fIdestination\fR\fR -.ad -.sp .6 -.RS 4n -Sets the destination to continue searching for configuration information. -\fIdestination\fR is an atomic, URI-style (\fIscheme\fR://\fIendpoint\fR), or -Posix-style name (\fBserver\fR:\fBprinter\fR). -.RE - -.sp -.ne 2 -.na -\fB\fBall=\fR\fIdestination_list\fR\fR -.ad -.sp .6 -.RS 4n -Sets the interest list for the \fBlpget\fR, \fBlpstat\fR, and \fBcancel\fR -commands. \fIdestination_list\fR is a comma-separated list of destinations. -Specify \fIdestination\fR using atomic, URI-style -(\fIscheme\fR://\fIendpoint\fR), or Posix-style names (\fBserver:printer\fR). -See \fBlpget\fR(1M), \fBlpstat\fR(1), and \fBcancel\fR(1). -.RE - -.SS "LP Server Options" -.LP -The following \fBLP\fR configuration options (represented as -\fIkey\fR\fB=\fR\fIvalue\fR pairs) are supported: -.sp -.ne 2 -.na -\fB\fBuser-equivalence=\fR\fBtrue\fR|\fBfalse\fR\fR -.ad -.sp .6 -.RS 4n -Sets whether or not usernames are considered equivalent when cancelling a print -request submitted from a different host in a networked environment. \fBtrue\fR -means that usernames are considered equivalent, and permits users to cancel a -print requests submitted from a different host. \fBuser-equivalence\fR is set -to \fBfalse\fR by default. \fBfalse\fR means that usernames are not considered -equivalent, and does not permit users cancel a print request submitted from a -different host. If \fBuser-equivalence\fR is set to \fBfalse\fR, print requests -can only be cancelled by the users on the host on which the print request was -generated or by the superuser on the print server. -.RE - -.SS "Print Queue Name Resolution" -.LP -Applications needing to resolve print queue names (destinations) to the -associated print service and communications endpoint make use of a specific -name resolution ordering. Destination names in URI and POSIX form are complete -unto themselves and require no further resolution. Names in atomic form are -resolved based on the \fBprinters\fR database entry in the /etc/nsswitch.conf -file. See nsswitch.conf(4) -.SS "Locating the Personal Default Destination" -.LP -The default destination is located differently depending on the command. -.sp -.LP -The \fBlp\fR command locates the default destination in the following order: -.RS +4 -.TP -1. -\fBlp\fR command's \fB-d\fR \fIdestination\fR option. -.RE -.RS +4 -.TP -2. -\fBLPDEST\fR environment variable. -.RE -.RS +4 -.TP -3. -\fBPRINTER\fR environment variable. -.RE -.RS +4 -.TP -4. -\fB_default\fR destination in \fB$HOME/.printers\fR. -.RE -.RS +4 -.TP -5. -\fB_default\fR destination in \fB/etc/printers.conf\fR. -.RE -.sp -.LP -The \fBlpr\fR, \fBlpq\fR, and \fBlprm\fR commands locate the default -destination in the following order: -.RS +4 -.TP -1. -\fBlpr\fR command's \fB-P\fR \fIdestination\fR option. -.RE -.RS +4 -.TP -2. -\fBPRINTER\fR environment variable. -.RE -.RS +4 -.TP -3. -\fBLPDEST\fR environment variable. -.RE -.RS +4 -.TP -4. -\fB_default\fR destination in \fB$HOME/.printers\fR. -.RE -.RS +4 -.TP -5. -\fB_default\fR destination in \fB/etc/printers.conf\fR. -.RE -.SS "Locating the Interest List for lpstat, lpget, and cancel" -.LP -The \fBlpget\fR, \fBlpstat\fR, and \fBcancel\fR commands locate the interest -list in the following order: -.RS +4 -.TP -1. -\fB_all\fR list in \fB$HOME/.printers\fR. -.RE -.RS +4 -.TP -2. -\fB_all\fR list in \fB/etc/printers.conf\fR. -.RE -.SH EXAMPLES -.LP -\fBExample 1 \fRSetting the Interest List -.sp -.LP -The following entry sets the interest list for the \fBlpget\fR, \fBlpstat\fR -and \fBcancel\fR commands to \fBprinter1\fR, \fBprinter2\fR and \fBprinter3\fR: - -.sp -.in +2 -.nf -\fB_all:all=printer1,printer2,printer3\fR -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRSetting the Server Name -.sp -.LP -The following entry sets the server name to \fBserver\fR and printer name -to \fBps_printer\fR for destinations \fBprinter1\fR and \fBps\fR. It does not -generate BSD protocol extensions. - -.sp -.in +2 -.nf -\fBprinter1|ps:bsdaddr=server,ps_printer\fR -.fi -.in -2 -.sp - -.LP -\fBExample 3 \fRSetting Server Name and Destination Name -.sp -.LP -The following entry sets the server name to \fBserver\fR and destination name -to \fBpcl_printer\fR, for destination \fBprinter2\fR. It also generates -\fBSolaris\fR protocol extensions. - -.sp -.in +2 -.nf -\fBprinter2:printer-uri-supported=lpd\://server/printers/pcl_printer#Solaris\fR -.fi -.in -2 -.sp - -.LP -\fBExample 4 \fRSetting Server Name and Destination Name with Continuous Search -.sp -.LP -The following entry sets the server name to \fBserver\fR and destination name -to \fBnew_printer\fR, for destination \fBprinter3\fR. It also sets the -\fBprinter3\fR to continue searching for configuration information to printer -\fBanother_printer\fR. - -.sp -.in +2 -.nf -\fBprinter3:bsdaddr=server,new_printer:use=another_printer\fR -.fi -.in -2 -.sp - -.LP -\fBExample 5 \fRSetting Default Destination -.sp -.LP -The following entry sets the default destination to continue searching for -configuration information to destination \fBprinter1\fR. - -.sp -.in +2 -.nf -\fB_default:use=printer1\fR -.fi -.in -2 -.sp - -.LP -\fBExample 6 \fRUsing IPP as the URI -.sp -.LP -The following example uses IPP as the URI: - -.sp -.in +2 -.nf -\fBprinter4:printer-uri-supported=ipp\e://server/printers/queue\fR -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/etc/printers.conf\fR\fR -.ad -.RS 30n -System configuration database -.RE - -.sp -.ne 2 -.na -\fB\fB$HOME/.printers\fR\fR -.ad -.RS 30n -User-configurable printer database -.RE - -.sp -.ne 2 -.na -\fB\fBou=printers\fR\fR -.ad -.RS 30n -LDAP version of \fB/etc/printers.conf\fR -.RE - -.sp -.ne 2 -.na -\fB\fBprinters.conf.byname\fR (\fBNIS\fR)\fR -.ad -.RS 30n -\fBNIS\fR version of \fB/etc/printers.conf\fR -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Stability Level Stable -.TE - -.SH SEE ALSO -.LP -\fBcancel\fR(1), \fBenable\fR(1), \fBenable\fR(1), \fBlp\fR(1), \fBlpq\fR(1B), -\fBlpr\fR(1B), \fBlprm\fR(1B), \fBlpstat\fR(1), \fBaccept\fR(1M), -\fBin.lpd\fR(1M), \fBlpadmin\fR(1M), \fBlpget\fR(1M), \fBlpmove\fR(1M), -\fBlpset\fR(1M), \fBaccept\fR(1M), \fBnsswitch.conf\fR(4), \fBprinters\fR(4), -\fBattributes\fR(5), \fBstandards\fR(5) -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR diff --git a/usr/src/man/man4/priv_names.4 b/usr/src/man/man4/priv_names.4 deleted file mode 100644 index 6050c2cdd1..0000000000 --- a/usr/src/man/man4/priv_names.4 +++ /dev/null @@ -1,54 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 PRIV_NAMES 4 "Nov 24, 2003" -.SH NAME -priv_names \- privilege definition file -.SH SYNOPSIS -.LP -.nf -\fB/etc/security/priv_names\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBpriv_names\fR file, located in \fB/etc/security\fR, defines the -privileges with which a process can be associated. See \fBprivileges\fR(5) for -the privilege definitions. In that man page, privileges correspond to privilege -names in \fBpriv_names\fR as shown in the following examples: -.sp - -.sp -.TS -c c -l l . -name in privileges(5) Name in \fBpriv_names\fR -_ -\fBPRIV_FILE_CHOWN\fR \fBfile_chown\fR -\fBPRIV_FILE_CHOWN_SELF\fR \fBfile_chown_self\fR -\fBPRIV_FILE_DAC_EXECUTE\fR \fBfile_dac_execute\fR -.TE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBppriv\fR(1), \fBattributes\fR(5), \fBprivileges\fR(5) diff --git a/usr/src/man/man4/proc.4 b/usr/src/man/man4/proc.4 deleted file mode 100644 index e42afdd1fc..0000000000 --- a/usr/src/man/man4/proc.4 +++ /dev/null @@ -1,3248 +0,0 @@ -.\" Copyright 1989 AT&T -.\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2019, Joyent, Inc. -.\" Copyright 2020 OmniOS Community Edition (OmniOSce) Association. -.\" -.\" 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] -.\" -.Dd May 17, 2020 -.Dt PROC 4 -.Os -.Sh NAME -.Nm proc -.Nd /proc, the process file system -.Sh DESCRIPTION -.Pa /proc -is a file system that provides access to the state of each process -and light-weight process (lwp) in the system. -The name of each entry in the -.Pa /proc -directory is a decimal number corresponding to a process-ID. -These entries are themselves subdirectories. -Access to process state is provided by additional files contained within each -subdirectory; the hierarchy is described more completely below. -In this document, -.Dq Pa /proc file -refers to a non-directory file within the hierarchy rooted at -.Pa /proc . -The owner of each -.Pa /proc -file and subdirectory is determined by the user-ID of the process. -.Pp -.Pa /proc -can be mounted on any mount point, in addition to the standard -.Pa /proc -mount point, and can be mounted several places at once. -Such additional mounts are allowed in order to facilitate the confinement of -processes to subtrees of the file system via -.Xr chroot 2 -and yet allow such processes access to commands like -.Xr ps 1 . -.Pp -Standard system calls are used to access -.Pa /proc -files: -.Xr open 2 , -.Xr close 2 , -.Xr read 2 , -and -.Xr write 2 -(including -.Xr readv 2 , -.Xr writev 2 , -.Xr pread 2 , -and -.Xr pwrite 2 ) . -Most files describe process state and can only be opened for reading. -.Pa ctl -and -.Pa lwpctl -(control) files permit manipulation of process state and can only be opened for -writing. -.Pa as -(address space) files contain the image of the running process and can be -opened for both reading and writing. -An open for writing allows process control; a read-only open allows inspection -but not control. -In this document, we refer to the process as open for reading or writing if -any of its associated -.Pa /proc -files is open for reading or writing. -.Pp -In general, more than one process can open the same -.Pa /proc -file at the same time. \fIExclusive\fR \fIopen\fR is an advisory mechanism provided to -allow controlling processes to avoid collisions with each other. -A process can obtain exclusive control of a target process, with respect to -other cooperating processes, if it successfully opens any -.Pa /proc -file in the target process for writing (the -.Pa as -or -.Pa ctl -files, or the -.Pa lwpctl -file of any lwp) while specifying -.Sy O_EXCL -in the -.Xr open 2 . -Such an open will fail if the target process is already open for writing (that -is, if an -.Pa as , -.Pa ctl , -or -.Pa lwpctl -file is already open for writing). -There can be any number of concurrent read-only opens; -.Sy O_EXCL -is ignored on opens for reading. -It is recommended that the first open for writing by a controlling -process use the -.Sy O_EXCL -flag; multiple controlling processes usually result in chaos. -.Pp -If a process opens one of its own -.Pa /proc -files for writing, the open -succeeds regardless of -.Sy O_EXCL -and regardless of whether some other process has the process open for writing. -Self-opens do not count when another process attempts an exclusive open. -(A process cannot exclude a debugger by opening itself for writing and the -application of a debugger cannot prevent a process from opening itself.) -All self-opens for writing are forced to be close-on-exec (see the -.Sy F_SETFD -operation of -.Xr fcntl 2 ) . -.Pp -Data may be transferred from or to any locations in the address space of the -traced process by applying -.Xr lseek 2 -to position the -.Pa as -file at the virtual address of interest followed by -.Xr read 2 -or -.Xr write 2 -(or by using -.Xr pread 2 -or -.Xr pwrite 2 -for the combined operation). -The address-map files -.Pa /proc/ Ns Em pid Ns Pa /map -and -.Pa /proc/ Ns Em pid Ns Pa /xmap -can be read to determine the accessible areas (mappings) of the address space. -.Sy I/O -transfers may span contiguous mappings. -An -.Sy I/O -request extending into an unmapped area is truncated at the boundary. -A write request beginning at an unmapped virtual address fails with -.Er EIO ; -a read request beginning at an unmapped virtual address returns zero (an -end-of-file indication). -.Pp -Information and control operations are provided through additional files. -.In procfs.h -contains definitions of data structures and message formats -used with these files. -Some of these definitions involve the use of sets of flags. -The set types -.Sy sigset_t , -.Sy fltset_t , -and -.Sy sysset_t -correspond, respectively, to signal, fault, and system call enumerations -defined in -.In sys/signal.h , -.In sys/fault.h , -and -.In sys/syscall.h . -Each set type is large enough to hold flags for its own enumeration. -Although they are of different sizes, they have a common -structure and can be manipulated by these macros: -.Bd -literal -offset indent -prfillset(&set); /* turn on all flags in set */ -premptyset(&set); /* turn off all flags in set */ -praddset(&set, flag); /* turn on the specified flag */ -prdelset(&set, flag); /* turn off the specified flag */ -r = prismember(&set, flag); /* != 0 iff flag is turned on */ -.Ed -.Pp -One of -.Fn prfillset -or -.Fn premptyset -must be used to initialize -.Fa set -before it is used in any other operation. -.Fa flag -must be a member of the enumeration corresponding to -.Fa set . -.Pp -Every process contains at least one -.Em light-weight process , -or -.Sy lwp . -Each lwp represents a flow of execution that is independently scheduled by the -operating system. -All lwps in a process share its address space as well as many other attributes. -Through the use of -.Pa lwpctl -and -.Pa ctl -files as described below, it is possible to affect individual lwps in a -process or to affect all of them at once, depending on the operation. -.Pp -When the process has more than one lwp, a representative lwp is chosen by the -system for certain process status files and control operations. -The representative lwp is a stopped lwp only if all of the process's lwps are -stopped; is stopped on an event of interest only if all of the lwps are so -stopped (excluding -.Sy PR_SUSPENDED -lwps); is in a -.Sy PR_REQUESTED -stop only if there are no other events of interest to be found; or, failing -everything else, is in a -.Sy PR_SUSPENDED -stop (implying that the process is deadlocked). -See the description of the -.Pa status -file for definitions of stopped states. -See the -.Sy PCSTOP -control operation for the definition of -.Dq event of interest . -.Pp -The representative lwp remains fixed (it will be chosen again on the next -operation) as long as all of the lwps are stopped on events of interest or are -in a -.Sy PR_SUSPENDED -stop and the -.Sy PCRUN -control operation is not applied to any of them. -.Pp -When applied to the process control file, every -.Pa /proc -control operation -that must act on an lwp uses the same algorithm to choose which lwp to act -upon. -Together with synchronous stopping (see -.Sy PCSET ) , -this enables a debugger to control a multiple-lwp process using only the -process-level status and control files if it so chooses. -More fine-grained control can be achieved using the lwp-specific files. -.Pp -The system supports two process data models, the traditional 32-bit data model -in which ints, longs and pointers are all 32 bits wide (the ILP32 data model), -and on some platforms the 64-bit data model in which longs and pointers, but -not ints, are 64 bits in width (the LP64 data model). -In the LP64 data model some system data types, notably -.Sy size_t , -.Sy off_t , -.Sy time_t -and -.Sy dev_t , -grow from 32 bits to 64 bits as well. -.Pp -The -.Pa /proc -interfaces described here are available to both 32-bit and -64-bit controlling processes. -However, many operations attempted by a 32-bit -controlling process on a 64-bit target process will fail with -.Er EOVERFLOW -because the address space range of a 32-bit process cannot encompass a 64-bit -process or because the data in some 64-bit system data type cannot be -compressed to fit into the corresponding 32-bit type without loss of -information. -Operations that fail in this circumstance include reading and -writing the address space, reading the address-map files, and setting the -target process's registers. -There is no restriction on operations applied by a -64-bit process to either a 32-bit or a 64-bit target processes. -.Pp -The format of the contents of any -.Pa /proc -file depends on the data model of the observer (the controlling process), not -on the data model of the target process. -A 64-bit debugger does not have to translate the information it reads from a -.Pa /proc -file for a 32-bit process from 32-bit format to 64-bit format. -However, it usually has to be aware of the data model of the target process. -The -.Sy pr_dmodel -field of the -.Pa status -files indicates the target process's data model. -.Pp -To help deal with system data structures that are read from 32-bit processes, a -64-bit controlling program can be compiled with the C preprocessor symbol -.Dv _SYSCALL32 -defined before system header files are included. -This makes explicit 32-bit fixed-width data structures (like -.Sy struct stat32 ) -visible to the 64-bit program. -See -.Xr types32.h 3HEAD . -.Sh DIRECTORY STRUCTURE -At the top level, the directory -.Pa /proc -contains entries each of which names an existing process in the system. -These entries are themselves directories. -Except where otherwise noted, the files described below can be -opened for reading only. -In addition, if a process becomes a -.Em zombie -(one that has exited but whose parent has not yet performed a -.Xr wait 3C -upon it), most of its associated -.Pa /proc -files disappear from the hierarchy; subsequent attempts to open them, or to -read or write files opened before the process exited, will elicit the error -.Er ENOENT . -.Pp -Although process state and consequently the contents of -.Pa /proc -files can change from instant to instant, a single -.Xr read 2 -of a -.Pa /proc -file is guaranteed to return a sane representation of state; that is, the read -will be atomic with respect to the state of the process. -No such guarantee applies to successive reads applied to a -.Pa /proc -file for a running process. -In addition, atomicity is not guaranteed for -.Sy I/O -applied to the -.Pa as -(address-space) file for a running process or for a process whose address space -contains memory shared by another running process. -.Pp -A number of structure definitions are used to describe the files. -These structures may grow by the addition of elements at the end in future -releases of the system and it is not legitimate for a program to assume that -they will not. -.Sh STRUCTURE OF Pa /proc/ Ns Em pid -A given directory -.Pa /proc/ Ns Em pid -contains the following entries. -A process can use the invisible alias -.Pa /proc/self -if it wishes to open one of its own -.Pa /proc -files (invisible in the sense that the name -.Dq self -does not appear in a directory listing of -.Pa /proc -obtained from -.Xr ls 1 , -.Xr getdents 2 , -or -.Xr readdir 3C ) . -.Ss contracts -A directory containing references to the contracts held by the process. -Each entry is a symlink to the contract's directory under -.Pa /system/contract . -See -.Xr contract 4 . -.Ss as -Contains the address-space image of the process; it can be opened for both -reading and writing. -.Xr lseek 2 -is used to position the file at the virtual address of interest and then the -address space can be examined or changed through -.Xr read 2 -or -.Xr write 2 -(or by using -.Xr pread 2 -or -.Xr pwrite 2 -for the combined operation). -.Ss ctl -A write-only file to which structured messages are written directing the system -to change some aspect of the process's state or control its behavior in some -way. -The seek offset is not relevant when writing to this file. -Individual lwps also have associated -.Pa lwpctl -files in the lwp subdirectories. -A control message may be written either to the process's -.Pa ctl -file or to a specific -.Pa lwpctl -file with operation-specific effects. -The effect of a control message is immediately reflected in the state of the -process visible through appropriate status and information files. -The types of control messages are described in detail later. -See -.Sx CONTROL MESSAGES . -.Ss status -Contains state information about the process and the representative lwp. -The file contains a -.Sy pstatus -structure which contains an embedded -.Sy lwpstatus -structure for the representative lwp, as follows: -.Bd -literal -offset 2 -typedef struct pstatus { - int pr_flags; /* flags (see below) */ - int pr_nlwp; /* number of active lwps in the process */ - int pr_nzomb; /* number of zombie lwps in the process */ - pid_tpr_pid; /* process id */ - pid_tpr_ppid; /* parent process id */ - pid_tpr_pgid; /* process group id */ - pid_tpr_sid; /* session id */ - id_t pr_aslwpid; /* obsolete */ - id_t pr_agentid; /* lwp-id of the agent lwp, if any */ - sigset_t pr_sigpend; /* set of process pending signals */ - uintptr_t pr_brkbase; /* virtual address of the process heap */ - size_t pr_brksize; /* size of the process heap, in bytes */ - uintptr_t pr_stkbase; /* virtual address of the process stack */ - size_tpr_stksize; /* size of the process stack, in bytes */ - timestruc_t pr_utime; /* process user cpu time */ - timestruc_t pr_stime; /* process system cpu time */ - timestruc_t pr_cutime; /* sum of children's user times */ - timestruc_t pr_cstime; /* sum of children's system times */ - sigset_t pr_sigtrace; /* set of traced signals */ - fltset_t pr_flttrace; /* set of traced faults */ - sysset_t pr_sysentry; /* set of system calls traced on entry */ - sysset_t pr_sysexit; /* set of system calls traced on exit */ - char pr_dmodel; /* data model of the process */ - taskid_t pr_taskid; /* task id */ - projid_t pr_projid; /* project id */ - zoneid_t pr_zoneid; /* zone id */ - lwpstatus_t pr_lwp; /* status of the representative lwp */ -} pstatus_t; -.Ed -.Pp -.Sy pr_flags -is a bit-mask holding the following process flags. -For convenience, it also contains the lwp flags for the representative lwp, -described later. -.Bl -tag -width "PR_MSACCT" -offset indent -.It Sy PR_ISSYS -process is a system process (see -.Sx PCSTOP ) . -.It Sy PR_VFORKP -process is the parent of a vforked child (see -.Sx PCWATCH ) . -.It Sy PR_FORK -process has its inherit-on-fork mode set (see -.Sx PCSET ) . -.It Sy PR_RLC -process has its run-on-last-close mode set (see -.Sx PCSET ) . -.It Sy PR_KLC -process has its kill-on-last-close mode set (see -.Sx PCSET ) . -.It Sy PR_ASYNC -process has its asynchronous-stop mode set (see -.Sx PCSET ) . -.It Sy PR_MSACCT -Set by default in all processes to indicate that microstate accounting is -enabled. -However, this flag has been deprecated and no longer has any effect. -Microstate accounting may not be disabled; however, it is still possible to -toggle the flag. -.It Sy PR_MSFORK -Set by default in all processes to indicate that microstate accounting will be -enabled for processes that this parent -.Xr fork 2 Ns s . -However, this flag has been deprecated and no longer has any effect. -It is possible to toggle this flag; however, it is not possible to disable -microstate accounting. -.It Sy PR_BPTADJ -process has its breakpoint adjustment mode set (see -.Sx PCSET ) . -.It Sy PR_PTRACE -process has its ptrace-compatibility mode set (see -.Sx PCSET ) . -.El -.Pp -.Sy pr_nlwp -is the total number of active lwps in the process. -.Sy pr_nzomb -is the total number of zombie lwps in the process. -A zombie lwp is a non-detached lwp that has terminated but has not been reaped -with -.Xr thr_join 3C -or -.Xr pthread_join 3C . -.Pp -.Sy pr_pid , -.Sy pr_ppi , -.Sy pr_pgid , -and -.Sy pr_sid -are, respectively, the process ID, the ID of the process's parent, the -process's process group ID, and the process's session ID. -.Pp -.Sy pr_aslwpid -is obsolete and is always zero. -.Pp -.Sy pr_agentid -is the lwp-ID for the -.Pa /proc -agent lwp (see the -.Sx PCAGENT -control operation). -It is zero if there is no agent lwp in the process. -.Pp -.Sy pr_sigpend -identifies asynchronous signals pending for the process. -.Pp -.Sy pr_brkbase -is the virtual address of the process heap and -.Sy pr_brksize -is its size in bytes. -The address formed by the sum of these values is the process -.Sy break -(see -.Xr brk 2 ) . -.Sy pr_stkbase -and -.Sy pr_stksize -are, respectively, the virtual address of the process stack and its size in -bytes. -(Each lwp runs on a separate stack; the distinguishing characteristic of the -process stack is that the operating system will grow it when necessary.) -.Pp -.Sy pr_utime , -.Sy pr_stime , -.Sy pr_cutime , -.Sy and pr_cstime -are, respectively, the user -.Sy CPU -and system -.Sy CPU -time consumed by the process, and the cumulative user -.Sy CPU -and system -.Sy CPU -time consumed by the process's children, in seconds and nanoseconds. -.Pp -.Sy pr_sigtrace -and -.Sy pr_flttrace -contain, respectively, the set of signals and the set of hardware faults that -are being traced (see -.Sx PCSTRACE -and -.Sx PCSFAULT ) . -.Pp -.Sy pr_sysentry -and -.Sy pr_sysexit -contain, respectively, the sets of system calls being traced on entry and exit -(see -.Sx PCSENTRY -and -.Sx PCSEXIT ) . -.Pp -.Sy pr_dmodel -indicates the data model of the process. -Possible values are: -.Bl -tag -width "PR_MODEL_NATIVE" -offset indent -.It Sy PR_MODEL_ILP32 -process data model is ILP32. -.It Sy PR_MODEL_LP64 -process data model is LP64. -.It Sy PR_MODEL_NATIVE -process data model is native. -.El -.Pp -The -.Sy pr_taskid , -.Sy pr_projid , -and -.Sy pr_zoneid -fields contain respectively, the numeric -.Sy ID Ns s -of the task, project, and zone in which the process was running. -.Pp -The constant -.Sy PR_MODEL_NATIVE -reflects the data model of the controlling process, -.Em that is , -its value is -.Sy PR_MODEL_ILP32 -or -.Sy PR_MODEL_LP64 -according to whether the controlling process has been -compiled as a 32-bit program or a 64-bit program, respectively. -.Pp -.Sy pr_lwp -contains the status information for the representative lwp: -.Bd -literal -offset 2 -typedef struct lwpstatus { - int pr_flags; /* flags (see below) */ - id_t pr_lwpid; /* specific lwp identifier */ - short pr_why; /* reason for lwp stop, if stopped */ - short pr_what; /* more detailed reason */ - short pr_cursig; /* current signal, if any */ - siginfo_t pr_info; /* info associated with signal or fault */ - sigset_t pr_lwppend; /* set of signals pending to the lwp */ - sigset_t pr_lwphold; /* set of signals blocked by the lwp */ - struct sigaction pr_action;/* signal action for current signal */ - stack_t pr_altstack; /* alternate signal stack info */ - uintptr_t pr_oldcontext; /* address of previous ucontext */ - short pr_syscall; /* system call number (if in syscall) */ - short pr_nsysarg; /* number of arguments to this syscall */ - int pr_errno; /* errno for failed syscall */ - long pr_sysarg[PRSYSARGS]; /* arguments to this syscall */ - long pr_rval1; /* primary syscall return value */ - long pr_rval2; /* second syscall return value, if any */ - char pr_clname[PRCLSZ]; /* scheduling class name */ - timestruc_t pr_tstamp; /* real-time time stamp of stop */ - timestruc_t pr_utime; /* lwp user cpu time */ - timestruc_t pr_stime; /* lwp system cpu time */ - uintptr_t pr_ustack; /* stack boundary data (stack_t) address */ - ulong_t pr_instr; /* current instruction */ - prgregset_t pr_reg; /* general registers */ - prfpregset_t pr_fpreg; /* floating-point registers */ -} lwpstatus_t; -.Ed -.Pp -.Sy pr_flags -is a bit-mask holding the following lwp flags. -For convenience, it also contains the process flags, described previously. -.Bl -tag -width "PR_STOPPED" -offset indent -.It Sy PR_STOPPED -The lwp is stopped. -.It Sy PR_ISTOP -The lwp is stopped on an event of interest (see -.Sx PCSTOP ) . -.It Sy PR_DSTOP -The lwp has a stop directive in effect (see -.Sx PCSTOP ) . -.It Sy PR_STEP -The lwp has a single-step directive in effect (see -.Sx PCRUN ) . -.It Sy PR_ASLEEP -The lwp is in an interruptible sleep within a system call. -.It Sy PR_PCINVAL -The lwp's current instruction -.Pq Sy pr_instr -is undefined. -.It Sy PR_DETACH -This is a detached lwp (see -.Xr pthread_create 3C -and -.Xr pthread_join 3C ) . -.It Sy PR_DAEMON -This is a daemon lwp (see -.Xr pthread_create 3C ) . -.It Sy PR_ASLWP -This flag is obsolete and is never set. -.It Sy PR_AGENT -This is the -.Pa /proc -agent lwp for the process. -.El -.Pp -.Sy pr_lwpid -names the specific lwp. -.Pp -.Sy pr_why -.Sy and -pr_what -together describe, for a stopped lwp, the reason for the stop. -Possible values of -.Sy pr_why -and the associated -.Sy pr_what -are: -.Bl -tag -width "PR_JOBCONTROL" -offset left -.It Sy PR_REQUESTED -indicates that the stop occurred in response to a stop directive, normally -because -.Sy PCSTOP -was applied or because another lwp stopped on an event of interest and the -asynchronous-stop flag (see -.Sx PCSET ) -was not set for the process. -.Sy pr_what -is unused in this case. -.It Sy PR_SIGNALLED -indicates that the lwp stopped on receipt of a signal (see -.Sx PCSTRACE ) ; -.Sy pr_what -holds the signal number that caused the stop (for a newly-stopped -lwp, the same value is in -.Sy pr_cursig ) . -.It Sy PR_FAULTED -indicates that the lwp stopped on incurring a hardware fault (see -.Sx PCSFAULT ) ; -.Sy pr_what -holds the fault number that caused the stop. -.It Sy PR_SYSENTRY -.It Sy PR_SYSEXIT -indicate a stop on entry to or exit from a system call (see -.Sx PCSENTRY -and -.Sx PCSEXIT ) ; -.Sy pr_what -holds the system call number. -.It Sy PR_JOBCONTROL -indicates that the lwp stopped due to the default action of a job control stop -signal (see -.Xr sigaction 2 ) ; -.Sy pr_what -holds the stopping signal number. -.It Sy PR_SUSPENDED -indicates that the lwp stopped due to internal synchronization of lwps within -the process. -.Sy pr_what -is unused in this case. -.It Sy PR_BRAND -indicates that the lwp stopped for a brand-specific reason. -Interpretation of the value of -.Sy pr_what -depends on which zone brand is in use. -It is not generally expected that an lwp stopped in this state will be -restarted by native -.\" mandoc(1) doesn't like .Xr macros referring to itself, so this is -.\" a bit of a hack. -.Nm Ns Pq 4 -consumers. -.El -.Pp -.Sy pr_cursig -names the current signal, that is, the next signal to be delivered to the lwp, -if any. -.Sy pr_info , -when the lwp is in a -.Sy PR_SIGNALLED -or -.Sy PR_FAULTED -stop, contains additional information pertinent to the particular signal or -fault (see -.In sys/siginfo.h ) . -.Pp -.Sy pr_lwppend -identifies any synchronous or directed signals pending for the lwp. -.Sy pr_lwphold -identifies those signals whose delivery is being blocked by the lwp (the -signal mask). -.Pp -.Sy pr_action -contains the signal action information pertaining to the current signal (see -.Xr sigaction 2 ) ; -it is undefined if -.Sy pr_cursig -is zero. -.Sy pr_altstack -contains the alternate signal stack information for the lwp (see -.Xr sigaltstack 2 ) . -.Pp -.Sy pr_oldcontext , -if not zero, contains the address on the lwp stack of a -.Sy ucontext -structure describing the previous user-level context (see -.Xr ucontext.h 3HEAD ) . -It is non-zero only if the lwp is executing in the context of a signal handler. -.Pp -.Sy pr_syscall -is the number of the system call, if any, being executed by -the lwp; it is non-zero if and only if the lwp is stopped on -.Sy PR_SYSENTRY -or -.Sy PR_SYSEXIT , -or is asleep within a system call -.Pf ( Sy PR_ASLEEP -is set). -If -.Sy pr_syscall -is non-zero, -.Sy pr_nsysarg -is the number of arguments to the system call and -.Sy pr_sysarg -contains the actual arguments. -.Pp -.Sy pr_rval1 , -.Sy pr_rval2 , -and -.Sy pr_errno -are defined only if the lwp -is stopped on -.Sy PR_SYSEXIT -or if the -.Sy PR_VFORKP -flag is set. -If -.Sy pr_errno -is zero, -.Sy pr_rval1 -and -.Sy pr_rval2 -contain the return values from the system call. -Otherwise, -.Sy pr_errno -contains the error number for the failing system call (see -.In sys/errno.h ) . -.Pp -.Sy pr_clname -contains the name of the lwp's scheduling class. -.Pp -.Sy pr_tstamp , -if the lwp is stopped, contains a time stamp marking when the -lwp stopped, in real time seconds and nanoseconds since an arbitrary time in -the past. -.Pp -.Sy pr_utime -is the amount of user level CPU time used by this LWP. -.Pp -.Sy pr_stime -is the amount of system level CPU time used by this LWP. -.Pp -.Sy pr_ustack -is the virtual address of the -.Sy stack_t -that contains the stack boundaries for this LWP. -See -.Xr getustack 2 -and -.Xr _stack_grow 3C . -.Pp -.Sy pr_instr -contains the machine instruction to which the lwp's program counter refers. -The amount of data retrieved from the process is machine-dependent. -On SPARC based machines, it is a 32-bit word. -On x86-based machines, it is a single byte. -In general, the size is that of the machine's smallest instruction. -If -.Sy PR_PCINVAL -is set, -.Sy pr_instr -is undefined; this occurs whenever the lwp is not stopped or when the program -counter refers to an invalid virtual address. -.Pp -.Sy pr_reg -is an array holding the contents of a stopped lwp's general registers. -.Bl -tag -offset left -width "SPARC V8 (32-bit)" -.It Sy SPARC -On SPARC-based machines, the predefined constants -.Sy R_G0 -\&.\&.\&. -.Sy R_G7 , -.Sy R_O0 -\&.\&.\&. -.Sy R_O7 , -.Sy R_L0 -\&.\&.\&. -.Sy R_L7 , -.Sy R_I0 -\&.\&.\&. -.Sy R_I7 , -.Sy R_PC , -.Sy R_nPC , -and -.Sy R_Y -can be used as indices to refer to the corresponding registers; previous -register windows can be read from their overflow locations on the stack -(however, see the -.Pa gwindows -file in the -.Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid -subdirectory). -.It Sy SPARC V8 (32-bit) -For SPARC V8 (32-bit) controlling processes, the predefined constants -.Sy R_PSR , -.Sy R_WIM , -and -.Sy R_TBR -can be used as indices to refer to the corresponding special registers. -For SPARC V9 (64-bit) controlling processes, the predefined constants -.Sy R_CCR , -.Sy R_ASI , -and -.Sy R_FPRS -can be used as indices to refer to the corresponding special registers. -.It Sy x86 (32-bit) -For 32-bit x86 processes, the predefined constants listed belowcan be used as -indices to refer to the corresponding registers. -.Bl -tag -width "TRAPNO" -offset indent -compact -.It SS -.It UESP -.It EFL -.It CS -.It EIP -.It ERR -.It TRAPNO -.It EAX -.It ECX -.It EDX -.It EBX -.It ESP -.It EBP -.It ESI -.It EDI -.It DS -.It ES -.It GS -.El -.Pp -The preceding constants are listed in -.In sys/regset.h . -.Pp -Note that a 32-bit process can run on an x86 64-bit system, using the constants -listed above. -.It Sy x86 (64-bit) -To read the registers of a 32- -.Em or -a 64-bit process, a 64-bit x86 process should use the predefined constants -listed below. -.Bl -tag -width "REG_TRAPNO" -offset indent -compact -.It REG_GSBASE -.It REG_FSBASE -.It REG_DS -.It REG_ES -.It REG_GS -.It REG_FS -.It REG_SS -.It REG_RSP -.It REG_RFL -.It REG_CS -.It REG_RIP -.It REG_ERR -.It REG_TRAPNO -.It REG_RAX -.It REG_RCX -.It REG_RDX -.It REG_RBX -.It REG_RBP -.It REG_RSI -.It REG_RDI -.It REG_R8 -.It REG_R9 -.It REG_R10 -.It REG_R11 -.It REG_R12 -.It REG_R13 -.It REG_R14 -.It REG_R15 -.El -.Pp -The preceding constants are listed in -.In sys/regset.h . -.El -.Pp -.Sy pr_fpreg -is a structure holding the contents of the floating-point registers. -.Pp -SPARC registers, both general and floating-point, as seen by a 64-bit -controlling process are the V9 versions of the registers, even if the target -process is a 32-bit (V8) process. -V8 registers are a subset of the V9 registers. -.Pp -If the lwp is not stopped, all register values are undefined. -.Ss psinfo -Contains miscellaneous information about the process and the representative lwp -needed by the -.Xr ps 1 -command. -.Sy psinfo -remains accessible after a process becomes a -.Em zombie . -The file contains a -.Sy psinfo -structure which contains an embedded -.Sy lwpsinfo -structure for the representative lwp, as follows: -.Bd -literal -offset 2 -typedef struct psinfo { - int pr_flag; /* process flags (DEPRECATED: see below) */ - int pr_nlwp; /* number of active lwps in the process */ - int pr_nzomb; /* number of zombie lwps in the process */ - pid_t pr_pid; /* process id */ - pid_t pr_ppid; /* process id of parent */ - pid_t pr_pgid; /* process id of process group leader */ - pid_t pr_sid; /* session id */ - uid_t pr_uid; /* real user id */ - uid_t pr_euid; /* effective user id */ - gid_t pr_gid; /* real group id */ - gid_t pr_egid; /* effective group id */ - uintptr_t pr_addr; /* address of process */ - size_t pr_size; /* size of process image in Kbytes */ - size_t pr_rssize; /* resident set size in Kbytes */ - dev_t pr_ttydev; /* controlling tty device (or PRNODEV) */ - ushort_t pr_pctcpu; /* % of recent cpu time used by all lwps */ - ushort_t pr_pctmem; /* % of system memory used by process */ - timestruc_t pr_start; /* process start time, from the epoch */ - timestruc_t pr_time; /* cpu time for this process */ - timestruc_t pr_ctime; /* cpu time for reaped children */ - char pr_fname[PRFNSZ]; /* name of exec'ed file */ - char pr_psargs[PRARGSZ]; /* initial characters of arg list */ - int pr_wstat; /* if zombie, the wait() status */ - int pr_argc; /* initial argument count */ - uintptr_t pr_argv; /* address of initial argument vector */ - uintptr_t pr_envp; /* address of initial environment vector */ - char pr_dmodel; /* data model of the process */ - taskid_t pr_taskid; /* task id */ - projid_t pr_projid; /* project id */ - poolid_t pr_poolid; /* pool id */ - zoneid_t pr_zoneid; /* zone id */ - ctid_t pr_contract; /* process contract id */ - lwpsinfo_t pr_lwp; /* information for representative lwp */ -} psinfo_t; -.Ed -.Pp -Some of the entries in -.Sy psinfo , -such as -.Sy pr_addr , -refer to internal kernel data structures and should not be expected to retain -their meanings across different versions of the operating system. -.Pp -.Sy psinfo_t.pr_flag -is a deprecated interface that should no longer be used. -Applications currently relying on the -.Sy SSYS -bit in -.Sy pr_flag -should migrate to checking -.Sy PR_ISSYS -in the -.Sy pstatus -structure's -.Sy pr_flags -field. -.Pp -.Sy pr_pctcpu -and -.Sy pr_pctmem -are 16-bit binary fractions in the range 0.0 to 1.0 with the binary point to -the right of the high-order bit (1.0 == 0x8000). -.Sy pr_pctcpu -is the summation over all lwps in the process. -.Pp -The -.Sy pr_fname -and -.Sy pr_psargs -are writable by the owner of the process. -To write to them, the -.Sy psinfo -file should be open for writing and the desired value for the field should be -written at the file offset that corresponds to the member of structure. -No other entry may be written to; if a write is attempted to an offset that -does not represent one of these two memers, or if the size of the write is not -exactly the size of the member being written, no bytes will be written and -zero will be returned. -.Pp -.Sy pr_lwp -contains the -.Xr ps 1 -information for the representative lwp. -If the process is a -.Em zombie , -.Sy pr_nlwp , -.Sy pr_nzomb , -and -.Sy pr_lwp.pr_lwpid -are zero and the other fields of -.Sy pr_lwp -are undefined: -.Bd -literal -offset 2 -typedef struct lwpsinfo { - int pr_flag; /* lwp flags (DEPRECATED: see below) */ - id_t pr_lwpid; /* lwp id */ - uintptr_t pr_addr; /* internal address of lwp */ - uintptr_t pr_wchan; /* wait addr for sleeping lwp */ - char pr_stype; /* synchronization event type */ - char pr_state; /* numeric lwp state */ - char pr_sname; /* printable character for pr_state */ - char pr_nice; /* nice for cpu usage */ - short pr_syscall; /* system call number (if in syscall) */ - char pr_oldpri; /* pre-SVR4, low value is high priority */ - char pr_cpu; /* pre-SVR4, cpu usage for scheduling */ - int pr_pri; /* priority, high value = high priority */ - ushort_t pr_pctcpu; /* % of recent cpu time used by this lwp */ - timestruc_t pr_start; /* lwp start time, from the epoch */ - timestruc_t pr_time; /* cpu time for this lwp */ - char pr_clname[PRCLSZ]; /* scheduling class name */ - char pr_name[PRFNSZ]; /* name of system lwp */ - processorid_t pr_onpro; /* processor which last ran this lwp */ - processorid_t pr_bindpro;/* processor to which lwp is bound */ - psetid_t pr_bindpset; /* processor set to which lwp is bound */ - lgrp_id_t pr_lgrp; /* home lgroup */ -} lwpsinfo_t; -.Ed -.Pp -Some of the entries in -.Sy lwpsinfo , -such as -.Sy pr_addr , -.Sy pr_wchan , -.Sy pr_stype , -.Sy pr_state , -and -.Sy pr_name , -refer to internal kernel data structures and should not be expected to retain -their meanings across different versions of the operating system. -.Pp -.Sy lwpsinfo_t.pr_flag -is a deprecated interface that should no longer be used. -.Pp -.Sy pr_pctcpu -is a 16-bit binary fraction, as described above. -It represents the -.Sy CPU -time used by the specific lwp. -On a multi-processor machine, the maximum value is 1/N, where N is the number -of -.Sy CPU Ns s . -.Pp -.Sy pr_contract -is the id of the process contract of which the process is a member. -See -.Xr contract 4 -and -.Xr process 4 . -.Ss cred -Contains a description of the credentials associated with the process: -.Bd -literal -offset 2 -typedef struct prcred { - uid_t pr_euid; /* effective user id */ - uid_t pr_ruid; /* real user id */ - uid_t pr_suid; /* saved user id (from exec) */ - gid_t pr_egid; /* effective group id */ - gid_t pr_rgid; /* real group id */ - gid_t pr_sgid; /* saved group id (from exec) */ - int pr_ngroups; /* number of supplementary groups */ - gid_t pr_groups[1]; /* array of supplementary groups */ -} prcred_t; -.Ed -.Pp -The array of associated supplementary groups in -.Sy pr_groups - is of variable -length; the -.Sy cred -file contains all of the supplementary groups. -.Sy pr_ngroups -indicates the number of supplementary groups. (See also the -.Sy PCSCRED -and -.Sy PCSCREDX -control operations.) -.Ss priv -Contains a description of the privileges associated with the process: -.Bd -literal -offset 2 -typedef struct prpriv { - uint32_t pr_nsets; /* number of privilege set */ - uint32_t pr_setsize; /* size of privilege set */ - uint32_t pr_infosize; /* size of supplementary data */ - priv_chunk_t pr_sets[1]; /* array of sets */ -} prpriv_t; -.Ed -.Pp -The actual dimension of the -.Sy pr_sets Ns [] -field is -.D1 pr_sets[pr_nsets][pr_setsize] -.Pp -which is followed by additional information about the process state -.Sy pr_infosize -bytes in size. -.Pp -The full size of the structure can be computed using -.Fn PRIV_PRPRIV_SIZE "prpriv_t *" . -.Ss secflags -This file contains the security-flags of the process. -It contains a description of the security flags associated with the process. -.Bd -literal -offset 2 -typedef struct prsecflags { - uint32_t pr_version; /* ABI Versioning of this structure */ - secflagset_t pr_effective; /* Effective flags */ - secflagset_t pr_inherit; /* Inheritable flags */ - secflagset_t pr_lower; /* Lower flags */ - secflagset_t pr_upper; /* Upper flags */ -} prsecflags_t; -.Ed -.Pp -The -.Sy pr_version -field is a version number for the structure, currently -.Sy PRSECFLAGS_VERSION_1 . -.Ss sigact -Contains an array of -.Sy sigaction structures -describing the current dispositions of all signals associated with the traced -process (see -.Xr sigaction 2 ) . -Signal numbers are displaced by 1 from array indices, so that the action for -signal number -.Va n -appears in position -.Va n Ns -1 -of the array. -.Ss auxv -Contains the initial values of the process's aux vector in an array of -.Sy auxv_t -structures (see -.In sys/auxv.h ) . -The values are those that were passed by the operating system as startup -information to the dynamic linker. -.Ss argv -Contains the concatenation of each of the argument strings, including their -.Sy NUL -terminators, in the argument vector -.Pq Va argv -for the process. -If the process has modified either its argument vector, or the contents of -any of the strings referenced by that vector, those changes will be visible -here. -.Ss ldt -This file exists only on x86-based machines. -It is non-empty only if the process has established a local descriptor table -.Pq Sy LDT . -If non-empty, the file contains the array of currently active -.Sy LDT -entries in an array of elements of type -.Vt struct ssd , -defined in -.In sys/sysi86.h , -one element for each active -.Sy LDT -entry. -.Ss map, xmap -Contain information about the virtual address map of the process. -The map file contains an array of -.Sy prmap -structures while the xmap file contains an -array of -.Sy prxmap -structures. -Each structure describes a contiguous virtual -address region in the address space of the traced process: -.Bd -literal -offset 2 -typedef struct prmap { - uintptr_tpr_vaddr; /* virtual address of mapping */ - size_t pr_size; /* size of mapping in bytes */ - char pr_mapname[PRMAPSZ]; /* name in /proc/pid/object */ - offset_t pr_offset; /* offset into mapped object, if any */ - int pr_mflags; /* protection and attribute flags */ - int pr_pagesize; /* pagesize for this mapping in bytes */ - int pr_shmid; /* SysV shared memory identifier */ -} prmap_t; -.Ed -.Bd -literal -offset 2 -typedef struct prxmap { - uintptr_t pr_vaddr; /* virtual address of mapping */ - size_t pr_size; /* size of mapping in bytes */ - char pr_mapname[PRMAPSZ]; /* name in /proc/pid/object */ - offset_t pr_offset; /* offset into mapped object, if any */ - int pr_mflags; /* protection and attribute flags */ - int pr_pagesize; /* pagesize for this mapping in bytes */ - int pr_shmid; /* SysV shared memory identifier */ - dev_t pr_dev; /* device of mapped object, if any */ - uint64_t pr_ino; /* inode of mapped object, if any */ - size_t pr_rss; /* pages of resident memory */ - size_t pr_anon; /* pages of resident anonymous memory */ - size_t pr_locked; /* pages of locked memory */ - uint64_t pr_hatpagesize; /* pagesize of mapping */ -} prxmap_t; -.Ed -.Pp -.Sy pr_vaddr -is the virtual address of the mapping within the traced process and -.Sy pr_size -is its size in bytes. -.Sy pr_mapname , -if it does not contain a null string, contains the name of a file in the -.Sy object -directory (see below) that can be opened read-only to obtain a file descriptor -for the mapped file associated with the mapping. -This enables a debugger to find object file symbol tables without having to -know the real path names of the executable file and shared libraries of -the process. -.Sy pr_offset -is the 64-bit offset within the mapped file (if any) to which the virtual -address is mapped. -.Pp -.Sy pr_mflags -is a bit-mask of protection and attribute flags: -.Bl -tag -width "MA_NORESERVE" -offset left -.It Sy MA_READ -mapping is readable by the traced process. -.It Sy MA_WRITE -mapping is writable by the traced process. -.It Sy MA_EXEC -mapping is executable by the traced process. -.It Sy MA_SHARED -mapping changes are shared by the mapped object. -.It Sy MA_ISM -mapping is intimate shared memory (shared MMU resources) -.It Sy MAP_NORESERVE -mapping does not have swap space reserved (mapped with MAP_NORESERVE) -.It Sy MA_SHM -mapping System V shared memory -.El -.Pp -A contiguous area of the address space having the same underlying mapped object -may appear as multiple mappings due to varying read, write, and execute -attributes. -The underlying mapped object does not change over the range of a -single mapping. -An -.Sy I/O -operation to a mapping marked -.Sy MA_SHARED -fails if applied at a virtual address not corresponding to a valid page in the -underlying mapped object. -A write to a -.Sy MA_SHARED -mapping that is not marked -.Sy MA_WRITE -fails. -Reads and writes to private mappings always succeed. -Reads and writes to unmapped addresses fail. -.Pp -.Sy pr_pagesize -is the page size for the mapping, currently always the system pagesize. -.Pp -.Sy pr_shmid -is the shared memory identifier, if any, for the mapping. -Its value is \-1 -if the mapping is not System V shared memory. -See -.Xr shmget 2 . -.Pp -.Sy pr_dev -is the device of the mapped object, if any, for the mapping. -Its value is -.Sy PRNODEV -.Pq \-1 -if the mapping does not have a device. -.Pp -.Sy pr_ino -is the inode of the mapped object, if any, for the mapping. -Its contents are only valid if -.Sy pr_dev -is not -.Sy PRNODEV . -.Pp -.Sy pr_rss -is the number of resident pages of memory for the mapping. -The number of resident bytes for the mapping may be determined by multiplying -.Sy pr_rss -by the page size given by -.Sy pr_pagesize . -.Pp -.Sy pr_anon -is the number of resident anonymous memory pages (pages which are -private to this process) for the mapping. -.Pp -.Sy pr_locked -is the number of locked pages for the mapping. -Pages which are locked are always resident in memory. -.Pp -.Sy pr_hatpagesize -is the size, in bytes, of the -.Sy HAT -.Pq Sy MMU -translation for the mapping. -.Sy pr_hatpagesize -may be different than -.Sy pr_pagesize . -The possible values are hardware architecture specific, and -may change over a mapping's lifetime. -.Ss rmap -Contains information about the reserved address ranges of the process. -The file contains an array of -.Sy prmap -structures, as defined above for the -.Sy map -file. -Each structure describes a contiguous virtual address region in the -address space of the traced process that is reserved by the system in the sense -that an -.Xr mmap 2 -system call that does not specify -.Sy MAP_FIXED -will not use any part of it for the new mapping. -Examples of such reservations include the address ranges reserved for the -process stack and the individual thread stacks of a multi-threaded process. -.Ss cwd -A symbolic link to the process's current working directory. -See -.Xr chdir 2 . -A -.Xr readlink 2 -of -.Pa /proc/ Ns Em pid Ns Pa /cwd -yields a null string. -However, it can be opened, listed, and searched as a directory, and can be the -target of -.Xr chdir 2 . -.Ss root -A symbolic link to the process's root directory. -.Pa /proc/ Ns Em pid Ns Pa /root -can differ from the system root directory if the process or one of its -ancestors executed -.Xr chroot 2 -as super user. -It has the same semantics as -.Pa /proc/ Ns Em pid Ns Pa /cwd . -.Ss fd -A directory containing references to the open files of the process. -Each entry is a decimal number corresponding to an open file descriptor in the -process. -.Pp -If an entry refers to a regular file, it can be opened with normal file system -semantics but, to ensure that the controlling process cannot gain greater -access than the controlled process, with no file access modes other than its -read/write open modes in the controlled process. -If an entry refers to a directory, it can be accessed with the same semantics -as -.Pa /proc/ Ns Em pid Ns Pa /cwd . -An attempt to open any other type of entry fails with -.Er EACCES . -.Ss fdinfo -A directory containing information about each of the process's open files. -Each entry is a decimal number corresponding to an open file descriptor in the -process. -Each file contains a -.Sy prfdinfo_t -structure defined as follows: -.Bd -literal -offset 2 -typedef struct prfdinfo { - int pr_fd; /* file descriptor number */ - mode_t pr_mode; /* (see st_mode in stat(2)) */ - uint64_t pr_ino; /* inode number */ - uint64_t pr_size; /* file size */ - int64_t pr_offset; /* current offset of file descriptor */ - uid_t pr_uid; /* owner's user id */ - gid_t pr_gid; /* owner's group id */ - major_t pr_major; /* major number of device containing file */ - minor_t pr_minor; /* minor number of device containing file */ - major_t pr_rmajor; /* major number (if special file) */ - minor_t pr_rminor; /* minor number (if special file) */ - int pr_fileflags; /* (see F_GETXFL in fcntl(2)) */ - int pr_fdflags; /* (see F_GETFD in fcntl(2)) */ - short pr_locktype; /* (see F_GETLK in fcntl(2)) */ - pid_t pr_lockpid; /* process holding file lock (see F_GETLK) */ - int pr_locksysid; /* sysid of locking process (see F_GETLK) */ - pid_t pr_peerpid; /* peer process (socket, door) */ - int pr_filler[25]; /* reserved for future use */ - char pr_peername[PRFNSZ]; /* peer process name */ -#if __STDC_VERSION__ >= 199901L - char pr_misc[]; /* self describing structures */ -#else - char pr_misc[1]; -#endif -} prfdinfo_t; -.Ed -.Pp -The -.Sy pr_misc -element points to a list of additional miscellaneous data items, each of which -has a header of type -.Sy pr_misc_header_t -specifying the size and type, and some data which immediately follow -the header. -.Bd -literal -offset 2 -typedef struct pr_misc_header { - uint_t pr_misc_size; - uint_t pr_misc_type; -} pr_misc_header_t; -.Ed -.Pp -The -.Sy pr_misc_size -field is the sum of the sizes of the header and the associated data and any -trailing padding bytes which will be set to zero. -The end of the list is indicated by a header with a zero size and a type with -all bits set. -.Pp -The following miscellaneous data types can be present: -.Bl -tag -width "PR_SOCKOPT_TCP_CONGESTION" -offset left -.It Sy PR_PATHNAME -The file descriptor's path in the filesystem. -This is a NUL-terminated sequence of characters. -.It Sy PR_SOCKETNAME -A -.Sy sockaddr -structure representing the local socket name for this file descriptor, as -would be returned by calling -.Fn getsockname -within the process. -.It Sy PR_PEERSOCKNAME -A -.Sy sockaddr -structure representing the peer socket name for this file descriptor, as -would be returned by calling -.Fn getpeername -within the process. -.It Sy PR_SOCKOPTS_BOOL_OPTS -An unsigned integer which has bits set corresponding to options which are -set on the underlying socket. -The following bits may be set: -.Bl -tag -width "PR_SO_PASSIVE_CONNECT" -.It Sy PR_SO_DEBUG -.It Sy PR_SO_REUSEADDR -.It Sy PR_SO_REUSEPORT -.It Sy PR_SO_KEEPALIVE -.It Sy PR_SO_DONTROUTE -.It Sy PR_SO_BROADCAST -.It Sy PR_SO_OOBINLINE -.It Sy PR_SO_DGRAM_ERRIND -.It Sy PR_SO_ALLZONES -.It Sy PR_SO_MAC_EXEMPT -.It Sy PR_SO_EXCLBIND -.It Sy PR_SO_PASSIVE_CONNECT -.It Sy PR_SO_ACCEPTCONN -.It Sy PR_UDP_NAT_T_ENDPOINT -.It Sy PR_SO_VRRP -.It Sy PR_SO_MAC_IMPLICIT -.El -.It Sy PR_SOCKOPT_LINGER -A -.Sy struct linger -as would be returned by calling -.Fn getsockopt SO_LINGER -within the process. -.It Sy PR_SOCKOPT_SNDBUF -The data that would be returned by calling -.Fn getsockopt SO_SNDBUF -within the process. -.It Sy PR_SOCKOPT_RCVBUF -The data that would be returned by calling -.Fn getsockopt SO_RCVBUF -within the process. -.It Sy PR_SOCKOPT_IP_NEXTHOP -The data that would be returned by calling -.Fn getsockopt IPPROTO_IP IP_NEXTHOP -within the process. -.It Sy PR_SOCKOPT_IPV6_NEXTHOP -The data that would be returned by calling -.Fn getsockopt IPPROTO_IPV6 IPV6_NEXTHOP -within the process. -.It Sy PR_SOCKOPT_TYPE -The data that would be returned by calling -.Fn getsockopt SO_TYPE -within the process. -.It Sy PR_SOCKOPT_TCP_CONGESTION -For TCP sockets, the data that would be returned by calling -.Fn getsockopt IPPROTO_TCP TCP_CONGESTION -within the process. -This is a NUL-terminated character array containing the name of the congestion -algorithm in use for the socket. -.It Sy PR_SOCKFILTERS_PRIV -Private data relating to up to the first 32 socket filters pushed on this -descriptor. -.El -.Ss object -A directory containing read-only files with names corresponding to the -.Sy pr_mapname -entries in the -.Sy map -and -.Sy pagedata -files. -Opening such a file yields a file descriptor for the underlying mapped file -associated with an address-space mapping in the process. -The file name -.Pa a.out -appears in the directory as an alias for the process's executable file. -.Pp -The -.Pa object -directory makes it possible for a controlling process to gain -access to the object file and any shared libraries (and consequently the symbol -tables) without having to know the actual path names of the executable files. -.Ss path -A directory containing symbolic links to files opened by the process. -The directory includes one entry for -.Pa cwd -and -.Pa root . -The directory also contains a numerical entry for each file descriptor in the -.Pa fd -directory, and entries matching those in the -.Pa object -directory. -If this information is not available, any attempt to read the contents of the -symbolic link will fail. -This is most common for files that do not exist in the filesystem namespace -(such as -.Sy FIFO Ns s -and sockets), but can also happen for regular files. -For the file descriptor entries, the path may be different from the one -used by the process to open the file. -.Ss pagedata -Opening the page data file enables tracking of address space references and -modifications on a per-page basis. -.Pp -A -.Xr read 2 -of the page data file descriptor returns structured page data -and atomically clears the page data maintained for the file by the system. -That is to say, each read returns data collected since the last read; the -first read returns data collected since the file was opened. -When the call completes, the read buffer contains the following structure as -its header and thereafter contains a number of section header structures and -associated byte arrays that must be accessed by walking linearly through the -buffer. -.Bd -literal -offset 2 -typedef struct prpageheader { - timestruc_t pr_tstamp; /* real time stamp, time of read() */ - ulong_t pr_nmap; /* number of address space mappings */ - ulong_t pr_npage; /* total number of pages */ -} prpageheader_t; -.Ed -.Pp -The header is followed by -.Sy "pr_nmap prasmap" -structures and associated data arrays. -The -.Sy prasmap -structure contains the following elements: -.Bd -literal -offset 2 -typedef struct prasmap { - uintptr_t pr_vaddr; /* virtual address of mapping */ - ulong_t pr_npage; /* number of pages in mapping */ - char pr_mapname[PRMAPSZ]; /* name in /proc/pid/object */ - offset_t pr_offset; /* offset into mapped object, if any */ - int pr_mflags; /* protection and attribute flags */ - int pr_pagesize; /* pagesize for this mapping in bytes */ - int pr_shmid; /* SysV shared memory identifier */ -} prasmap_t; -.Ed -.Pp -Each section header is followed by -.Sy pr_npage -bytes, one byte for each page in the mapping, plus 0-7 null bytes at the end -so that the next -.Sy prasmap -structure begins on an eight-byte aligned boundary. -Each data byte may contain these flags: -.Bl -tag -width "PG_REFERENCED" -offset 2 -.It Sy PG_REFERENCED -page has been referenced. -.It Sy PG_MODIFIED -page has been modified. -.El -.Pp -If the read buffer is not large enough to contain all of the page data, the -read fails with -.Er E2BIG -and the page data is not cleared. -The required size of the read buffer can be determined through -.Xr fstat 2 . -Application of -.Xr lseek 2 -to the page data file descriptor is ineffective; every read -starts from the beginning of the file. -Closing the page data file descriptor -terminates the system overhead associated with collecting the data. -.Pp -More than one page data file descriptor for the same process can be opened, up -to a system-imposed limit per traced process. -A read of one does not affect the data being collected by the system for the -others. -An open of the page data file will fail with -.Er ENOMEM -if the system-imposed limit would be exceeded. -.Ss watch -Contains an array of -.Vt prwatch -structures, one for each watched area established by the -.Sy PCWATCH -control operation. -See -.Sx PCWATCH -for details. -.Ss usage -Contains process usage information described by a -.Vt prusage -structure which contains at least the following fields: -.Bd -literal -offset 2 -typedef struct prusage { - id_t pr_lwpid; /* lwp id. 0: process or defunct */ - int pr_count; /* number of contributing lwps */ - timestruc_t pr_tstamp; /* real time stamp, time of read() */ - timestruc_t pr_create; /* process/lwp creation time stamp */ - timestruc_t pr_term; /* process/lwp termination time stamp */ - timestruc_t pr_rtime; /* total lwp real (elapsed) time */ - timestruc_t pr_utime; /* user level CPU time */ - timestruc_t pr_stime; /* system call CPU time */ - timestruc_t pr_ttime; /* other system trap CPU time */ - timestruc_t pr_tftime; /* text page fault sleep time */ - timestruc_t pr_dftime; /* data page fault sleep time */ - timestruc_t pr_kftime; /* kernel page fault sleep time */ - timestruc_t pr_ltime; /* user lock wait sleep time */ - timestruc_t pr_slptime; /* all other sleep time */ - timestruc_t pr_wtime; /* wait-cpu (latency) time */ - timestruc_t pr_stoptime; /* stopped time */ - ulong_t pr_minf; /* minor page faults */ - ulong_t pr_majf; /* major page faults */ - ulong_t pr_nswap; /* swaps */ - ulong_t pr_inblk; /* input blocks */ - ulong_t pr_oublk; /* output blocks */ - ulong_t pr_msnd; /* messages sent */ - ulong_t pr_mrcv; /* messages received */ - ulong_t pr_sigs; /* signals received */ - ulong_t pr_vctx; /* voluntary context switches */ - ulong_t pr_ictx; /* involuntary context switches */ - ulong_t pr_sysc; /* system calls */ - ulong_t pr_ioch; /* chars read and written */ -} prusage_t; -.Ed -.Pp -Microstate accounting is now continuously enabled. -While this information was -previously an estimate, if microstate accounting were not enabled, the current -information is now never an estimate represents time the process has spent in -various states. -.Ss lstatus -Contains a -.Vt prheader -structure followed by an array of -.Vt lwpstatus -structures, one for each active lwp in the process (see also -.Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /lwpstatus , -below). -The -.Vt prheader -structure describes the number and size of the array entries that follow. -.Bd -literal -offset 2 -typedef struct prheader { - long pr_nent; /* number of entries */ - size_t pr_entsize; /* size of each entry, in bytes */ -} prheader_t; -.Ed -.Pp -The -.Vt lwpstatus -structure may grow by the addition of elements at the end in future releases -of the system. -Programs must use -.Sy pr_entsize -in the file header to index through the array. -These comments apply to all -.Pa /proc -files that include a -.Vt prheader -structure -.Pf ( Pa lpsinfo -and -.Pa lusage , -below). -.Ss lpsinfo -Contains a -.Vt prheader -structure followed by an array of -.Vt lwpsinfo -structures, one for eachactive and zombie lwp in the process. -See also -.Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /lwpsinfo , -below. -.Ss lusage -Contains a -.Vt prheader -structure followed by an array of -.Vt prusage -structures, one for each active lwp in the process, plus an additional element -at the beginning that contains the summation over all defunct lwps (lwps that -once existed but no longer exist in the process). -Excluding the -.Sy pr_lwpid , -.Sy pr_tstamp , -.Sy pr_create , -and -.Sy pr_term -entries, the entry-by-entry summation over all these structures is the -definition of the process usage information obtained from the -.Pa usage -file. (See also -.Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /lwpusage , -below.) -.Ss lwp -A directory containing entries each of which names an active or zombie lwp -within the process. -These entries are themselves directories containing additional files as -described below. -Only the -.Pa lwpsinfo -file exists in the directory of a zombie lwp. -.Sh "STRUCTURE OF" Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid -A given directory -.Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid -contains the following entries: -.Ss lwpctl -Write-only control file. -The messages written to this file affect the specific -lwp rather than the representative lwp, as is the case for the process's -.Pa ctl -file. -.Ss lwpname -A buffer of -.Dv THREAD_NAME_MAX -bytes representing the LWP name; the buffer is -zero-filled if the thread name is shorter than the buffer. -If no thread name is set, the buffer contains the empty string. -A read with a buffer shorter than -.Dv THREAD_NAME_MAX -bytes is not guaranteed to be NUL-terminated. -Writing to this file will set the LWP name for the specific lwp. -This file may not be present in older operating system versions. -.Dv THREAD_NAME_MAX -may increase in the future; clients should be prepared for this. -.Ss lwpstatus -lwp-specific state information. -This file contains the -.Vt lwpstatus -structure for the specific lwp as described above for the representative lwp in -the process's -.Pa status -file. -.Ss lwpsinfo -lwp-specific -.Xr ps 1 -information. -This file contains the -.Vt lwpsinfo -structure for the specific lwp as described above for the representative lwp in -the process's -.Pa psinfo -file. -The -.Pa lwpsinfo -file remains accessible after an lwp becomes a zombie. -.Ss lwpusage -This file contains the -.Vt prusage -structure for the specific lwp as described above for the process's -.Pa usage -file. -.Ss gwindows -This file exists only on SPARC based machines. -If it is non-empty, it contains a -.Vt gwindows_t -structure, defined in -.In sys/regset.h , -with the values of those SPARC register windows that could not be stored on -the stack when the lwp stopped. -Conditions under which register windows are not stored on the -stack are: the stack pointer refers to nonexistent process memory or the stack -pointer is improperly aligned. -If the lwp is not stopped or if there are no -register windows that could not be stored on the stack, the file is empty (the -usual case). -.Ss xregs -Extra state registers. -The extra state register set is architecture dependent; -this file is empty if the system does not support extra state registers. -If the file is non-empty, it contains an architecture dependent structure of -type -.Vt prxregset_t , -defined in -.In procfs.h , -with the values of the lwp's extra state registers. -If the lwp is not stopped, all register values are undefined. -See also the -.Sx PCSXREG -control operation, below. -.Ss asrs -This file exists only for 64-bit SPARC V9 processes. -It contains an -.Vt asrset_t -structure, defined in -.In sys/regset.h , -containing the values of the lwp's platform-dependent ancillary state registers. -If the lwp is not stopped, all register values are undefined. -See also the -.Sx PCSASRS -control operation, below. -.Ss spymaster -For an agent lwp (see -.Sx PCAGENT ) , -this file contains a -.Vt psinfo_t -structure that corresponds to the process that created the agent lwp at the -time the agent was created. -This structure is identical to that retrieved via the -.Pa psinfo -file, with one modification: the -.Sy pr_time -field does not correspond to the CPU time for the process, but rather to the -creation time of the agent lwp. -.Ss templates -A directory which contains references to the active templates for the lwp, -named by the contract type. -Changes made to an active template descriptor do -not affect the original template which was activated, though they do affect the -active template. -It is not possible to activate an active template descriptor. -See -.Xr contract 4 . -.Sh CONTROL MESSAGES -Process state changes are effected through messages written to a process's -.Sy ctl -file or to an individual lwp's -.Sy lwpctl -file. -All control messages consist of a -.Sy long -that names the specific operation followed by -additional data containing the operand, if any. -.Pp -Multiple control messages may be combined in a single -.Xr write 2 -(or -.Xr writev 2 ) -to a control file, but no partial writes are permitted. -That is, each control message, operation code plus operand, if any, must be -presented in its entirety to the -.Xr write 2 -and not in pieces over several system calls. -If a control operation fails, no subsequent operations contained in the same -.Xr write 2 -are attempted. -.Pp -Descriptions of the allowable control messages follow. -In all cases, writing a message to a control file for a process or lwp that -has terminated elicits the error -.Er ENOENT . -.Ss PCSTOP PCDSTOP PCWSTOP PCTWSTOP -When applied to the process control file, -.Sy PCSTOP -directs all lwps to stop and waits for them to stop, -.Sy PCDSTOP -directs all lwps to stop without waiting for them to stop, and -.Sy PCWSTOP -simply waits for all lwps to stop. -When applied to an lwp control file, -.Sy PCSTOP -directs the specific lwp to stop and waits until it has stopped, -.Sy PCDSTOP -directs the specific lwp to stop without waiting for it to stop, and -.Sy PCWSTOP - simply waits for the specific lwp to stop. -When applied to an lwp control file, -.Sy PCSTOP -and -.Sy PCWSTOP -complete when the lwp stops on an event of interest, immediately -if already so stopped; when applied to the process control file, they complete -when every lwp has stopped either on an event of interest or on a -.Sy PR_SUSPENDED -stop. -.Pp -.Sy PCTWSTOP -is identical to -.Sy PCWSTOP -except that it enables the operation to time out, to avoid waiting forever for -a process or lwp that may never stop on an event of interest. -.Sy PCTWSTOP -takes a -.Sy long -operand specifying a number of milliseconds; the wait will terminate -successfully after the specified number of milliseconds even if the process or -lwp has not stopped; a timeout value of zero makes the operation identical to -.Sy PCWSTOP . -.Pp -An -.Dq event of interest -is either a -.Sy PR_REQUESTED -stop or a stop that has been specified in the process's tracing flags (set by -.Sy PCSTRACE , -.Sy PCSFAULT , -.Sy PCSENTRY , -and -.Sy PCSEXIT ) . -.Sy PR_JOBCONTROL - and -.Sy PR_SUSPENDED -stops are specifically not events of interest. -(An lwp may stop twice due to a stop signal, first showing -.Sy PR_SIGNALLED -if the signal is traced and again showing -.Sy PR_JOBCONTROL -if the lwp is set running without clearing the signal.) -If -.Sy PCSTOP -or -.Sy PCDSTOP -is applied to an -lwp that is stopped, but not on an event of interest, the stop directive takes -effect when the lwp is restarted by the competing mechanism. -At that time, the lwp enters a -.Sy PR_REQUESTED -stop before executing any user-level code. -.Pp -A write of a control message that blocks is interruptible by a signal so that, -for example, an -.Xr alarm 2 -can be set to avoid waiting forever for a -process or lwp that may never stop on an event of interest. -If -.Sy PCSTOP -is interrupted, the lwp stop directives remain in effect even though the -.Xr write 2 -returns an error. -(Use of -.Sy PCTWSTOP -with a non-zero timeout is recommended over -.Sy PCWSTOP -with an -.Xr alarm 2 . ) -.Pp -A system process (indicated by the -.Sy PR_ISSYS -flag) never executes at user level, has no user-level address space visible -through -.Pa /proc , -and cannot be stopped. -Applying one of these operations to a system process or any of its -lwps elicits the error -.Er EBUSY . -.Ss PCRUN -Make an lwp runnable again after a stop. -This operation takes a -.Vt long -operand containing zero or more of the following flags: -.Bl -tag -width "PRSABORT" -offset left -.It Sy PRCSIG -clears the current signal, if any (see -.Sx PCCSIG ) . -.It Sy PRCFAULT -clears the current fault, if any (see -.Sx PCCFAULT ) . -.It Sy PRSTEP -directs the lwp to execute a single machine instruction. -On completion of the instruction, a trace trap occurs. -If -.Sy FLTTRACE -is being traced, the lwp stops; otherwise, it is sent -.Sy SIGTRAP . -If -.Sy SIGTRAP -is being traced and is not blocked, the lwp stops. -When the lwp stops on an event of interest, -the single-step directive is cancelled, even if the stop occurs before the -instruction is executed. -This operation requires hardware and operating system -support and may not be implemented on all processors. -It is implemented on SPARC and x86-based machines. -.It Sy PRSABORT -is meaningful only if the lwp is in a -.Sy PR_SYSENTRY -stop or is marked -.Sy PR_ASLEEP ; -it instructs the lwp to abort execution of the system call (see -.Sx PCSENTRY -and -.Sx PCSEXIT ) . -.It Sy PRSTOP -directs the lwp to stop again as soon as possible after resuming execution (see -.Sx PCDSTOP ) . -In particular, if the lwp is stopped on -.Sy PR_SIGNALLED -or -.Sy PR_FAULTED , -the next stop will show -.Sy PR_REQUESTED , -no other stop -will have intervened, and the lwp will not have executed any user-level code. -.El -.Pp -When applied to an lwp control file, -.Sy PCRUN -clears any outstanding -directed-stop request and makes the specific lwp runnable. -The operation fails with -.Er EBUSY -if the specific lwp is not stopped on an event of interest or -has not been directed to stop or if the agent lwp exists and this is not the -agent lwp (see -.Sx PCAGENT ) . -.Pp -When applied to the process control file, a representative lwp is chosen for -the operation as described for -.Pa /proc/ Ns Em pid Ns Pa /status . -The operation fails with -.Er EBUSY -if the representative lwp is not stopped on an -event of interest or has not been directed to stop or if the agent lwp exists. -If -.Sy PRSTEP -or -.Sy PRSTOP -was requested, the representative lwp is made -runnable and its outstanding directed-stop request is cleared; otherwise all -outstanding directed-stop requests are cleared and, if it was stopped on an -event of interest, the representative lwp is marked -.Sy PR_REQUESTED . -If, as a consequence, all lwps are in the -.Sy PR_REQUESTED -or -.Sy PR_SUSPENDED -stop state, all lwps showing -.Sy PR_REQUESTED -are made runnable. -.Ss PCSTRACE -Define a set of signals to be traced in the process. -The receipt of one of these signals by an lwp causes the lwp to stop. -The set of signals is defined using an operand -.Sy sigset_t -contained in the control message. -Receipt of -.Sy SIGKILL -cannot be traced; if specified, it is silently ignored. -.Pp -If a signal that is included in an lwp's held signal set (the signal mask) is -sent to the lwp, the signal is not received and does not cause a stop until it -is removed from the held signal set, either by the lwp itself or by setting the -held signal set with -.Sy PCSHOLD . -.Ss PCCSIG -The current signal, if any, is cleared from the specific or representative lwp. -.Ss PCSSIG -The current signal and its associated signal information for the specific or -representative lwp are set according to the contents of the operand -.Vt siginfo -structure (see -.In sys/siginfo.h ) . -If the specified signal number is zero, the current signal is cleared. -The semantics of this operation are different from those of -.Xr kill 2 -in that the signal is delivered to the lwp immediately after execution is -resumed (even if it is being blocked) and an additional -.Sy PR_SIGNALLED -stop does not intervene even if the signal is traced. -Setting the current signal to -.Sy SIGKILL -terminates the process immediately. -.Ss PCKILL -If applied to the process control file, a signal is sent to the process with -semantics identical to those of -.Xr kill 2 -If applied to an lwp control file, a directed signal is sent to the specific -lwp. -The signal is named in a -.Vt long -operand contained in the message. -Sending -.Sy SIGKILL -terminates the process immediately. -.Ss PCUNKILL -A signal is deleted, that is, it is removed from the set of pending signals. -If applied to the process control file, the signal is deleted from the process's -pending signals. -If applied to an lwp control file, the signal is deleted from -the lwp's pending signals. -The current signal (if any) is unaffected. -The signal is named in a -.Sy long -operand in the control message. -It is an error -.Pq Er EINVAL -to attempt to delete -.Sy SIGKILL . -.Ss PCSHOLD -Set the set of held signals for the specific or representative lwp (signals -whose delivery will be blocked if sent to the lwp). -The set of signals is specified with a -.Vt sigset_t -operand. -.Sy SIGKILL -and -.Sy SIGSTOP -cannot be held; if specified, they are silently ignored. -.Ss PCSFAULT -Define a set of hardware faults to be traced in the process. -On incurring one of these faults, an lwp stops. -The set is defined via the operand -.Vt fltset_t -structure. -Fault names are defined in -.In sys/fault.h -and include the following. -Some of these may not occur on all processors; there may -be processor-specific faults in addition to these. -.Bl -tag -width "FLTACCESS" -offset indent -.It Sy FLTILL -illegal instruction -.It Sy FLTPRIV -privileged instruction -.It Sy FLTBPT -breakpoint trap -.It Sy FLTTRACE -trace trap (single-step) -.It Sy FLTWATCH -watchpoint trap -.It Sy FLTACCESS -memory access fault (bus error) -.It Sy FLTBOUNDS -memory bounds violation -.It Sy FLTIOVF -integer overflow -.It Sy FLTIZDIV -integer zero divide -.It Sy FLTFPE -floating-point exception -.It Sy FLTSTACK -unrecoverable stack fault -.It Sy FLTPAGE -recoverable page fault -.El -.Pp -When not traced, a fault normally results in the posting of a signal to the lwp -that incurred the fault. -If an lwp stops on a fault, the signal is posted to -the lwp when execution is resumed unless the fault is cleared by -.Sy PCCFAULT -or by the -.Sy PRCFAULT -option of -.Sy PCRUN . -.Sy FLTPAGE -is an exception; no signal is posted. -The -.Sy pr_info -field in the -.Vt lwpstatus -structure identifies the signal to be sent and contains machine-specific -information about the fault. -.Ss PCCFAULT -The current fault, if any, is cleared; the associated signal will not be sent -to the specific or representative lwp. -.Ss PCSENTRY PCSEXIT -These control operations instruct the process's lwps to stop on entry to or -exit from specified system calls. -The set of system calls to be traced is defined via an operand -.Vt sysset_t -structure. -.Pp -When entry to a system call is being traced, an lwp stops after having begun -the call to the system but before the system call arguments have been fetched -from the lwp. -When exit from a system call is being traced, an lwp stops on completion of -the system call just prior to checking for signals and returning to user level. -At this point, all return values have been stored into the lwp's registers. -.Pp -If an lwp is stopped on entry to a system call -.Pq Sy PR_SYSENTRY -or when sleeping in an interruptible system call -.Pf ( Sy PR_ASLEEP -is set), it may be instructed to go directly to system call exit by specifying -the -.Sy PRSABORT -flag in a -.Sy PCRUN -control message. -Unless exit from the system call is being traced, the lwp returns to user -level showing -.Er EINTR . -.Ss PCWATCH -Set or clear a watched area in the controlled process from a -.Vt prwatch -structure operand: -.Bd -literal -offset 2 -typedef struct prwatch { - uintptr_t pr_vaddr; /* virtual address of watched area */ - size_t pr_size; /* size of watched area in bytes */ - int pr_wflags; /* watch type flags */ -} prwatch_t; -.Ed -.Pp -.Sy pr_vaddr -specifies the virtual address of an area of memory to be watched -in the controlled process. -.Sy pr_size -specifies the size of the area, in bytes. -.Sy pr_wflags -specifies the type of memory access to be monitored as a -bit-mask of the following flags: -.Bl -tag -width "WA_TRAPAFTER" -offset indent -.It Sy WA_READ -read access -.It Sy WA_WRITE -write access -.It Sy WA_EXEC -execution access -.It Sy WA_TRAPAFTER -trap after the instruction completes -.El -.Pp -If -.Sy pr_wflags -is non-empty, a watched area is established for the virtual -address range specified by -.Sy pr_vaddr -and -.Sy pr_size . -If -.Sy pr_wflags -is empty, any previously-established watched area starting at the specified -virtual address is cleared; -.Sy pr_size -is ignored. -.Pp -A watchpoint is triggered when an lwp in the traced process makes a memory -reference that covers at least one byte of a watched area and the memory -reference is as specified in -.Sy pr_wflags . -When an lwp triggers a watchpoint, it incurs a watchpoint trap. -If -.Sy FLTWATCH -is being traced, the lwp stops; otherwise, it is sent a -.Sy SIGTRAP -signal; if -.Sy SIGTRAP -is being traced and is not blocked, the lwp stops. -.Pp -The watchpoint trap occurs before the instruction completes unless -.Sy WA_TRAPAFTER -was specified, in which case it occurs after the instruction completes. -If it occurs before completion, the memory is not modified. -If it occurs after completion, the memory is modified (if the access is a write -access). -.Pp -Physical i/o is an exception for watchpoint traps. -In this instance, there is no guarantee that memory before the watched area -has already been modified (or in the case of -.Sy WA_TRAPAFTER , -that the memory following the watched area -has not been modified) when the watchpoint trap occurs and the lwp stops. -.Pp -.Sy pr_info -in the -.Vt lwpstatus -structure contains information pertinent to the watchpoint trap. -In particular, the -.Sy si_addr -field contains the -virtual address of the memory reference that triggered the watchpoint, and the -.Sy si_code -field contains one of -.Sy TRAP_RWATCH , -.Sy TRAP_WWATCH , -or -.Sy TRAP_XWATCH , -indicating read, write, or execute access, respectively. -The -.Sy si_trapafter -field is zero unless -.Sy WA_TRAPAFTER -is in effect for this watched area; non-zero indicates that the current -instruction is not the instruction that incurred the watchpoint trap. -The -.Sy si_pc -field contains the virtual address of the instruction that incurred the trap. -.Pp -A watchpoint trap may be triggered while executing a system call that makes -reference to the traced process's memory. -The lwp that is executing the system call incurs the watchpoint trap while -still in the system call. -If it stops as a result, the -.Vt lwpstatus -structure contains the system call number and its arguments. -If the lwp does not stop, or if it is set running again without -clearing the signal or fault, the system call fails with -.Er EFAULT . -If -.Sy WA_TRAPAFTER -was specified, the memory reference will have completed and -the memory will have been modified (if the access was a write access) when the -watchpoint trap occurs. -.Pp -If more than one of -.Sy WA_READ , -.Sy WA_WRITE , -and -.Sy WA_EXEC -is specified for a watched area, and a single instruction incurs more than one -of the specified types, only one is reported when the watchpoint trap occurs. -The precedence is -.Sy WA_EXEC , -.Sy WA_READ , -.Sy WA_WRITE -.Pf ( Sy WA_EXEC -and -.Sy WA_READ -take precedence over -.Sy WA_WRITE ) , -unless -.Sy WA_TRAPAFTER -was specified, in which case it is -.Sy WA_WRITE , -.Sy WA_READ , -.Sy WA_EXEC -.Pf ( Sy WA_WRITE -takes precedence). -.Pp -.Sy PCWATCH -fails with -.Er EINVAL -if an attempt is made to specify overlapping watched areas or if -.Sy pr_wflags -contains flags other than those specified above. -It fails with -.Er ENOMEM -if an attempt is made to establish more watched areas than the system can -support (the system can support thousands). -.Pp -The child of a -.Xr vfork 2 -borrows the parent's address space. -When a -.Xr vfork 2 -is executed by a traced process, all watched areas established -for the parent are suspended until the child terminates or performs an -.Xr exec 2 . -Any watched areas established independently in the child are -cancelled when the parent resumes after the child's termination or -.Xr exec 2 . -.Sy PCWATCH -fails with -.Er EBUSY -if applied to the parent of a -.Xr vfork 2 -before the child has terminated or performed an -.Xr exec 2 . -The -.Sy PR_VFORKP -flag is set in the -.Sy pstatus -structure for such a parent process. -.Pp -Certain accesses of the traced process's address space by the operating system -are immune to watchpoints. -The initial construction of a signal stack frame when a signal is delivered to -an lwp will not trigger a watchpoint trap even if the new frame covers watched -areas of the stack. -Once the signal handler is entered, watchpoint traps occur normally. -On SPARC based machines, register window overflow and underflow will not -trigger watchpoint traps, even if the register window save areas cover watched -areas of the stack. -.Pp -Watched areas are not inherited by child processes, even if the traced -process's inherit-on-fork mode, -.Sy PR_FORK , -is set (see -.Sy PCSET , -below). -All watched areas are cancelled when the traced process performs a successful -.Xr exec 2 . -.Ss PCSET PCUNSET -.Sy PCSET -sets one or more modes of operation for the traced process. -.Sy PCUNSET -unsets these modes. -The modes to be set or unset are specified by flags in an operand -.Sy long -in the control message: -.Bl -tag -offset left -width "PR_MSFORK" -.It Sy PR_FORK -(inherit-on-fork): When set, the process's tracing flags and its -inherit-on-fork mode are inherited by the child of a -.Xr fork 2 , -.Xr fork1 2 , -or -.Xr vfork 2 . -When unset, child processes start with all tracing flags cleared. -.It Sy PR_RLC -(run-on-last-close): When set and the last writable -.Pa /proc -file descriptor referring to the traced process or any of its lwps is closed, -all of the process's tracing flags and watched areas are cleared, any -outstanding stop directives are canceled, and if any lwps are stopped on -events of interest, they are set running as though -.Sy PCRUN -had been applied to them. -When unset, the process's tracing flags and watched areas are retained and -lwps are not set running on last close. -.It Sy PR_KLC -(kill-on-last-close): When set and the last writable -.Pa /proc -file descriptor referring to the traced process or any of its lwps is closed, -the process is terminated with -.Sy SIGKILL . -.It Sy PR_ASYNC -(asynchronous-stop): When set, a stop on an event of interest by one lwp does -not directly affect any other lwp in the process. -When unset and an lwp stops on an event of interest other than -.Sy PR_REQUESTED , -all other lwps in the process are directed to stop. -.It Sy PR_MSACCT -(microstate accounting): Microstate accounting is now continuously enabled. -This flag is deprecated and no longer has any effect upon microstate -accounting. -Applications may toggle this flag; however, microstate accounting -will remain enabled regardless. -.It Sy PR_MSFORK -(inherit microstate accounting): All processes now inherit microstate -accounting, as it is continuously enabled. -This flag has been deprecated and its use no longer has any effect upon the -behavior of microstate accounting. -.It Sy PR_BPTADJ -(breakpoint trap pc adjustment): On x86-based machines, a breakpoint trap -leaves the program counter (the -.Sy EIP ) -referring to the breakpointed instruction plus one byte. -When -.Sy PR_BPTADJ -is set, the system will adjust the program counter back to the location of the -breakpointed instruction when the lwp stops on a breakpoint. -This flag has no effect on SPARC based machines, where breakpoint traps leave -the program counter referring to the breakpointed instruction. -.It Sy PR_PTRACE -(ptrace-compatibility): When set, a stop on an event of interest by the traced -process is reported to the parent of the traced process by -.Xr wait 3C , -.Sy SIGTRAP -is sent to the traced process when it executes a successful -.Xr exec 2 , -setuid/setgid flags are not honored for execs performed by the -traced process, any exec of an object file that the traced process cannot read -fails, and the process dies when its parent dies. -This mode is deprecated; it is provided only to allow -.Xr ptrace 3C -to be implemented as a library function using -.Pa /proc . -.El -.Pp -It is an error -.Pq Er EINVAL -to specify flags other than those described above -or to apply these operations to a system process. -The current modes are reported in the -.Sy pr_flags -field of -.Pa /proc/ Ns Em pid Ns Pa /status -and -.Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwp Ns Pa /lwpstatus . -.Ss PCSREG -Set the general registers for the specific or representative lwp according to -the operand -.Vt prgregset_t -structure. -.Pp -On SPARC based systems, only the condition-code bits of the processor-status -register (R_PSR) of SPARC V8 (32-bit) processes can be modified by -.Sy PCSREG . -Other privileged registers cannot be modified at all. -.Pp -On x86-based systems, only certain bits of the flags register (EFL) can be -modified by -.Sy PCSREG : -these include the condition codes, direction-bit, and overflow-bit. -.Pp -.Sy PCSREG -fails with -.Er EBUSY -if the lwp is not stopped on an event of interest. -.Ss PCSVADDR -Set the address at which execution will resume for the specific or -representative lwp from the operand -.Vt long . -On SPARC based systems, both %pc and %npc are set, with %npc set to the -instruction following the virtual address. -On x86-based systems, only %eip is set. -.Sy PCSVADDR -fails with -.Er EBUSY -if the lwp is not stopped on an event of interest. -.Ss PCSFPREG -Set the floating-point registers for the specific or representative lwp -according to the operand -.Vt prfpregset_t -structure. -An error -.Pq Er EINVAL -is returned if the system does not support floating-point operations (no -floating-point hardware and the system does not emulate floating-point machine -instructions). -.Sy PCSFPREG -fails with -.Er EBUSY -if the lwp is not stopped on an event of interest. -.Ss PCSXREG -Set the extra state registers for the specific or representative lwp according -to the architecture-dependent operand -.Vt prxregset_t -structure. -An error -.Pq Er EINVAL -is returned if the system does not support extra state registers. -.Sy PCSXREG -fails with -.Er EBUSY -if the lwp is not stopped on an event of interest. -.Ss PCSASRS -Set the ancillary state registers for the specific or representative lwp -according to the SPARC V9 platform-dependent operand -.Vt asrset_t -structure. -An error -.Pq Er EINVAL -is returned if either the target process or the -controlling process is not a 64-bit SPARC V9 process. -Most of the ancillary state registers are privileged registers that cannot be -modified. -Only those that can be modified are set; all others are silently ignored. -.Sy PCSASRS -fails with -.Er EBUSY -if the lwp is not stopped on an event of interest. -.Ss PCAGENT -Create an agent lwp in the controlled process with register values from the -operand -.Vt prgregset_t -structure (see -.Sy PCSREG , -above). -The agent lwp is created in the stopped state showing -.Sy PR_REQUESTED -and with its held signal set (the signal mask) having all signals except -.Sy SIGKILL -and -.Sy SIGSTOP -blocked. -.Pp -The -.Sy PCAGENT -operation fails with -.Er EBUSY -unless the process is fully stopped via -.Pa /proc , -that is, unless all of the lwps in the process are -stopped either on events of interest or on -.Sy PR_SUSPENDED , -or are stopped on -.Sy PR_JOBCONTROL -and have been directed to stop via -.Sy PCDSTOP . -It fails with -.Er EBUSY -if an agent lwp already exists. -It fails with -.Er ENOMEM -if system resources for creating new lwps have been exhausted. -.Pp -Any -.Sy PCRUN -operation applied to the process control file or to the control -file of an lwp other than the agent lwp fails with -.Er EBUSY -as long as the agent lwp exists. -The agent lwp must be caused to terminate by executing the -.Sy SYS_lwp_exit -system call trap before the process can be restarted. -.Pp -Once the agent lwp is created, its lwp-ID can be found by reading the process -status file. -To facilitate opening the agent lwp's control and status files, -the directory name -.Pa /proc/ Ns Em pid Ns Pa /lwp/agent -is accepted for lookup operations as an invisible alias for -.Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid , -.Em lwpid -being the lwp-ID of the agent lwp (invisible in the sense that the name -.Dq agent -does not appear in a directory listing of -.Pa /proc/ Ns Em pid Ns Pa /lwp -obtained from -.Xr ls 1 , -.Xr getdents 2 , -or -.Xr readdir 3C . -.Pp -The purpose of the agent lwp is to perform operations in the controlled process -on behalf of the controlling process: to gather information not directly -available via -.Pa /proc -files, or in general to make the process change state -in ways not directly available via -.Pa /proc -control operations. -To make use of an agent lwp, the controlling process must be capable of making -it execute system calls (specifically, the -.Sy SYS_lwp_exit -system call trap). -The register values given to the agent lwp on creation are typically the -registers of the representative lwp, so that the agent lwp can use its stack. -.Pp -If the controlling process neglects to force the agent lwp to execute the -.Sy SYS_lwp_exit -system call (due to either logic error or fatal failure on -the part of the controlling process), the agent lwp will remain in the target -process. -For purposes of being able to debug these otherwise rogue agents, -information as to the creator of the agent lwp is reflected in that lwp's -.Pa spymaster -file in -.Pa /proc . -Should the target process generate a core -dump with the agent lwp in place, this information will be available via the -.Sy NT_SPYMASTER -note in the core file (see -.Xr core 4 ) . -.Pp -The agent lwp is not allowed to execute any variation of the -.Sy SYS_fork -or -.Sy SYS_exec -system call traps. -Attempts to do so yield -.Er ENOTSUP -to the agent lwp. -.Pp -Symbolic constants for system call trap numbers like -.Sy SYS_lwp_exit -and -.Sy SYS_lwp_create -can be found in the header file -.In sys/syscall.h . -.Ss PCREAD PCWRITE -Read or write the target process's address space via a -.Vt priovec -structure operand: -.Bd -literal -offset 2 -typedef struct priovec { - void *pio_base; /* buffer in controlling process */ - size_t pio_len; /* size of read/write request in bytes */ - off_t pio_offset; /* virtual address in target process */ -} priovec_t; -.Ed -.Pp -These operations have the same effect as -.Xr pread 2 -and -.Xr pwrite 2 , -respectively, of the target process's address space file. -The difference is that more than one -.Sy PCREAD -or -.Sy PCWRITE -control operation can be -written to the control file at once, and they can be interspersed with other -control operations in a single write to the control file. -This is useful, for example, when planting many breakpoint instructions in -the process's address space, or when stepping over a breakpointed instruction. -Unlike -.Xr pread 2 -and -.Xr pwrite 2 , -no provision is made for partial reads or writes; if the -operation cannot be performed completely, it fails with -.Er EIO . -.Ss PCNICE -The traced process's -.Xr nice 2 -value is incremented by the amount in the -operand -.Vt long . -Only a process with the -.Brq Sy PRIV_PROC_PRIOCNTL -privilege asserted in its effective set can better a process's priority in this -way, but any user may lower the priority. -This operation is not meaningful for all scheduling classes. -.Ss PCSCRED -Set the target process credentials to the values contained in the -.Vt prcred_t -structure operand (see -.Pa /proc/ Ns Em pid Ns Pa /cred ) . -The -effective, real, and saved user-IDs and group-IDs of the target process are -set. -The target process's supplementary groups are not changed; the -.Sy pr_ngroups -and -.Sy pr_groups -members of the structure operand are ignored. -Only the privileged processes can perform this operation; for all -others it fails with -.Er EPERM . -.Ss PCSCREDX -Operates like -.Sy PCSCRED -but also sets the supplementary groups; the length -of the data written with this control operation should be "sizeof -.Pq Vt prcred_t -+ sizeof -.Pq Vt gid_t -* (#groups - 1)". -.Ss PCSPRIV -Set the target process privilege to the values contained in the -.Vt prpriv_t -operand (see -.Pa /proc/pid/priv ) . -The effective, permitted, inheritable, and -limit sets are all changed. -Privilege flags can also be set. -The process is made privilege aware unless it can relinquish privilege awareness. -See -.Xr privileges 5 . -.Pp -The limit set of the target process cannot be grown. -The other privilege sets must be subsets of the intersection of the effective set -of the calling process with the new limit set of the target process or subsets of -the original values of the sets in the target process. -.Pp -If any of the above restrictions are not met, -.Er EPERM -is returned. -If the structure written is improperly formatted, -.Er EINVAL -is returned. -.Sh PROGRAMMING NOTES -For security reasons, except for the -.Sy psinfo , -.Sy usage , -.Sy lpsinfo , -.Sy lusage , -.Sy lwpsinfo , -and -.Sy lwpusage -files, which are world-readable, and except for privileged processes, an open -of a -.Pa /proc -file fails unless both the user-ID and group-ID of the caller match those of -the traced process and the process's object file is readable by the caller. -The effective set of the caller is a superset of both the inheritable and the -permitted set of the target process. -The limit set of the caller is a superset of the limit set of the target -process. -Except for the world-readable files just mentioned, files corresponding to -setuid and setgid processes can be opened only by the appropriately privileged -process. -.Pp -A process that is missing the basic privilege -.Brq Sy PRIV_PROC_INFO -cannot see any processes under -.Pa /proc -that it cannot send a signal to. -.Pp -A process that has -.Brq Sy PRIV_PROC_OWNER -asserted in its effective set can open any file for reading. -To manipulate or control a process, the controlling process must have at least -as many privileges in its effective set as the target process has in its -effective, inheritable, and permitted sets. -The limit set of the controlling process must be a superset of the limit set -of the target process. -Additional restrictions apply if any of the uids of the target process are 0. -See -.Xr privileges 5 . -.Pp -Even if held by a privileged process, an open process or lwp file descriptor -(other than file descriptors for the world-readable files) becomes invalid if -the traced process performs an -.Xr exec 2 -of a setuid/setgid object file or -an object file that the traced process cannot read. -Any operation performed on an invalid file descriptor, except -.Xr close 2 , -fails with -.Er EAGAIN . -In this situation, if any tracing flags are set and the process or any lwp -file descriptor is open for writing, the process will have been directed to -stop and its run-on-last-close flag will have been set (see -.Sx PCSET ) . -This enables a controlling process (if it has permission) to reopen the -.Pa /proc -files to get new valid file descriptors, close the invalid file descriptors, -unset the run-on-last-close flag (if desired), and proceed. -Just closing the invalid file descriptors causes the traced process to resume -execution with all tracing flags cleared. -Any process not currently open for writing via -.Pa /proc , -but that has left-over tracing flags from a previous open, and that executes -a setuid/setgid or unreadable object file, will not be stopped but will have -all its tracing flags cleared. -.Pp -To wait for one or more of a set of processes or lwps to stop or terminate, -.Pa /proc -file descriptors (other than those obtained by opening the -.Pa cwd -or -.Pa root -directories or by opening files in the -.Pa fd -or -.Pa object -directories) can be used in a -.Xr poll 2 -system call. -When requested and returned, either of the polling events -.Sy POLLPRI -or -.Sy POLLWRNORM -indicates that the process or lwp stopped on an event of -interest. -Although they cannot be requested, the polling events -.Sy POLLHUP , -.Sy POLLERR , -and -.Sy POLLNVAL -may be returned. -.Sy POLLHUP -indicates that the process or lwp has terminated. -.Sy POLLERR -indicates that the file descriptor has become invalid. -.Sy POLLNVAL -is returned immediately if -.Sy POLLPRI -or -.Sy POLLWRNORM -is requested on a file descriptor referring to a system process (see -.Sx PCSTOP ) . -The requested events may be empty to wait simply for termination. -.Sh FILES -.Bl -tag -compact -width Ds -.It Pa /proc -directory (list of processes) -.It Pa /proc/ Ns Em pid -specific process directory -.It Pa /proc/self -alias for a process's own directory -.It Pa /proc/ Ns Em pid Ns Pa /as -address space file -.It Pa /proc/ Ns Em pid Ns Pa /ctl -process control file -.It Pa /proc/ Ns Em pid Ns Pa /status -process status -.It Pa /proc/ Ns Em pid Ns Pa /lstatus -array of lwp status structs -.It Pa /proc/ Ns Em pid Ns Pa /psinfo -process -.Xr ps 1 -info -.It Pa /proc/ Ns Em pid Ns Pa /lpsinfo -array of lwp -.Xr ps 1 -info structs -.It Pa /proc/ Ns Em pid Ns Pa /map -address space map -.It Pa /proc/ Ns Em pid Ns Pa /xmap -extended address space map -.It Pa /proc/ Ns Em pid Ns Pa /rmap -reserved address map -.It Pa /proc/ Ns Em pid Ns Pa /cred -process credentials -.It Pa /proc/ Ns Em pid Ns Pa /priv -process privileges -.It Pa /proc/ Ns Em pid Ns Pa /sigact -process signal actions -.It Pa /proc/ Ns Em pid Ns Pa /auxv -process aux vector -.It Pa /proc/ Ns Em pid Ns Pa /argv -process argument vector -.It Pa /proc/ Ns Em pid Ns Pa /ldt -process -.Sy LDT -(x86 only) -.It Pa /proc/ Ns Em pid Ns Pa /usage -process usage -.It Pa /proc/ Ns Em pid Ns Pa /lusage -array of lwp usage structs -.It Pa /proc/ Ns Em pid Ns Pa /path -symbolic links to process open files -.It Pa /proc/ Ns Em pid Ns Pa /pagedata -process page data -.It Pa /proc/ Ns Em pid Ns Pa /watch -active watchpoints -.It Pa /proc/ Ns Em pid Ns Pa /cwd -alias for the current working directory -.It Pa /proc/ Ns Em pid Ns Pa /root -alias for the root directory -.It Pa /proc/ Ns Em pid Ns Pa /fd -directory (list of open files) -.It Pa /proc/ Ns Em pid Ns Pa /fd/* -aliases for process's open files -.It Pa /proc/ Ns Em pid Ns Pa /object -directory (list of mapped files) -.It Pa /proc/ Ns Em pid Ns Pa /object/a.out -alias for process's executable file -.It Pa /proc/ Ns Em pid Ns Pa /object/* -aliases for other mapped files -.It Pa /proc/ Ns Em pid Ns Pa /lwp -directory (list of lwps) -.It Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid -specific lwp directory -.It Pa /proc/ Ns Em pid Ns Pa /lwp/agent -alias for the agent lwp directory -.It Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /lwpctl -lwp control file -.It Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /lwpstatus -lwp status -.It Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /lwpsinfo -lwp -.Xr ps 1 -info -.It Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /lwpusage -lwp usage -.It Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /gwindows -register windows (SPARC only) -.It Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /xregs -extra state registers -.It Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /asrs -ancillary state registers (SPARC V9 only) -.It Pa /proc/ Ns Em pid Ns Pa /lwp/ Ns Em lwpid Ns Pa /spymaster -For an agent LWP, the controlling process -.El -.Sh DIAGNOSTICS -Errors that can occur in addition to the errors normally associated with file -system access: -.Bl -tag -width "EOVERFLOW" -offset left -.It Er E2BIG -Data to be returned in a -.Xr read 2 -of the page data file exceeds the size of the read buffer provided by the -caller. -.It Er EACCES -An attempt was made to examine a process that ran under a different uid than -the controlling process and -.Brq Sy PRIV_PROC_OWNER -was not asserted in the effective set. -.It Er EAGAIN -The traced process has performed an -.Xr exec 2 -of a setuid/setgid object -file or of an object file that it cannot read; all further operations on the -process or lwp file descriptor (except -.Xr close 2 ) -elicit this error. -.It Er EBUSY -.Sy PCSTOP , -.Sy PCDSTOP , -.Sy PCWSTOP , or -.Sy PCTWSTOP -was applied to a system process; an exclusive -.Xr open 2 -was attempted on a -.Pa /proc -file for a process already open for writing; -.Sy PCRUN , -.Sy PCSREG , -.Sy PCSVADDR , -.Sy PCSFPREG , -or -.Sy PCSXREG -was applied to a process or -lwp not stopped on an event of interest; an attempt was made to mount -.Pa /proc -when it was already mounted; -.Sy PCAGENT -was applied to a process -that was not fully stopped or that already had an agent lwp. -.It Er EINVAL -In general, this means that some invalid argument was supplied to a system -call. -A non-exhaustive list of conditions eliciting this error includes: a -control message operation code is undefined; an out-of-range signal number was -specified with -.Sy PCSSIG , -.Sy PCKILL , -or -.Sy PCUNKILL ; -.Sy SIGKILL -was specified with -.Sy PCUNKILL ; -.Sy PCSFPREG -was applied on a system that does not support floating-point operations; -.Sy PCSXREG -was applied on a system that does not support extra state registers. -.It Er EINTR -A signal was received by the controlling process while waiting for the traced -process or lwp to stop via -.Sy PCSTOP , -.Sy PCWSTOP , -or -.Sy PCTWSTOP . -.It Er EIO -A -.Xr write 2 -was attempted at an illegal address in the traced process. -.It Er ENOENT -The traced process or lwp has terminated after being opened. -The basic privilege -.Brq Sy PRIV_PROC_INFO -is not asserted in the effective set of the calling process and the calling -process cannot send a signal to the target process. -.It Er ENOMEM -The system-imposed limit on the number of page data file descriptors was -reached on an open of -.Pa /proc/ Ns Em pid Ns Pa /pagedata ; -an attempt was made -with -.Sy PCWATCH -to establish more watched areas than the system can support; -the -.Sy PCAGENT -operation was issued when the system was out of resources for -creating lwps. -.It Er ENOSYS -An attempt was made to perform an unsupported operation (such as -.Xr creat 2 , -.Xr link 2 , -or -.Xr unlink 2 ) -on an entry in -.Pa /proc . -.It Er EOVERFLOW -A 32-bit controlling process attempted to read or write the -.Pa as -file or attempted to read the -.Pa map , -.Pa rmap , -or -.Pa pagedata -file of a 64-bit target process. -A 32-bit controlling process attempted to apply one of the -control operations -.Sy PCSREG , -.Sy PCSXREG , -.Sy PCSVADDR , -.Sy PCWATCH , -.Sy PCAGENT , -.Sy PCREAD , -.Sy PCWRITE -to a 64-bit target process. -.It Er EPERM -The process that issued the -.Sy PCSCRED -or -.Sy PCSCREDX -operation did not have the -.Brq Sy PRIV_PROC_SETID -privilege asserted in its effective set, or -the process that issued the -.Sy PCNICE -operation did not have the -.Brq Sy PRIV_PROC_PRIOCNTL -in its effective set. -.Pp -An attempt was made to control a process of which the E, P, and I privilege -sets were not a subset of the effective set of the controlling process or the -limit set of the controlling process is not a superset of limit set of the -controlled process. -.Pp -Any of the uids of the target process are -.Sy 0 -or an attempt was made to change any of the uids to -.Sy 0 -using -.Sy PCSCRED -and the security policy imposed additional restrictions. -See -.Xr privileges 5 . -.El -.Sh SEE ALSO -.Xr ls 1 , -.Xr ps 1 , -.Xr chroot 1M , -.Xr alarm 2 , -.Xr brk 2 , -.Xr chdir 2 , -.Xr chroot 2 , -.Xr close 2 , -.Xr creat 2 , -.Xr dup 2 , -.Xr exec 2 , -.Xr fcntl 2 , -.Xr fork 2 , -.Xr fork1 2 , -.Xr fstat 2 , -.Xr getdents 2 , -.Xr getustack 2 , -.Xr kill 2 , -.Xr lseek 2 , -.Xr mmap 2 , -.Xr nice 2 , -.Xr open 2 , -.Xr poll 2 , -.Xr pread 2 , -.Xr pwrite 2 , -.Xr read 2 , -.Xr readlink 2 , -.Xr readv 2 , -.Xr shmget 2 , -.Xr sigaction 2 , -.Xr sigaltstack 2 , -.Xr vfork 2 , -.Xr write 2 , -.Xr writev 2 , -.Xr _stack_grow 3C , -.Xr pthread_create 3C , -.Xr pthread_join 3C , -.Xr ptrace 3C , -.Xr readdir 3C , -.Xr thr_create 3C , -.Xr thr_join 3C , -.Xr wait 3C , -.Xr siginfo.h 3HEAD , -.Xr signal.h 3HEAD , -.Xr types32.h 3HEAD , -.Xr ucontext.h 3HEAD , -.Xr contract 4 , -.Xr core 4 , -.Xr process 4 , -.Xr lfcompile 5 , -.Xr privileges 5 , -.Xr security-flags 5 -.Sh NOTES -Descriptions of structures in this document include only interesting structure -elements, not filler and padding fields, and may show elements out of order for -descriptive clarity. -The actual structure definitions are contained in -.In procfs.h . -.Sh BUGS -Because the old -.Xr ioctl 2 Ns -based -version of -.Pa /proc -is currently supported for binary compatibility with old applications, the -top-level directory for a process, -.Pa /proc/ Ns Em pid , -is not world-readable, but it is world-searchable. -Thus, anyone can open -.Pa /proc/ Ns Em pid Ns Pa /psinfo -even though -.Xr ls 1 -applied to -.Pa /proc/ Ns Em pid -will fail for anyone but the owner or an appropriately privileged process. -Support for the old -.Xr ioctl 2 Ns -based -version of -.Pa /proc -will be dropped in a future release, at which time the top-level directory for -a process will be made world-readable. -.Pp -On SPARC based machines, the types -.Sy gregset_t -and -.Sy fpregset_t -defined in -.In sys/regset.h -are similar to but not the same as the types -.Sy prgregset_t -and -.Sy prfpregset_t -defined in -.In procfs.h . diff --git a/usr/src/man/man4/process.4 b/usr/src/man/man4/process.4 deleted file mode 100644 index 4a61edb777..0000000000 --- a/usr/src/man/man4/process.4 +++ /dev/null @@ -1,565 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2016, Joyent, Inc. -.\" 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 PROCESS 4 "December 28, 2020" -.SH NAME -process \- process contract type -.SH SYNOPSIS -.nf -\fB/system/contract/process\fR -.fi - -.SH DESCRIPTION -Process contracts allow processes to create a fault boundary around a set of -subprocesses and observe events which occur within that boundary. -.sp -.LP -Process contracts are managed using the \fBcontract\fR(4) file system and the -\fBlibcontract\fR(3LIB) library. The process contract type directory is -\fB/system/contract/process\fR. -.SS "CREATION" -A process contract is created when an LWP that has an active process contract -template calls \fBfork\fR(2). Initially, the child process created by -\fBfork()\fR is the only resource managed by the contract. When an LWP that -does not have an active process contract template calls \fBfork()\fR, the child -process created by \fBfork()\fR is added as a resource to the process contract -of which the parent was a member. -.SS "EVENT TYPES" -The following events types are defined: -.sp -.ne 2 -.na -\fB\fBCT_PR_EV_EMPTY\fR\fR -.ad -.sp .6 -.RS 4n -The last member of the process contract exited. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_PR_EV_FORK\fR\fR -.ad -.sp .6 -.RS 4n -A new process has been added to the process contract. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_PR_EV_EXIT\fR\fR -.ad -.sp .6 -.RS 4n -A member of the process contract exited. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_PR_EV_CORE\fR\fR -.ad -.sp .6 -.RS 4n -A process failed and dumped core. This could also occur if the process would -have dumped core had appropriate \fBcoreadm\fR(1M) options been enabled and -core file size was unlimited. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_PR_EV_SIGNAL\fR\fR -.ad -.sp .6 -.RS 4n -A process received a fatal signal from a process, other than the owner of the -process contract, that is a member of a different process contract. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_PR_EV_HWERR\fR\fR -.ad -.sp .6 -.RS 4n -A process was killed because of an uncorrectable hardware error. -.RE - -.SS "TERMS" -The following common contract terms, defined in \fBcontract\fR(4), have -process-contract specific attributes: -.sp -.ne 2 -.na -\fBcritical event set\fR -.ad -.sp .6 -.RS 4n -The default value for the critical event set is \fB(CT_PR_EV_EMPTY | -CT_PR_EV_HWERR)\fR. -.sp -An attempt by a user without the \fB{PRIV_CONTRACT_EVENT}\fR privilege in its -effective set to add an event, other than \fBCT_PR_EV_EMPTY\fR, to the critical -event set which is not present in the fatal set, or if the \fBCT_PR_PGONLY\fR -parameter is set and the same user attempts to add any event, other than -\fBCT_PR_EV_EMPTY\fR, to the critical event set, fails. -.RE - -.sp -.ne 2 -.na -\fBinformative event set\fR -.ad -.sp .6 -.RS 4n -The default value for the informative event set is \fB(CT_PR_EV_CORE | -CT_PR_EV_SIGNAL)\fR. -.RE - -.sp -.LP -The following contract terms can be read from or written to a process contract -template using the named \fBlibcontract\fR(3LIB) interfaces. These contract -terms are in addition to those described in \fBcontract\fR(4). -.sp -.ne 2 -.na -\fBcreator's aux\fR -.ad -.sp .6 -.RS 4n -Auxiliary contract description. The purpose of this field is to provide the -contract creator with a way to differentiate process contracts it creates under -the same service FMRI. Use ct_pr_tmpl_set_svc_aux(3CONTRACT) to set this term. -The default value is an empty string. The contents of this field should be -limited to 7-bit ASCII values. -.RE - -.sp -.ne 2 -.na -\fBfatal event set\fR -.ad -.sp .6 -.RS 4n -Defines a set of events which, when generated, causes all members of the -process contract to be killed with \fBSIGKILL\fR, or the intersection of the -contract and the containing process group if the \fBCT_PR_PGRPONLY\fR parameter -is set. Set this term with \fBct_pr_tmpl_set_fatal\fR(3CONTRACT). The fatal -event set is restricted to \fBCT_PR_EV_CORE\fR, \fBCT_PR_EV_SIGNAL\fR, and -\fBCT_PR_EV_HWERR\fR. For \fBCT_PR_EV_CORE\fR and \fBCT_PR_EV_SIGNAL\fR events, -the scope of \fBSIGKILL\fR is limited to those processes which the contract -author or the event source could have normally sent signals to. -.sp -The default value for the fatal event set is \fBCT_PR_EV_HWERR\fR. -.sp -If a user without the \fB{PRIV_CONTRACT_EVENT}\fR privilege in its effective -set removes an event from the fatal event set which is present in the critical -event set, the corresponding event is automatically removed from the critical -event set and added to the informative event set. -.RE - -.sp -.ne 2 -.na -\fBparameter set\fR -.ad -.sp .6 -.RS 4n -Defines miscellaneous other settings. Use \fBct_pr_tmpl_set_param\fR(3CONTRACT) -to set this term. -.sp -The default parameter set is empty. -.sp -The value is a bit vector comprised of some or all of: -.sp -.ne 2 -.na -\fB\fBCT_PR_INHERIT\fR\fR -.ad -.sp .6 -.RS 4n -If set, indicates that the process contract is to be inherited by the process -contract the contract owner is a member of if the contract owner exits before -explicitly abandoning the process contract. -.sp -If not set, the process contract is automatically abandoned when the owner -exits. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_PR_KEEP_EXEC\fR\fR -.ad -.sp .6 -.RS 4n -If set, the process contract template remains active across \fBexec\fR(2). -This can be used to setup a contract for children of an application which -is not contract-aware. If this is not set then the system clears the active -template when the process execs. Because this option is intended for an -application which is not contract-aware, new child process contracts will be -automatically abandoned by the parent. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_PR_NOORPHAN\fR\fR -.ad -.sp .6 -.RS 4n -If set, all processes in a process contract are sent \fBSIGKILL\fR if the -process contract is abandoned, either explicitly or because the holder died and -\fBCT_PR_INHERIT\fR was not set. The scope of \fBSIGKILL\fR is limited to those -processes which the contract author or the event source could have normally -sent signals to. -.sp -If this is not set and the process contract is abandoned, the process contract -is orphaned, that is, continues to exist without owner. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_PR_PGRPONLY\fR\fR -.ad -.sp .6 -.RS 4n -If set, only those processes within the same process group and process contract -as a fatal error-generating process are killed. -.sp -If not set, all processes within the process contract are killed if a member -process encounters an error specified in the fatal set. -.sp -If a user without the \fB{PRIV_CONTRACT_EVENT}\fR privilege in its effective -set adds \fBCT_PR_PGRPONLY\fR to a template's parameter set, any events other -than \fBCT_PR_EV_EMPTY\fR are automatically removed from the critical event set -and added to the informative event set. -.RE - -.sp -.ne 2 -.na -\fB\fBCT_PR_REGENT\fR\fR -.ad -.sp .6 -.RS 4n -If set, the process contract can inherit unabandoned contracts left by exiting -member processes. -.sp -If not set, indicates that the process contract should not inherit contracts -from member processes. If a process exits before abandoning a contract it owns -and is a member of a process contract which does not have \fBCT_PR_REGENT\fR -set, the system automatically abandons the contract. -.sp -If a regent process contract has inherited contracts and is abandoned by its -owner, its inherited contracts are abandoned. -.RE - -.RE - -.sp -.ne 2 -.na -\fBservice FMRI\fR -.ad -.sp .6 -.RS 4n -Specifies the service FMRI associated with the process contract. Use -\fBct_pr_tmpl_set_svc_fmri\fR(3CONTRACT) to set this term. The default is to -inherit the value from the creator's process contract. When this term is -uninitialized, \fBct_pr_tmpl_get_svc_fmri\fR(3CONTRACT) returns the token -string \fBinherited:\fR to indicate the value has not been set and is -inherited. Setting the service FMRI to \fBinherited\fR: clears the current -(\fBB\fR value and the \fBterm\fR is inherited from the creator's process -contract. To set this term a process must have \fB{PRIV_CONTRACT_IDENTITY}\fR -in its effective set. -.RE - -.sp -.ne 2 -.na -\fBtransfer contract\fR -.ad -.sp .6 -.RS 4n -Specifies the ID of an empty process contract held by the caller whose -inherited process contracts are to be transferred to the newly created -contract. Use \fBct_pr_tmpl_set_transfer\fR(3CONTRACT) to set the transfer -contract. Attempts to specify a contract not held by the calling process, or a -contract which still has processes in it, fail. -.sp -The default transfer term is \fB0\fR, that is, no contract. -.RE - -.SS "STATUS" -In addition to the standard items, the status object read from a status file -descriptor contains the following items to obtain this information -respectively: -.sp -.ne 2 -.na -\fBservice contract ID\fR -.ad -.sp .6 -.RS 4n -Specifies the process contract id which defined the service FMRI term. Use -\fBct_pr_status_get_svc_ctid\fR(3CONTRACT) to read the term's value. It can be -used to determine if the service FMRI was inherited as in the example below. -.sp -.in +2 -.nf -ctid_t ctid; /* our contract id */ -int fd; /* fd of ctid's status file */ - -ct_stathdl_(Bt status; -ctid_t svc_ctid; - -if (ct_status_read(fd, CTD_FIXED, &status) == 0) { - if (ct_pr_status_get_svc_ctid(status, &svc_ctid) == 0) { - if (svc_ctid == ctid) - /* not inherited */ - else - /* inherited */ - } - ct_status_free(status); -} -.fi -.in -2 -.sp - -.RE - -.sp -.LP -If \fBCTD_ALL\fR is specified, the following items are also available: -.sp -.ne 2 -.na -\fBMember list\fR -.ad -.sp .6 -.RS 4n -The PIDs of processes which are members of the process contract. Use -\fBct_pr_status_get_members\fR(3CONTRACT) for this information. -.RE - -.sp -.ne 2 -.na -\fBInherited contract list\fR -.ad -.sp .6 -.RS 4n -The IDs of contracts which have been inherited by the process contract. Use -\fBct_pr_status_get_contracts\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBService FMRI (term)\fR -.ad -.sp .6 -.RS 4n -Values equal to the terms used when the contract was written. The Service FMRI -term of the process contract of a process en(\fBBtering\fR a zone has the -value \fBsvc:/system/zone_enter:default\fR when read from the non-global zone. -.RE - -.sp -.ne 2 -.na -\fBcontract creator\fR -.ad -.sp .6 -.RS 4n -Specifies the process that created the process contract. Use -\fBct_pr_status_get_svc_creator\fR(3CONTRACT) to read the term's value. -.RE - -.sp -.ne 2 -.na -\fBcreator's aux (term)\fR -.ad -.sp .6 -.RS 4n -Values equal to the terms used when the contract was written. -.RE - -.sp -.LP -The following standard status items have different meanings in some situations: -.sp -.ne 2 -.na -\fBOwnership state\fR -.ad -.sp .6 -.RS 4n -If the process contract has a state of \fBCTS_OWNED\fR or \fBCTS_INHERITED\fR -and is held by an entity in the global zone, but contains processes in a -non-global zone, it appears to have the state \fBCTS_OWNED\fR when observed by -processes in the non-global zone. -.RE - -.sp -.ne 2 -.na -\fBContract holder\fR -.ad -.sp .6 -.RS 4n -If the process contract has a state of \fBCTS_OWNED\fR or \fBCTS_INHERITED\fR -and is held by an entity in the global zone, but contains processes in a -non-global zone, it appears to be held by the non-global zone's \fBzsched\fR -when observed by processes in the non-global zone. -.RE - -.SS "EVENTS" -In addition to the standard items, an event generated by a process contract -contains the following information: -.sp -.ne 2 -.na -\fBGenerating PID\fR -.ad -.sp .6 -.RS 4n -The process ID of the member process which experienced the event, or caused the -contract event to be generated (in the case of \fBCT_PR_EV_EMPTY\fR). Use -\fBct_pr_event_get_pid\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.LP -If the event type is \fBCT_PR_EV_FORK\fR, the event contains: -.sp -.ne 2 -.na -\fBParent PID\fR -.ad -.sp .6 -.RS 4n -The process ID which forked [Generating PID]. Use -\fBct_pr_event_get_ppid\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.LP -If the event type is \fBCT_PR_EV_EXIT\fR, the event contains: -.sp -.ne 2 -.na -\fBExit status\fR -.ad -.sp .6 -.RS 4n -The exit status of the process. Use \fBct_pr_event_get_exitstatus\fR(3CONTRACT) -to obtain this information. -.RE - -.sp -.LP -If the event type is \fBCT_PR_EV_CORE\fR, the event can contain: -.sp -.ne 2 -.na -\fBProcess core name\fR -.ad -.sp .6 -.RS 4n -The name of the per-process core file. Use -\fBct_pr_event_get_pcorefile\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBGlobal core name\fR -.ad -.sp .6 -.RS 4n -The name of the process's zone's global core file. Use -\fBct_pr_event_get_gcorefile\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.ne 2 -.na -\fBZone core name\fR -.ad -.sp .6 -.RS 4n -The name of the system-wide core file in the global zone. Use -\fBct_pr_event_get_zcorefile\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.LP -See \fBcoreadm\fR(1M) for more information about per-process, global, and -system-wide core files. -.sp -.LP -If the event type is \fBCT_PR_EV_SIGNAL\fR, the event contains: -.sp -.ne 2 -.na -\fBSignal\fR -.ad -.sp .6 -.RS 4n -The number of the signal which killed the process. Use -\fBct_pr_event_get_signal\fR(3CONTRACT) to obtain this information. -.RE - -.sp -.LP -It can contain: -.sp -.ne 2 -.na -\fBsender\fR -.ad -.sp .6 -.RS 4n -The PID of the process which sent the signal. Use -\fBct_pr_event_get_sender\fR(3CONTRACT) to obtain this information. -.RE - -.SH FILES -.ne 2 -.na -\fB\fB/usr/include/sys/contract/process.h\fR\fR -.ad -.sp .6 -.RS 4n -Contains definitions of event-type macros. -.RE - -.SH SEE ALSO -\fBctrun\fR(1), \fBctstat\fR(1), \fBctwatch\fR(1), \fBcoreadm\fR(1M), -\fBclose\fR(2), \fBfork\fR(2), \fBioctl\fR(2), \fBopen\fR(2), \fBpoll\fR(2), -\fBct_pr_event_get_exitstatus\fR(3CONTRACT), -\fBct_pr_event_get_gcorefile\fR(3CONTRACT), -\fBct_pr_event_get_pcorefile\fR(3CONTRACT), -\fBct_pr_event_get_pid\fR(3CONTRACT), \fBct_pr_event_get_ppid\fR(3CONTRACT), -\fBct_pr_event_get_signal\fR(3CONTRACT), -\fBct_pr_event_get_zcorefile\fR(3CONTRACT), -\fBct_pr_status_get_contracts\fR(3CONTRACT), -\fBct_pr_status_get_members\fR(3CONTRACT), -\fBct_pr_status_get_param\fR(3CONTRACT), \fBct_pr_tmpl_set_fatal\fR(3CONTRACT), -\fBct_pr_tmpl_set_param\fR(3CONTRACT), -\fBct_pr_tmpl_set_transfer\fR(3CONTRACT), \fBct_tmpl_set_cookie\fR(3CONTRACT), -\fBct_tmpl_set_critical\fR(3CONTRACT), -\fBct_tmpl_set_informative\fR(3CONTRACT), \fBlibcontract\fR(3LIB), -\fBcontract\fR(4), \fBprivileges\fR(5) diff --git a/usr/src/man/man4/prof_attr.4 b/usr/src/man/man4/prof_attr.4 deleted file mode 100644 index 41bf4622b5..0000000000 --- a/usr/src/man/man4/prof_attr.4 +++ /dev/null @@ -1,169 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All rights reserved -.\" 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 PROF_ATTR 4 "Feb 25, 2017" -.SH NAME -prof_attr \- profile description database -.SH SYNOPSIS -.LP -.nf -\fB/etc/security/prof_attr\fR -.fi - -.SH DESCRIPTION -.LP -\fB/etc/security/prof_attr\fR is a local source for execution profile names, -descriptions, and other attributes of execution profiles. The \fBprof_attr\fR -file can be used with other profile sources, including the \fBprof_attr\fR -\fBNIS\fR map. Programs use the \fBgetprofattr\fR(3SECDB) -routines to gain access to this information. -.sp -.LP -The search order for multiple \fBprof_attr\fR sources is specified in the -\fB/etc/nsswitch.conf\fR file, as described in the \fBnsswitch.conf\fR(4) man -page. -.sp -.LP -An execution profile is a mechanism used to bundle together the commands and -authorizations needed to perform a specific function. An execution profile can -also contain other execution profiles. Each entry in the \fBprof_attr\fR -database consists of one line of text containing five fields separated by -colons (\fB:\fR). Line continuations using the backslash (\fB\e\fR) character -are permitted. The format of each entry is: -.sp -.LP -\fIprofname\fR:\fIres1\fR:\fIres2\fR:\fIdesc\fR:\fIattr\fR -.sp -.ne 2 -.na -\fB\fIprofname\fR\fR -.ad -.RS 12n -The name of the profile. Profile names are case-sensitive. -.RE - -.sp -.ne 2 -.na -\fB\fIres1\fR\fR -.ad -.RS 12n -Reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIres2\fR\fR -.ad -.RS 12n -Reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIdesc\fR\fR -.ad -.RS 12n -A long description. This field should explain the purpose of the profile, -including what type of user would be interested in using it. The long -description should be suitable for displaying in the help text of an -application. -.RE - -.sp -.ne 2 -.na -\fB\fIattr\fR\fR -.ad -.RS 12n -An optional list of semicolon-separated (\fB;\fR) key-value pairs that describe -the security attributes to apply to the object upon execution. Zero or more -keys can be specified. There are four valid keys: \fBhelp\fR, \fBprofiles\fR, -\fBauths\fR, and \fBprivs\fR. -.sp -\fBhelp\fR is assigned the name of a file ending in \fB\&.htm\fR or -\fB\&.html\fR. -.sp -\fBauths\fR specifies a comma-separated list of authorization names chosen from -those names defined in the \fBauth_attr\fR(4) database. Authorization names can -be specified using the asterisk (\fB*\fR) character as a wildcard. For example, -\fBsolaris.printer.*\fR would mean all of Sun's authorizations for printing. -.sp -\fBprofiles\fR specifies a comma-separated list of profile names chosen from -those names defined in the \fBprof_attr\fR database. -.sp -\fBprivs\fR specifies a comma-separated list of privileges names chosen from -those names defined in the \fBpriv_names\fR(4) database. These privileges can -then be used for executing commands with \fBpfexec\fR(1). -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRAllowing Execution of All Commands -.sp -.LP -The following entry allows the user to execute all commands: - -.sp -.in +2 -.nf -\fBAll:::Use this profile to give a :help=All.html\fR -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRConsulting the Local \fBprof_attr\fR File First -.sp -.LP -With the following \fBnsswitch.conf\fR entry, the local \fBprof_attr\fR file is -consulted before the \fBNIS\fR map: - -.sp -.in +2 -.nf -\fBprof_attr: files nis\fR -.fi -.in -2 -.sp - -.SH FILES -.LP -\fB/etc/nsswitch.conf\fR -.sp -.LP -\fB/etc/security/prof_attr\fR -.SH NOTES -.LP -The root user is usually defined in local databases because root needs to be -able to log in and do system maintenance in single-user mode and at other times -when the network name service databases are not available. So that the profile -definitions for root can be located at such times, root's profiles should be -defined in the local \fBprof_attr\fR file, and the order shown in the example -\fBnsswitch.conf\fR(4) file entry under EXAMPLES is highly recommended. -.sp -.LP -Because the list of legal keys is likely to expand, any code that parses this -database must be written to ignore unknown key-value pairs without error. When -any new keywords are created, the names should be prefixed with a unique -string, such as the company's stock symbol, to avoid potential naming -conflicts. -.sp -.LP -Each application has its own requirements for whether the \fBhelp\fR value must -be a relative pathname ending with a filename or the name of a file. The only -known requirement is for the name of a file. -.sp -.LP -The following characters are used in describing the database format and must be -escaped with a backslash if used as data: colon (\fB:\fR), semicolon (\fB;\fR), -equals (\fB=\fR), and backslash (\fB\e\fR). -.SH SEE ALSO -.LP -\fBauths\fR(1), \fBpfexec\fR(1), \fBprofiles\fR(1), \fBgetauthattr\fR(3SECDB), -\fBgetprofattr\fR(3SECDB), \fBgetuserattr\fR(3SECDB), \fBauth_attr\fR(4), -\fBexec_attr\fR(4), \fBpriv_names\fR(4), \fBuser_attr\fR(4) diff --git a/usr/src/man/man4/profile.4 b/usr/src/man/man4/profile.4 deleted file mode 100644 index 293cddad2b..0000000000 --- a/usr/src/man/man4/profile.4 +++ /dev/null @@ -1,101 +0,0 @@ -'\" te -.\" Copyright (c) 1992, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 PROFILE 4 "Dec 20, 1992" -.SH NAME -profile \- setting up an environment for user at login time -.SH SYNOPSIS -.LP -.nf -\fB/etc/profile\fR -.fi - -.LP -.nf -\fB$\fR\fBHOME\fR\fB/.profile\fR -.fi - -.SH DESCRIPTION -.sp -.LP -All users who have the shell, \fBsh\fR(1), as their login command have the -commands in these files executed as part of their login sequence. -.sp -.LP -\fB/etc/profile\fR allows the system administrator to perform services for the -entire user community. Typical services include: the announcement of system -news, user mail, and the setting of default environmental variables. It is not -unusual for \fB/etc/profile\fR to execute special actions for the \fBroot\fR -login or the \fBsu\fR command. -.sp -.LP -The file \fB$\fR\fBHOME\fR\fB/.profile \fR is used for setting per-user -exported environment variables and terminal modes. The following example is -typical (except for the comments): -.sp -.in +2 -.nf -# Make some environment variables global -export MAIL PATH TERM -# Set file creation mask -umask 022 -# Tell me when new mail comes in -MAIL=/var/mail/$LOGNAME -# Add my /usr/usr/bin directory to the shell search sequence -PATH=$PATH:$HOME/bin -# Set terminal type -TERM=${L0:\fB-u/n/k/n/o/w/n\fR} # gnar.invalid -while : -do - if [ \fB-f\fR ${TERMINFO:-/usr/share/lib/terminfo}/?/$TERM ] - then break - elif [ \fB-f\fR /usr/share/lib/terminfo/?/$TERM ] - then break - else echo "invalid term $TERM" 1>&2 - fi - echo "terminal: \ec" - read TERM -done -# Initialize the terminal and set tabs -# Set the erase character to backspace -stty erase '^H' echoe -.fi -.in -2 -.sp - -.SH FILES -.sp -.ne 2 -.na -\fB\fB$\fR\fBHOME\fR\fB/.profile \fR\fR -.ad -.RS 19n -user-specific environment -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/profile\fR\fR -.ad -.RS 19n -system-wide environment -.RE - -.SH SEE ALSO -.sp -.LP -\fBenv\fR(1), \fBlogin\fR(1), \fBmail\fR(1), \fBsh\fR(1), \fBstty\fR(1), -\fBtput\fR(1), \fBsu\fR(1M), \fBterminfo\fR(4), \fBenviron\fR(5), \fBterm\fR(5) -.sp -.LP -\fISolaris Advanced User\&'s Guide\fR -.SH NOTES -.sp -.LP -Care must be taken in providing system-wide services in \fB/etc/profile\fR. -Personal \fB\&.profile\fR files are better for serving all but the most global -needs. diff --git a/usr/src/man/man4/project.4 b/usr/src/man/man4/project.4 deleted file mode 100644 index 60bd5985e4..0000000000 --- a/usr/src/man/man4/project.4 +++ /dev/null @@ -1,230 +0,0 @@ -'\" te -.\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved -.\" 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 PROJECT 4 "May 9, 2005" -.SH NAME -project \- project file -.SH DESCRIPTION -.sp -.LP -The \fBproject\fR file is a local source of project information. The -\fBproject\fR file can be used in conjunction with other project sources, -including the \fBNIS\fR maps \fBproject.byname\fR and \fBproject.bynumber\fR -and the \fBLDAP\fR database \fBproject\fR. Programs use the -\fBgetprojent\fR(3PROJECT) routines to access this information. -.sp -.LP -The \fBproject\fR file contains a one-line entry for each project recognized by -the system, of the form: -.sp -.in +2 -.nf -\fIprojname\fR:\fIprojid\fR:\fIcomment\fR:\fIuser-list\fR:\fIgroup-list\fR:\fIattributes\fR -.fi -.in -2 - -.sp -.LP -where the fields are defined as: -.sp -.ne 2 -.na -\fB\fIprojname\fR\fR -.ad -.RS 14n -The name of the project. The name must be a string that consists of -alphanumeric characters, underline (_) characters, hyphens (-), and periods -(.). The period, which is reserved for projects with special meaning to the -operating system, can be used only in the names of default projects for users. -\fIprojname\fR cannot contain colons (:) or newline characters. -.RE - -.sp -.ne 2 -.na -\fB\fIprojid\fR\fR -.ad -.RS 14n -The project's unique numerical \fBID\fR (\fBPROJID\fR) within the system. The -maximum value of the \fIprojid\fR field is \fBMAXPROJID\fR. Project IDs below -100 are reserved for the use of the operating system. -.RE - -.sp -.ne 2 -.na -\fB\fIcomment\fR\fR -.ad -.RS 14n -The project's description. -.RE - -.sp -.ne 2 -.na -\fB\fIuser-list\fR\fR -.ad -.RS 14n -A comma-separated list of users allowed in the project. With the exception of -the special projects referred to below, an empty field indicates no users are -allowed. See note about the use of wildcards below. -.RE - -.sp -.ne 2 -.na -\fB\fIgroup-list\fR\fR -.ad -.RS 14n -A comma-separated list of groups of users allowed in the project. With the -exception of the special projects referred to below, an empty field indicates -no groups are allowed. See note about the use of wildcards below. -.RE - -.sp -.ne 2 -.na -\fB\fIattributes\fR\fR -.ad -.RS 14n -A semicolon-separated list of name value pairs. Each pair has the following -format: -.sp -\fIname\fR[=\fIvalue\fR] -.sp -where \fIname\fR is the arbitrary string specifying the key's name and -\fIvalue\fR is the optional key value. An explanation of the valid name-value -pair syntax is provided in the \fBUSAGE\fR section of this page. The expected -most frequent use of the attribute field is for the specification of resource -controls. See \fBresource_controls\fR(5) for a description of the resource -controls supported in the current release of the Solaris operating system. You -can also use the attribute field for resource caps (see \fBrcapd\fR(1M)) and -for the \fBproject.pool\fR attribute (see \fBsetproject\fR(3PROJECT)). -.RE - -.sp -.LP -Null entries (empty fields) in the \fIuser-list\fR and \fIgroup-list\fR fields, -which normally mean "no users" and "no groups", respectively, have a different -meaning in the entries for three special projects, \fBuser.\fIusername\fR\fR, -\fBgroup.\fIgroupname\fR\fR, and \fBdefault\fR. See \fBgetprojent\fR(3PROJECT) -for a description of these projects. -.sp -.LP -Wildcards can be used in user-list and group-list fields of the project -database entry. The asterisk (\fB*\fR), allows all users or groups to join the -project. The exclamation mark followed by the asterisk (\fB!*\fR), excludes all -users or groups from the project. The exclamation mark (\fB!\fR) followed by a -username or groupname excludes the specified user or group from the project. -See EXAMPLES, below. -.sp -.LP -Malformed entries cause routines that read this file to halt, in which case -project assignments specified further along are never made. Blank lines are -treated as malformed entries in the \fBproject\fR file, and cause -\fBgetprojent\fR(3PROJECT) and derived interfaces to fail. -.SH EXAMPLES -.LP -\fBExample 1 \fRSample \fBproject\fR File -.sp -.LP -The following is a sample \fBproject\fR file: - -.sp -.in +2 -.nf -system:0:System::: -user.root:1:Super-User::: -noproject:2:No Project::: -default:3:::: -group.staff:10:::: -beatles:100:The Beatles:john,paul,george,ringo::task.max-lwps= - (privileged,100,signal=SIGTERM),(privileged,110,deny); - process.max-file-descriptor -.fi -.in -2 - -.sp -.LP -Note that the two line breaks in the line that begins with \fBbeatles\fR are -not valid in a \fBproject\fR file. They are shown here only to allow the -example to display on a printed or displayed page. Each entry must be on one -and only one line. - -.sp -.LP -An example project entry for \fBnsswitch.conf\fR(4) is: - -.sp -.in +2 -.nf -project: files nis -.fi -.in -2 - -.sp -.LP -With these entries, the project \fBbeatles\fR will have members \fBjohn\fR, -\fBpaul\fR, \fBgeorge\fR, and \fBringo\fR, and all projects listed in the -\fBNIS\fR project table are effectively incorporated after the entry for -\fBbeatles\fR. - -.sp -.LP -The \fBbeatles\fR project has two values set on the \fBtask.max-lwps\fR -resource control. When a task in the \fBbeatles\fR project requests (via one of -its member processes) its 100th and 110th LWPs, an action associated with the -encountered threshold triggers. Upon the request for the 100th LWP, the process -making the request is sent the signal \fBSIGTERM\fR and is granted the request -for an additional lightweight process (LWP). At this point, the threshold for -110 LWPs becomes the active threshold. When a request for the 110th LWP in the -task is made, the requesting process is denied the request--no LWP will be -created. Since the 110th LWP is never granted, the threshold remains active, -and all subsequent requests for an 110th LWP will fail. (If LWPs are given up, -then subsequent requests will succeed, unless they would take the total number -of LWPs across the task over 110.) The \fBprocess.max-file-descriptor\fR -resource control is given no values. This means that processes entering this -project will only have the system resource control value on this \fBrctl\fR. - -.LP -\fBExample 2 \fRProject Entry with Wildcards -.sp -.LP -The following entries use wildcards: - -.sp -.in +2 -.nf -notroot:200:Shared Project:*,!root:: -notused:300:Unused Project::!*: -.fi -.in -2 -.sp - -.sp -.LP -In this example, any user except "root" is a member of project "notroot". For -the project "notused", all groups are excluded. - -.SH USAGE -.sp -.LP -The \fBproject\fR database offers a reasonably flexible attribute mechanism in -the final name-value pair field. Name-value pairs are separated from one -another with the semicolon (;) character. The name is in turn distinguished -from the (optional) value by the equals (=) character. The value field can -contain multiple values separated by the comma (,) character, with grouping -support (into further values lists) by parentheses. Each of these values can be -composed of the upper and lower case alphabetic characters, the digits '0' -through '9', and the punctuation characters hyphen (-), plus (+), period (.), -slash (/), and underscore (_). Example resource control value specifications -are provided in EXAMPLES, above, and in \fBresource_controls\fR(5) and -\fBgetprojent\fR(3PROJECT). -.SH SEE ALSO -.sp -.LP -\fBnewtask\fR(1), \fBprojects\fR(1), \fBprctl\fR(1), -\fBgetprojent\fR(3PROJECT), \fBsetrctl\fR(2), \fBunistd.h\fR(3HEAD), -\fBnsswitch.conf\fR(4), \fBresource_controls\fR(5) diff --git a/usr/src/man/man4/protocols.4 b/usr/src/man/man4/protocols.4 deleted file mode 100644 index 2f2c575777..0000000000 --- a/usr/src/man/man4/protocols.4 +++ /dev/null @@ -1,99 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 PROTOCOLS 4 "Feb 25, 2017" -.SH NAME -protocols \- protocol name database -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/protocols\fR -.fi - -.LP -.nf -\fB/etc/protocols\fR -.fi - -.SH DESCRIPTION -.LP -The \fBprotocols\fR file is a local source of information regarding the known -protocols used in the \fBDARPA\fR Internet. The protocols file can be used in -conjunction with or instead of other protocols sources, including the \fBNIS\fR -maps "protocols.byname" and "protocols.bynumber". Programs use the -\fBgetprotobyname\fR(3SOCKET) routine to access this information. -.sp -.LP -The \fBprotocols\fR file has one line for each protocol. The line has the -following format: -.sp -.in +2 -.nf -\fIofficial-protocol-name\fR \fIprotocol-number\fR \fIaliases\fR -.fi -.in -2 - -.sp -.LP -Items are separated by any number of blanks and/or TAB characters. A `\fB#\fR' -indicates the beginning of a comment; characters up to the end of the line are -not interpreted by routines which search the file. Protocol names may contain -any printable character other than a field delimiter, NEWLINE, or comment -character. -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample Database -.sp -.LP -The following is a sample database: - -.sp -.in +2 -.nf -# -# Internet (IP) protocols -# -ip 0 IP # internet protocol, pseudo protocol number -icmp 1 ICMP # internet control message protocol -ggp 3 GGP # gateway-gateway protocol -tcp 6 TCP # transmission control protocol -egp 8 EGP # exterior gateway protocol -pup 12 PUP # PARC universal packet protocol -udp 17 UDP # user datagram protocol - -# -# Internet (IPv6) extension headers -# -hopopt 0 HOPOPT # Hop-by-hop options for IPv6 -ipv6 41 IPv6 # IPv6 in IP encapsulation -ipv6-route 43 IPv6-Route # Routing header for IPv6 -ipv6-frag 44 IPv6-Frag # Fragment header for IPv6 -esp 50 ESP # Encap Security Payload for IPv6 -ah 51 AH # Authentication Header for IPv6 -ipv6-icmp 58 IPv6-ICMP # IPv6 internet control message protocol -ipv6-nonxt 59 IPv6-NoNxt # No next header extension header for IPv6 -ipv6-opts 60 IPv6-Opts # Destination Options for IPv6 -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/etc/nsswitch.conf\fR\fR -.ad -.RS 22n -configuration file for name-service switch -.RE - -.SH SEE ALSO -.LP -\fBgetprotobyname\fR(3SOCKET), \fBnsswitch.conf\fR(4) -.SH NOTES -.LP -\fB/etc/inet/protocols\fR is the official SVR4 name of the \fBprotocols\fR -file. The symbolic link \fB/etc/protocols\fR exists for \fBBSD\fR -compatibility. diff --git a/usr/src/man/man4/prototype.4 b/usr/src/man/man4/prototype.4 deleted file mode 100644 index 4137206ad8..0000000000 --- a/usr/src/man/man4/prototype.4 +++ /dev/null @@ -1,426 +0,0 @@ -'\" te -.\" Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright 1989 AT&T -.\" 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 PROTOTYPE 4 "May 3, 2008" -.SH NAME -prototype \- package information file -.SH DESCRIPTION -.sp -.LP -\fBprototype\fR is an \fBASCII\fR file used to specify package information. -Each entry in the file describes a single deliverable object. An object can be -a data file, directory, source file, executable object, and so forth. This file -is generated by the package developer. -.sp -.LP -Entries in a \fBprototype\fR file consist of several fields of information -separated by white space. Comment lines begin with a ``\fB#\fR'' and are -ignored. The fields are described below and must appear in the order shown. -.sp -.ne 2 -.na -\fB\fIpart\fR\fR -.ad -.RS 12n -An optional field designating the part number in which the object resides. A -part is a collection of files and is the atomic unit by which a package is -processed. A developer can choose criteria for grouping files into a part (for -example, based on class). If this field is not used, part 1 is assumed. -.RE - -.sp -.ne 2 -.na -\fB\fIftype\fR\fR -.ad -.RS 12n -A one-character field that indicates the file type. Valid values are: -.sp -.ne 2 -.na -\fB\fBb\fR\fR -.ad -.RS 5n -block special device -.RE - -.sp -.ne 2 -.na -\fB\fBc\fR\fR -.ad -.RS 5n -character special device -.RE - -.sp -.ne 2 -.na -\fB\fBd\fR\fR -.ad -.RS 5n -directory -.RE - -.sp -.ne 2 -.na -\fB\fBe\fR\fR -.ad -.RS 5n -a file to be edited upon installation or removal (can be shared by several -packages) -.RE - -.sp -.ne 2 -.na -\fB\fBf\fR\fR -.ad -.RS 5n -a standard executable or data file -.RE - -.sp -.ne 2 -.na -\fB\fBi\fR\fR -.ad -.RS 5n -installation script or information file -.RE - -.sp -.ne 2 -.na -\fB\fBl\fR\fR -.ad -.RS 5n -linked file -.RE - -.sp -.ne 2 -.na -\fB\fBp\fR\fR -.ad -.RS 5n -named pipe -.RE - -.sp -.ne 2 -.na -\fB\fBs\fR\fR -.ad -.RS 5n -symbolic link -.RE - -.sp -.ne 2 -.na -\fB\fBv\fR\fR -.ad -.RS 5n -volatile file (one whose contents are expected to change, like a log file) -.RE - -.sp -.ne 2 -.na -\fB\fBx\fR\fR -.ad -.RS 5n -an exclusive directory accessible only by this package -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fIclass\fR\fR -.ad -.RS 12n -The installation class to which the file belongs. This name can be no longer -than 64 characters. The field is not specified for installation scripts. -(\fBadmin\fR and all classes beginning with capital letters are reserved class -names.) -.RE - -.sp -.ne 2 -.na -\fB\fIpathname\fR\fR -.ad -.RS 12n -The pathname where the file resides on the target machine, for example, -\fB/usr/bin/mail\fR or \fBbin/ras/proc\fR. Relative pathnames (those that do -not begin with a slash) indicate that the file is relocatable. The form -.sp -\fIpath1\fR\fB=\fR\fIpath2\fR -.sp -can be used for two purposes: to define a link and to define local pathnames. -.sp -For linked files, \fIpath1\fR indicates the destination of the link and -\fIpath2\fR indicates the source file. (This format is mandatory for linked -files.) -.sp -For local pathnames, \fIpath1\fR indicates the pathname an object should have -on the machine where the entry is to be installed and \fIpath2\fR indicates -either a relative or fixed pathname to a file on the host machine which -contains the actual contents. -.sp -A pathname can contain a variable specification of the form -\fB$\fR\fIvariable.\fR If \fIvariable\fR begins with a lower case letter, it is -a build variable. If \fIvariable\fR begins with an upper case letter, it is an -install variable. Build variables are bound at build time. If an install -variable is known at build time, its definition is inserted into the -\fBpkginfo\fR(4) file so that it is available at install time. If an install -variable is not known at build time, it is bound at install time. -.RE - -.sp -.ne 2 -.na -\fB\fImajor\fR\fR -.ad -.RS 12n -The major device number. The field is only specified for block or character -special devices. -.RE - -.sp -.ne 2 -.na -\fB\fIminor\fR\fR -.ad -.RS 12n -The minor device number. The field is only specified for block or character -special devices. -.RE - -.sp -.ne 2 -.na -\fB\fImode\fR\fR -.ad -.RS 12n -The octal mode of the file (for example, 0664). A question mark (\fB?\fR) -indicates that the mode is left unchanged, implying that the file already -exists on the target machine. This field is not used for linked files or -packaging information files. -.sp -The mode can be a variable specification of the form \fB$\fR\fIvariable.\fR If -\fIvariable\fR begins with a lower case letter, it is a build variable. If -\fIvariable\fR begins with an upper case letter, it is an install variable. -Build variables are bound at build time. If an install variable is known at -build time, its definition is inserted into the \fBpkginfo\fR(4) file so that -it is available at install time. If an install variable is not known at build -time, it is bound at install time. -.RE - -.sp -.ne 2 -.na -\fB\fIowner\fR\fR -.ad -.RS 12n -The owner of the file (for example, \fBbin\fR or \fBroot\fR). The field is -limited to 14 characters in length. A question mark (\fB?\fR) indicates that -the owner is left unchanged, implying that the file already exists on the -target machine. This field is not used for linked files or packaging -information files. -.sp -The owner can be a variable specification of the form \fB$\fR\fIvariable.\fR If -\fIvariable\fR begins with a lower case letter, it is a build variable. If -\fIvariable\fR begins with an upper case letter, it is an install variable. -Build variables are bound at build time. If an install variable is known at -build time, its definition is inserted into the \fBpkginfo\fR(4) file so that -it is available at install time. If an install variable is not known at build -time, it is bound at install time. -.RE - -.sp -.ne 2 -.na -\fB\fIgroup\fR\fR -.ad -.RS 12n -The group to which the file belongs (for example, \fBbin\fR or \fBsys\fR). The -field is limited to 14 characters in length. A question mark (\fB?\fR) -indicates that the group is left unchanged, implying that the file already -exists on the target machine. This field is not used for linked files or -packaging information files. -.sp -The group can be a variable specification of the form \fB$\fR\fIvariable.\fR If -\fIvariable\fR begins with a lower case letter, it is a build variable. If -\fIvariable\fR begins with an upper case letter, it is an install variable. -Build variables are bound at build time. If an install variable is known at -build time, its definition is inserted into the \fBpkginfo\fR(4) file so that -it is available at install time. If an install variable is not known at build -time, it is bound at install time. -.RE - -.sp -.LP -An exclamation point (\fB!\fR) at the beginning of a line indicates that the -line contains a command. These commands are used to incorporate files in other -directories, to locate objects on a host machine, and to set permanent -defaults. The following commands are available: -.sp -.ne 2 -.na -\fB\fBsearch\fR\fR -.ad -.RS 15n -Specifies a list of directories (separated by white space) to search for when -looking for file contents on the host machine. The base name of the \fIpath\fR -field is appended to each directory in the ordered list until the file is -located. Searches are not recursive. -.RE - -.sp -.ne 2 -.na -\fB\fBinclude\fR\fR -.ad -.RS 15n -Specifies a pathname which points to another prototype file to include. Note -that \fBsearch\fR requests do not span \fBinclude\fR files. -.RE - -.sp -.ne 2 -.na -\fB\fBdefault\fR\fR -.ad -.RS 15n -Specifies a list of attributes (mode, owner, and group) to be used by default -if attribute information is not provided for prototype entries which require -the information. The defaults do not apply to entries in \fBinclude\fR -prototype files. -.RE - -.sp -.ne 2 -.na -\fB\fIparam\fR\fB=\fR\fIvalue\fR\fR -.ad -.RS 15n -Places the indicated parameter in the current environment. Spans to subsequent -included prototype files. -.RE - -.sp -.LP -The above commands can have variable substitutions embedded within them, as -demonstrated in the two example prototype files below. -.sp -.LP -Before files are overwritten during installation, they are copied to a -temporary pathname. The exception to this rule is files whose mode includes -execute permission, unless the file is editable (that is, \fIftype\fR is -\fBe\fR). For files which meet this exception, the existing version is linked -to a temporary pathname, and the original file is removed. This allows -processes which are executing during installation to be overwritten. -.SH EXAMPLES -.LP -\fBExample 1 \fRExample 1: -.sp -.in +2 -.nf -!PROJDIR=/usr/proj -!BIN=$PROJDIR/bin -!CFG=$PROJDIR/cfg -!LIB=$PROJDIR/lib -!HDRS=$PROJDIR/hdrs -!search /usr/myname/usr/bin /usr/myname/src /usr/myname/hdrs -i pkginfo=/usr/myname/wrap/pkginfo -i depend=/usr/myname/wrap/depend -i version=/usr/myname/wrap/version -d none /usr/wrap 0755 root bin -d none /usr/wrap/usr/bin 0755 root bin -! search $BIN -f none /usr/wrap/bin/INSTALL 0755 root bin -f none /usr/wrap/bin/REMOVE 0755 root bin -f none /usr/wrap/bin/addpkg 0755 root bin -!default 755 root bin -f none /usr/wrap/bin/audit -f none /usr/wrap/bin/listpkg -f none /usr/wrap/bin/pkgmk -# the following file starts out zero length but grows -v none /usr/wrap/logfile=/dev/null 0644 root bin -# the following specifies a link (dest=src) -l none /usr/wrap/src/addpkg=/usr/wrap/bin/rmpkg -! search $SRC -!default 644 root other -f src /usr/wrap/src/INSTALL.sh -f src /usr/wrap/src/REMOVE.sh -f src /usr/wrap/src/addpkg.c -f src /usr/wrap/src/audit.c -f src /usr/wrap/src/listpkg.c -f src /usr/wrap/src/pkgmk.c -d none /usr/wrap/data 0755 root bin -d none /usr/wrap/save 0755 root bin -d none /usr/wrap/spool 0755 root bin -d none /usr/wrap/tmp 0755 root bin -d src /usr/wrap/src 0755 root bin -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRExample 2: -.sp -.in +2 -.nf -\fB# this prototype is generated by 'pkgproto' to refer -# to all prototypes in my src directory -!PROJDIR=/usr/dew/projx -!include $PROJDIR/src/cmd/prototype -!include $PROJDIR/src/cmd/audmerg/protofile -!include $PROJDIR/src/lib/proto\fR -.fi -.in -2 -.sp - -.SH SEE ALSO -.sp -.LP -\fBpkgmk\fR(1), \fBpkginfo\fR(4) -.sp -.LP -\fIApplication Packaging Developer\&'s Guide\fR -.SH NOTES -.sp -.LP -Normally, if a file is defined in the \fBprototype\fR file but does not exist, -that file is created at the time of package installation. However, if the file -pathname includes a directory that does not exist, the file is not created. For -example, if the \fBprototype\fR file has the following entry: -.sp -.in +2 -.nf -\fBf none /usr/dev/bin/command\fR -.fi -.in -2 -.sp - -.sp -.LP -and that file does not exist, it is created if the directory \fB/usr/dev/bin\fR -already exists or if the \fBprototype\fR also has an entry defining the -directory: -.sp -.in +2 -.nf -\fBd none /usr/dev/bin\fR -.fi -.in -2 -.sp - diff --git a/usr/src/man/man4/pseudo.4 b/usr/src/man/man4/pseudo.4 deleted file mode 100644 index 8adfb6fe7a..0000000000 --- a/usr/src/man/man4/pseudo.4 +++ /dev/null @@ -1,58 +0,0 @@ -'\" te -.\" Copyright (c) 1993, Sun Microsystems, Inc. -.\" 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 PSEUDO 4 "Jun 15, 1993" -.SH NAME -pseudo \- configuration files for pseudo device drivers -.SH DESCRIPTION -.sp -.LP -Pseudo devices are devices that are implemented entirely in software. Drivers -for pseudo devices must provide driver configuration files to inform the system -of each pseudo device that should be created. -.sp -.LP -Configuration files for pseudo device drivers must identify the parent driver -explicitly as \fIpseudo,\fR and must create an integer property called -\fIinstance\fR which is unique to this entry in the configuration file. -.sp -.LP -Each entry in the configuration file creates a prototype devinfo node. Each -node is assigned an instance number which is determined by the value of the -\fIinstance\fR property. This property is only applicable to children of the -\fIpseudo\fR parent, and is required since pseudo devices have no hardware -address from which to determine the instance number. See \fBdriver.conf\fR(4) -for further details of configuration file syntax. -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample configuration file. -.sp -.LP -Here is a configuration file called \fBramdisk.conf\fR for a pseudo device -driver that implements a RAM disk. This file creates two nodes called -"ramdisk". The first entry creates ramdisk node instance 0, and the second -creates ramdisk node, instance 1, with the additional \fBdisk-size\fR property -set to \fB512.\fR - -.sp -.in +2 -.nf -\fB# -# Copyright (c) 1993, by Sun Microsystems, Inc. -# -#ident "@(#)ramdisk.conf 1.3 93/06/04 SMI" -name="ramdisk" parent="pseudo" instance=0; -name="ramdisk" parent="pseudo" instance=1 disk-size=512;\fR -.fi -.in -2 -.sp - -.SH SEE ALSO -.sp -.LP -\fBdriver.conf\fR(4), \fBddi_prop_op\fR(9F) -.sp -.LP -\fIWriting Device Drivers\fR diff --git a/usr/src/man/man4/publickey.4 b/usr/src/man/man4/publickey.4 deleted file mode 100644 index d37314f21a..0000000000 --- a/usr/src/man/man4/publickey.4 +++ /dev/null @@ -1,30 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T .\e" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. -.\" 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 PUBLICKEY 4 "Feb 25, 2017" -.SH NAME -publickey \- public key database -.SH SYNOPSIS -.LP -.nf -\fB/etc/publickey\fR -.fi - -.SH DESCRIPTION -.LP -\fB/etc/publickey\fR is a local public key database that is used for secure -RPC. The \fB/etc/publickey\fR file can be used in conjunction with or instead -of other publickey databases, including the NIS publickey map. -Each entry in the database consists of a network user name -(which may refer to either a user or a hostname), followed by the user's public -key (in hex notation), a colon, and then the user's secret key encrypted with a -password (also in hex notation). -.sp -.LP -The \fB/etc/publickey\fR file contains a default entry for \fBnobody\fR. -.SH SEE ALSO -.LP -\fBchkey\fR(1), \fBnewkey\fR(1M), \fBgetpublickey\fR(3NSL), -\fBnsswitch.conf\fR(4) diff --git a/usr/src/man/man4/queuedefs.4 b/usr/src/man/man4/queuedefs.4 deleted file mode 100644 index f6a83b777c..0000000000 --- a/usr/src/man/man4/queuedefs.4 +++ /dev/null @@ -1,121 +0,0 @@ -'\" te -.\" Copyright (c) 1994, Sun Microsystems, Inc. -.\" 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 QUEUEDEFS 4 "Mar 1, 1994" -.SH NAME -queuedefs \- queue description file for at, batch, and cron -.SH SYNOPSIS -.LP -.nf -\fB/etc/cron.d/queuedefs\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBqueuedefs\fR file describes the characteristics of the queues managed by -\fBcron\fR(1M). Each non-comment line in this file describes one queue. The -format of the lines are as follows: -.sp -.LP -\fIq\fR\fB\&.\fR[\fInjob\fR\fBj\fR][\fBnice\fR\fBn\fR][\fInwait\fR\fBw\fR] -.sp -.LP -The fields in this line are: -.sp -.ne 2 -.na -\fB\fIq\fR\fR -.ad -.RS 9n -The name of the queue. \fBa\fR is the default queue for jobs started by -\fBat\fR(1); \fBb\fR is the default queue for jobs started by \fBbatch\fR (see -\fBat\fR(1)); \fBc\fR is the default queue for jobs run from a \fBcrontab\fR(1) -file. -.RE - -.sp -.ne 2 -.na -\fB\fInjob\fR\fR -.ad -.RS 9n -The maximum number of jobs that can be run simultaneously in that queue; if -more than \fInjob\fR jobs are ready to run, only the first \fInjob\fR jobs will -be run, and the others will be run as jobs that are currently running -terminate. The default value is \fB100\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnice\fR\fR -.ad -.RS 9n -The \fBnice\fR(1) value to give to all jobs in that queue that are not run with -a user \fBID\fR of super-user. The default value is \fB2\fR. -.RE - -.sp -.ne 2 -.na -\fB\fInwait\fR\fR -.ad -.RS 9n -The number of seconds to wait before rescheduling a job that was deferred -because more than \fInjob\fR jobs were running in that job's queue, or because -the system-wide limit of jobs executing has been reached. The default value is -\fB60\fR. -.RE - -.sp -.LP -Lines beginning with \fB#\fR are comments, and are ignored. -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample file. -.sp -.in +2 -.nf -\fB# -# -a.4j1n -b.2j2n90w\fR -.fi -.in -2 -.sp - -.sp -.LP -This file specifies that the \fBa\fR queue, for \fBat\fR jobs, can have up to 4 -jobs running simultaneously; those jobs will be run with a \fBnice\fR value of -1. As no \fInwait\fR value was given, if a job cannot be run because too many -other jobs are running \fBcron\fR will wait 60 seconds before trying again to -run it. - -.sp -.LP -The \fBb\fR queue, for \fBbatch\fR(1) jobs, can have up to 2 jobs running -simultaneously; those jobs will be run with a \fBnice\fR(1) value of 2. If a -job cannot be run because too many other jobs are running, \fBcron\fR(1M) will -wait 90 seconds before trying again to run it. All other queues can have up to -100 jobs running simultaneously; they will be run with a \fBnice\fR value of 2, -and if a job cannot be run because too many other jobs are running \fBcron\fR -will wait 60 seconds before trying again to run it. - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/cron.d/queuedefs\fR\fR -.ad -.RS 25n -queue description file for \fBat\fR, \fBbatch\fR, and \fBcron\fR. -.RE - -.SH SEE ALSO -.sp -.LP -\fBat\fR(1), \fBcrontab\fR(1), \fBnice\fR(1), \fBcron\fR(1M) diff --git a/usr/src/man/man4/rcmscript.4 b/usr/src/man/man4/rcmscript.4 deleted file mode 100644 index c8142136fb..0000000000 --- a/usr/src/man/man4/rcmscript.4 +++ /dev/null @@ -1,984 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 RCMSCRIPT 4 "Feb 18, 2003" -.SH NAME -rcmscript \- script interface specification for the Reconfiguration and -Coordination Manager -.SH SYNOPSIS -.LP -.nf -\fB\fIrcm_scriptname\fR scriptinfo\fR -.fi - -.LP -.nf -\fB\fIrcm_scriptname\fR register\fR -.fi - -.LP -.nf -\fB\fIrcm_scriptname\fR resourceinfo \fIresourcename\fR\fR -.fi - -.LP -.nf -\fB\fIrcm_scriptname\fR queryremove \fIresourcename\fR\fR -.fi - -.LP -.nf -\fB\fIrcm_scriptname\fR preremove \fIresourcename\fR\fR -.fi - -.LP -.nf -\fB\fIrcm_scriptname\fR postremove \fIresourcename\fR\fR -.fi - -.LP -.nf -\fB\fIrcm_scriptname\fR undoremove \fIresourcename\fR\fR -.fi - -.SH DESCRIPTION -.LP -Reconfiguration and Coordination Manager (RCM) is a framework designed to -coordinate device consumers during Solaris Dynamic Reconfiguration (DR). The -interfaces specified in this man page allow device consumers, such as -application vendors or site administrators, to act before and after DR -operations take place by providing RCM scripts. You can write your own RCM -scripts to shut down your applications, or to cleanly release the devices from -your applications during dynamic remove operations. -.sp -.LP -An RCM script is an executable perl script, a shell script or a binary. Perl is -the recommended language. Each script is run in its own address space using the -user-id of the script file owner. -.sp -.LP -An RCM script is invoked on demand in response to DR as follows: -.sp -.in +2 -.nf -\fI<scriptname>\fR \fI<command>\fR [\fIargs\fR ...] -.fi -.in -2 -.sp - -.sp -.LP -Every script must implement the following RCM commands: -.sp -.ne 2 -.na -\fB\fBscriptinfo\fR\fR -.ad -.RS 16n -Get script information. -.RE - -.sp -.ne 2 -.na -\fB\fBregister\fR\fR -.ad -.RS 16n -Register devices the script handles. -.RE - -.sp -.ne 2 -.na -\fB\fBresourceinfo\fR\fR -.ad -.RS 16n -Get resource information. -.RE - -.sp -.LP -A script might include some or all the of the following commands: -.sp -.ne 2 -.na -\fB\fBqueryremove\fR\fR -.ad -.RS 15n -Queries whether the resource can be released. -.RE - -.sp -.ne 2 -.na -\fB\fBpreremove\fR\fR -.ad -.RS 15n -Releases the resource. -.RE - -.sp -.ne 2 -.na -\fB\fBpostremove\fR\fR -.ad -.RS 15n -Provides post-resource removal notification. -.RE - -.sp -.ne 2 -.na -\fB\fBundoremove\fR\fR -.ad -.RS 15n -Undo the actions done in preremove. -.RE - -.sp -.LP -When a script's \fBregister\fR command is run, the script should supply, in -return data, all resource names the script or its application handles that -could potentially be removed by DR. A resource name refers to a name in -\fB/dev\fR path name. -.sp -.LP -Below is a high-level overview of the sequence of script invocations that -occurs when dynamic removal of a script's registered resource is attempted. See -the COMMANDS section for a detailed description of the commands. -.RS +4 -.TP -1. -Prior to removing the resource from the system during DR, the script's -\fBqueryremove\fR command is run: -.sp -.in +2 -.nf -\fI<scriptname>\fR queryremove \fI<resourcename>\fR -.fi -.in -2 -.sp - -The script should check for obvious reasons why the resource can not be removed -from the perspective of its service or application. -.RE -.RS +4 -.TP -2. -If the script indicates that the resource can be removed in the -\fBqueryremove\fR command. The script's \fBpreremove\fR command is run: -.sp -.in +2 -.nf -\fI<scriptname>\fR preremove \fI<resourcename>\fR -.fi -.in -2 -.sp - -The script releases the resource from the service or application represented by -the script and prepares for the resource removal. Releasing the resource -includes closing the resource if the resource is currently opened by its -application. -.RE -.RS +4 -.TP -3. -The system then proceeds to remove the resource. -.RE -.RS +4 -.TP -4. -If the system has removed the resource successfully the script's -\fBpostremove\fR command is run: -.sp -.in +2 -.nf -\fI<scriptname>\fR postremove \fI<resourcename>\fR -.fi -.in -2 -.sp - -Otherwise the script's \fBundoremove\fR command is run: -.sp -.in +2 -.nf -\fI<scriptname>\fR undoremove \fI<resourcename>\fR -.fi -.in -2 -.sp - -.RE -.sp -.LP -For any commands the script does not implement, it must exit with exit status -of 2. RCM silently returns success for the script's unimplemented commands. -.sp -.LP -A script performs the following basic steps: -.RS +4 -.TP -.ie t \(bu -.el o -Takes RCM command and additional arguments from the command line and -environment parameters. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Processes the command. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Writes the expected return data to stdout as \fIname=value\fR pairs delimited -by newlines, where \fIname\fR is the name of the return data item that RCM -expects and \fIvalue\fR is the value associated with the data item. -.RE -.SS "Environment" -.LP -The initial environment of RCM scripts is set as follows: -.RS +4 -.TP -.ie t \(bu -.el o -Process UID is set to the UID of the script. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Process GID is set to the GID of the script. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBPATH\fR variable is set to \fB/usr/sbin:/usr/bin\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Current working directory is set to: -.RS +4 -.TP -.ie t \(bu -.el o -\fB/var/run\fR for scripts owned by root -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fB/tmp\fR for scripts not owned by root -.RE -.RE -.RS +4 -.TP -.ie t \(bu -.el o -File descriptor 0 (stdin) is set to \fB/dev/null\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Environment variable \fBRCM_ENV_DEBUG_LEVEL\fR is set to the debug level. -Logging is discussed below. -.RE -.RS +4 -.TP -.ie t \(bu -.el o - The following environment variables are also set where possible: -.RS +4 -.TP -.ie t \(bu -.el o -\fBLANG\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBLC_COLLATE\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBLC_CTYPE\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBLC_MESSAGES\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBLC_MONETARY\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBLC_NUMERIC\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBLC_TIME\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBLC_ALL\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBTZ\fR -.RE -See \fBenviron\fR(5) for a description of these variables. See \fBgettext\fR(1) -for details on retrieving localized messages. -.RE -.sp -.LP -All environment variable names beginning with \fBRCM_ENV_\fR are reserved for -use by the RCM. -.sp -.LP -The character encoding used by the RCM and RCM scripts to exchange RCM -commands, environment parameters, and name-value pairs is ASCII unless the -controlling environment variables are specified otherwise. -.SS "Commands" -.SS "\fBscriptinfo\fR" -.LP -The \fBscriptinfo\fR command is invoked to gather information about the script. -.sp -.ne 2 -.na -\fBReturn data:\fR -.ad -.RS 16n -If successful, the script must write the following name-value pairs to stdout -and exit with status 0: -.RS +4 -.TP -.ie t \(bu -.el o -\fBrcm_script_version=1\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBrcm_script_func_info=\fR\fIscript_func_info\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBrcm_cmd_timeout=\fR\fIcommand_timeout_value\fR -.RE -where \fIscript_func_info\fR is a localized human-readable message describing -the functionality of the script. -.sp -The RCM monitors the execution time of RCM commands by RCM scripts. -\fIcommand_timeout_value\fR is the maximum time in seconds the script is -expected to take to process any RCM command except the \fBscriptinfo\fR command -itself. If an RCM script does not process the RCM command and exit within this -time, RCM sends a \fBSIGABRT\fR signal to the script process. RCM then waits -for a few seconds for the script to finish the processing of the current RCM -command and exit. If the script does not exit within this time, RCM sends a -\fBSIGKILL\fR signal to the script. -.sp -The \fBrcm_cmd_timeout\fR name-value pair is optional. It is only needed if the -script is expected to take more than a few seconds to process any RCM command. -Setting this name to a value of 0 (zero) disables the timer. If this name-value -pair is not supplied, a default value is assigned by the RCM. -.sp -Upon failure, the script must specify the failure reason using the name-value -pair \fBrcm_failure_reason\fR and exit with status 1. -.RE - -.SS "\fBregister\fR" -.LP -The \fBregister\fR command is invoked to allow a script to specify the -resources that it or its application handles that could potentially be removed -by DR. The script has to supply all its resource names to RCM using the -name-value pair \fBrcm_resource_name\fR. -.sp -.ne 2 -.na -\fBReturn Data:\fR -.ad -.RS 16n -If successful, the script must write the following name-value pairs to stdout -and exit with status 0: -.sp -.in +2 -.nf -rcm_resource_name=\fIresourcename\fR -rcm_resource_name=\fIresourcename\fR - . - . - . -.fi -.in -2 -.sp - -where \fIresourcename\fR is the name of the resource the script is interested -in. -.sp -Upon failure, the script must specify the failure reason using the name-value -pair \fBrcm_failure_reason\fR and exit with status 1. -.RE - -.SS "\fBresourceinfo\fR \fIresourcename\fR" -.LP -The \fBresourceinfo\fR command is invoked to get the usage information about -\fIresourcename\fR. -.sp -.ne 2 -.na -\fBReturn Data:\fR -.ad -.RS 16n -If successful, the script must write the following name-value pair to stdout -and exit with status 0: -.sp -.in +2 -.nf -rcm_resource_usage_info=\fIresource_usage\fR -.fi -.in -2 -.sp - -where \fIresource_usage\fR is a localized human readable message describing the -usage of the resource by the script. -.sp -Upon failure, the script must specify the failure reason using the name-value -pair \fBrcm_failure_reason\fR and exit with status 1. -.RE - -.SS "\fBqueryremove\fR \fIresourcename\fR" -.LP -Prior to removing the resource from the system, the \fBqueryremove\fR command -is invoked to query the script to determine whether the script can release the -given resource successfully from the service or application it represents. The -script does not actually release the resource. The script might indicate that -it is not able to release the resource if the resource is critical for its -service or application. -.sp -.LP -Additional environment parameter: -.sp -.ne 2 -.na -\fB\fBRCM_ENV_FORCE\fR\fR -.ad -.RS 17n -Can be one of: -.sp -.ne 2 -.na -\fB\fBFALSE\fR\fR -.ad -.RS 9n -Normal request. -.RE - -.sp -.ne 2 -.na -\fB\fBTRUE\fR\fR -.ad -.RS 9n -Request is urgent. The script should check whether the resource can be released -successfully by force, such as by using the force option to unmount a file -system. -.RE - -.RE - -.sp -.ne 2 -.na -\fBReturn Data:\fR -.ad -.RS 16n -If the command succeeds, the script must return no data and exit with status 0. -.sp -If the script would not be able to release the resource, it must specify the -reason using the name-value pair \fBrcm_failure_reason\fR and exit with status -3. -.sp -Upon any other failure, the script must specify the failure reason using the -name-value pair \fBrcm_failure_reason\fR and exit with status 1. -.RE - -.SS "\fBpreremove\fR \fIresourcename\fR" -.LP -The \fBpreremove\fR command is invoked prior to an attempt to remove the given -\fIresourcename\fR. In response to this command the script can either release -the resource (including closing the device if the device is currently opened) -from the service or application it represents or indicate that it can not -release the resource if the resource is critical for its service or -application. -.sp -.LP -Additional environment parameter: -.sp -.ne 2 -.na -\fB\fBRCM_ENV_FORCE\fR\fR -.ad -.RS 17n -Can be one of: -.sp -.ne 2 -.na -\fB\fBFALSE\fR\fR -.ad -.RS 9n -Normal request. -.RE - -.sp -.ne 2 -.na -\fB\fBTRUE\fR\fR -.ad -.RS 9n -Request is urgent. The script should make extra effort to release the resource, -such as by using the force option to unmount a file system. -.RE - -.RE - -.sp -.ne 2 -.na -\fBReturn Data:\fR -.ad -.RS 16n -If the command succeeds, the script must return no data and exit with status 0. -.sp -If the script cannot release the resource, it must specify the reason using the -name-value pair \fBrcm_failure_reason\fR and exit with status 3. -.sp -Upon any other failure, the script must specify the failure reason using the -name-value pair \fBrcm_failure_reason\fR and exit with status 1. -.RE - -.SS "\fBpostremove\fR \fIresourcename\fR" -.LP -The \fBpostremove\fR command is invoked after the given \fIresourcename\fR has -been removed. -.sp -.ne 2 -.na -\fBReturn Data:\fR -.ad -.RS 16n -If the command succeeds, the script must return no data and exit with status 0. -.sp -Upon failure, the script must specify the failure reason using the name-value -pair \fBrcm_failure_reason\fR and exit with status 1. -.RE - -.sp -.LP -\fBundoremove\fR \fIresourcename\fR -.sp -.LP -The \fBundoremove\fR command is invoked to undo what was done in the previous -\fBpreremove\fR command for the given \fIresourcename\fR. The script can bring -the state of the resource to the same state it was in when the script received -the \fBpreremove\fR command for that resource. -.sp -.ne 2 -.na -\fBReturn Data:\fR -.ad -.RS 16n -If the command succeeds, the script must return no data and exit with status 0. -.sp -Upon failure, the script must specify the failure reason using the name-value -pair \fBrcm_failure_reason\fR and exit with status 1. -.RE - -.SS "Logging" -.LP -A script must log all error and debug messages by writing to stdout the -name-value pairs listed below. The logged messages go to \fBsyslogd\fR(1M) with -the \fBsyslog\fR facility of \fBLOG_DAEMON\fR. See \fBsyslog.conf\fR(4). -.sp -.ne 2 -.na -\fB\fBrcm_log_err=\fR\fImessage\fR\fR -.ad -.RS 25n -Logs the \fImessage\fR with the syslog level of \fBLOG_ERR\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBrcm_log_warn=\fR\fImessage\fR\fR -.ad -.RS 25n -Logs the \fImessage\fR with the syslog level of \fBLOG_WARNING\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBrcm_log_info=\fR\fImessage\fR\fR -.ad -.RS 25n -Logs the \fImessage\fR with the syslog level of \fBLOG_INFO\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBrcm_log_debug=\fR\fImessage\fR\fR -.ad -.RS 25n -Logs the \fImessage\fR with the syslog level of \fBLOG_DEBUG\fR. -.RE - -.sp -.LP -A script can use the environment variable \fBRCM_ENV_DEBUG_LEVEL\fR to control -the amount of information to log. \fBRCM_ENV_DEBUG_LEVEL\fR is a numeric value -ranging from 0 to 9, with 0 meaning log the least amount of information and 9 -meaning log the most. -.SS "Installing or Removing RCM Scripts" -.LP -You must use the following format to name a script: -.sp -.in +2 -.nf -\fIvendor\fR,\fIservice\fR -.fi -.in -2 -.sp - -.sp -.LP -where \fIvendor\fR is the stock symbol (or any distinctive name) of the vendor -providing the script and \fIservice\fR is the name of service the script -represents. -.sp -.LP -You must be a superuser (root) to install or remove an RCM script. -.sp -.LP -Select one of the following directories where you want to place the script: -.sp -.ne 2 -.na -\fB\fB/etc/rcm/scripts\fR\fR -.ad -.sp .6 -.RS 4n -Scripts for specific systems -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/platform/`uname -i`/lib/rcm/scripts\fR\fR -.ad -.sp .6 -.RS 4n -Scripts for specific hardware implementation -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/platform/`uname -m`/lib/rcm/scripts\fR\fR -.ad -.sp .6 -.RS 4n -Scripts for specific hardware class -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/lib/rcm/scripts\fR\fR -.ad -.sp .6 -.RS 4n -Scripts for any hardware -.RE - -.SS "Installing a Script" -.LP -To install a script, copy the script to the appropriate directory from the list -above, change the userid and the groupid of the script to the desired values, -and send \fBSIGHUP\fR to \fBrcm_daemon\fR. For example: -.sp -.in +2 -.nf -# cp SUNW,sample.pl /usr/lib/rcm/scripts -# chown user[:group] /usr/lib/rcm/scripts/SUNW,sample.pl -# pkill -HUP -x -u root rcm_daemon -.fi -.in -2 -.sp - -.SS "Removing a script" -.LP -Remove the script from the appropriate directory from the list above and send -\fBSIGHUP\fR to \fBrcm_daemon\fR. For example: -.sp -.in +2 -.nf -# rm /usr/lib/rcm/scripts/SUNW,sample.pl -# pkill -HUP -x -u root rcm_daemon -.fi -.in -2 -.sp - -.SH EXAMPLES -.LP -\fBExample 1 \fRSite Customization RCM Script -.sp -.in +2 -.nf -#! /usr/bin/perl -w - -# -# A sample site customization RCM script for a tape backup application. -# -# This script registers all tape drives in the system with RCM. -# When the system attempts to remove a tape drive by DR the script -# does the following: -# - if the tape drive is not being used for backup, it allows the -# DR to continue. -# - if the tape drive is being used for backup, and when DR is not -# forced (RCM_ENV_FORCE=FALSE) it indicates that it cannot release -# the tape drive with appropriate error message. When forced -# (RCM_ENV_FORCE=TRUE) it kills the tape backup application in -# order to allow the DR to continue. -# -# This script does not implement the postremove and undoremove commands -# since there is nothing to cleanup after DR remove operation is -# completed or failed. If any cleanup is needed after the DR removal -# completed, postremove command needs to implemented. If any cleanup is -# needed in the event of DR removal failure, undoremove command needs -# to be implemented. -# - -use strict; - -my ($cmd, %dispatch); - -$cmd = shift(@ARGV); - -# dispatch table for RCM commands -%dispatch = ( - "scriptinfo" => \&do_scriptinfo, - "register" => \&do_register, - "resourceinfo" => \&do_resourceinfo, - "queryremove" => \&do_preremove, - "preremove" => \&do_preremove -); - -if (defined($dispatch{$cmd})) { - &{$dispatch{$cmd}}; -} else { - exit (2); -} - -sub do_scriptinfo -{ - print "rcm_script_version=1\en"; - print "rcm_script_func_info=Tape backup appl script for DR\en"; - exit (0); -} - -sub do_register -{ - my ($dir, $f, $errmsg); - - $dir = opendir(RMT, "/dev/rmt"); - if (!$dir) { - $errmsg = "Unable to open /dev/rmt directory: $!"; - print "rcm_failure_reason=$errmsg\en"; - exit (1); - } - - while ($f = readdir(RMT)) { - # ignore hidden files and multiple names for the same device - if (($f !~ /^\./) && ($f =~ /^[0-9]+$/)) { - print "rcm_resource_name=/dev/rmt/$f\en"; - } - - } - - closedir(RMT); - exit (0); -} - -sub do_resourceinfo -{ - my ($rsrc, $unit); - - $rsrc = shift(@ARGV); - if ($rsrc =~ /^\e/dev\e/rmt\e/([0-9]+)$/) { - $unit = $1; - print "rcm_resource_usage_info=Backup Tape Unit Number $unit\en"; - exit (0); - } else { - print "rcm_failure_reason=Unknown tape device!\en"; - exit (1); - } -} - -sub do_preremove -{ - my ($rsrc); - - $rsrc = shift(@ARGV); - - # check if backup application is using this resource - # if (the backup application is not running on $rsrc) { - # allow the DR to continue - # exit (0); - #} - # - # If RCM_ENV_FORCE is FALSE deny the operation. - # If RCM_ENV_FORCE is TRUE kill the backup application in order - # to allow the DR operation to proceed - # - if ($ENV{RCM_ENV_FORCE} eq 'TRUE') { - if ($cmd eq 'preremove') { - # kill the tape backup application - } - exit (0); - } else { - # - # indicate that the tape drive can not be released - # since the device is being used for backup by the - # tape backup application - # - print "rcm_failure_reason=tape backup in progress pid=...\en"; - exit (3); - - } -} -.fi -.in -2 - -.SH EXIT STATUS -.LP -A script must exit with following exit status values: -.sp -.ne 2 -.na -\fB\fB0\fR\fR -.ad -.RS 5n -Operation specified by the given RCM command has been executed successfully by -the script. For \fBqueryremove\fR command it also means that the script can -successfully release the resource. -.RE - -.sp -.ne 2 -.na -\fB\fB1\fR\fR -.ad -.RS 5n -An error occurred while processing the RCM command. The script should provide -the error message to RCM using the name-value pair \fBrcm_failure_reason\fR -before exiting. -.RE - -.sp -.ne 2 -.na -\fB\fB2\fR\fR -.ad -.RS 5n -The script does not support the given RCM command. A script must exit with this -status if it cannot understand the given RCM command. -.RE - -.sp -.ne 2 -.na -\fB\fB3\fR\fR -.ad -.RS 5n -Indicates that the script cannot release the resource for \fBpreremove\fR and -\fBqueryremove\fR commands. The script should provide a message to RCM -specifying the reason for not being able to release the resource using the -name-value pair \fBrcm_failure_reason\fR before exiting. -.RE - -.SH ERRORS -.LP -If a script cannot successfully process an RCM command, it must supply to the -RCM a message indicating the reason for failure by writing a name-value pair, -in the form shown below, to stdout and exiting with the appropriate exit -status. -.sp -.in +2 -.nf -rcm_failure_reason=\fIfailure_reason\fR -.fi -.in -2 -.sp - -.sp -.LP -where \fIfailure_reason\fR is a localized human readable message describing the -reason for failure of the RCM command. -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.LP -\fBgettext\fR(1), \fBcfgadm\fR(1M), \fBcfgadm_scsi\fR(1M), -\fBcfgadm_pci\fR(1M), \fBsyslog\fR(3C), \fBsignal.h\fR(3HEAD), -\fBsyslog.conf\fR(4), \fBattributes\fR(5), \fBenviron\fR(5) -.SH NOTES -.LP -RCM scripts are expected to properly handle all RCM commands that the script -implements and to log all errors. Only root has permission to add or remove an -RCM script. An ill-behaved RCM script can cause unexpected DR failures. -.sp -.LP -RCM commands are invoked only for the resources whose subsystems participate -within the RCM framework. Currently, not all subsystems participate within the -RCM framework. diff --git a/usr/src/man/man4/remote.4 b/usr/src/man/man4/remote.4 deleted file mode 100644 index aab09a3faf..0000000000 --- a/usr/src/man/man4/remote.4 +++ /dev/null @@ -1,526 +0,0 @@ -'\" te -.\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 REMOTE 4 "Jun 13, 2002" -.SH NAME -remote \- remote host description file -.SH SYNOPSIS -.LP -.nf -\fB/etc/remote\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The systems known by \fBtip\fR(1) and their attributes are stored in an -\fBASCII\fR file which is structured somewhat like the \fBtermcap\fR file. Each -line in the file provides a description for a single \fIsystem\fR. Fields are -separated by a colon `\fB:\fR'. Lines ending in a `\fB\e\fR\&' character with -an immediately following \fBNEWLINE\fR are continued on the next line. -.sp -.LP -The first entry is the name(s) of the host system. If there is more than one -name for a system, the names are separated by vertical bars. After the name of -the system comes the fields of the description. A field name followed by an -`\fB=\fR' sign indicates a string value follows. A field name followed by a -`\fB#\fR' sign indicates a following numeric value. -.sp -.LP -Entries named \fBtip\fR\fIbaudrate\fR are used as default entries by \fBtip\fR, -as follows. When \fBtip\fR is invoked with only a phone number, it looks for -an entry of the form \fBtip\fR\fIbaudrate\fR, where \fIbaudrate\fR is the baud -rate with which the connection is to be made. For example, if the connection -is to be made at \fB300\fR baud, \fBtip\fR looks for an entry of the form -\fBtip300\fR. -.SH CAPABILITIES -.sp -.LP -Capabilities are either strings \fB(str)\fR, numbers \fB(num)\fR, or boolean -flags \fB(bool)\fR. A string capability is specified by -\fIcapability\fR=\fIvalue\fR; for example, `\fBdv=/dev/harris\fR'. A numeric -capability is specified by \fIcapability\fR#\fIvalue\fR; for example, -`\fBxa#99\fR'. A boolean capability is specified by simply listing the -capability. -.sp -.ne 2 -.na -\fB\fBat\fR\fR -.ad -.RS 6n -\fB(str)\fR Auto call unit type. The following lists valid '\fBat\fR' types and -their corresponding hardware: -.sp -.ne 2 -.na -\fB\fBbiz31f\fR\fR -.ad -.RS 10n -Bizcomp 1031, tone dialing -.RE - -.sp -.ne 2 -.na -\fB\fBbiz31w\fR\fR -.ad -.RS 10n -Bizcomp 1031, pulse dialing -.RE - -.sp -.ne 2 -.na -\fB\fBbiz22f\fR\fR -.ad -.RS 10n -Bizcomp 1022, tone dialing -.RE - -.sp -.ne 2 -.na -\fB\fBbiz22w\fR\fR -.ad -.RS 10n -Bizcomp 1022, pulse dialing -.RE - -.sp -.ne 2 -.na -\fB\fBdf02\fR\fR -.ad -.RS 10n -DEC DF02 -.RE - -.sp -.ne 2 -.na -\fB\fBdf03\fR\fR -.ad -.RS 10n -DEC DF03 -.RE - -.sp -.ne 2 -.na -\fB\fBventel\fR\fR -.ad -.RS 10n -Ventel 212+ -.RE - -.sp -.ne 2 -.na -\fB\fBv3451\fR\fR -.ad -.RS 10n -Vadic 3451 Modem -.RE - -.sp -.ne 2 -.na -\fB\fBv831\fR\fR -.ad -.RS 10n -Vadic 831 -.RE - -.sp -.ne 2 -.na -\fB\fBhayes\fR\fR -.ad -.RS 10n -Any Hayes-compatible modem -.RE - -.sp -.ne 2 -.na -\fB\fBat\fR\fR -.ad -.RS 10n -Any Hayes-compatible modem -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBbr\fR\fR -.ad -.RS 6n -\fB(num)\fR The baud rate used in establishing a connection to the remote host. -This is a decimal number. The default baud rate is \fB300\fR baud. -.RE - -.sp -.ne 2 -.na -\fB\fBcm\fR\fR -.ad -.RS 6n -\fB(str)\fR An initial connection message to be sent to the remote host. For -example, if a host is reached through a port selector, this might be set to the -appropriate sequence required to switch to the host. -.RE - -.sp -.ne 2 -.na -\fB\fBcu\fR\fR -.ad -.RS 6n -\fB(str)\fR Call unit if making a phone call. Default is the same as the -\fBdv\fR field. -.RE - -.sp -.ne 2 -.na -\fB\fBdb\fR\fR -.ad -.RS 6n -\fB(bool)\fR Cause \fBtip\fR(1) to ignore the first hangup it sees. \fBdb\fR -(dialback) allows the user to remain in \fBtip\fR while the remote machine -disconnects and places a call back to the local machine. For more information -about dialback configuration, see \fISystem Administration Guide: IP -Services\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBdi\fR\fR -.ad -.RS 6n -\fB(str)\fR Disconnect message sent to the host when a disconnect is requested -by the user. -.RE - -.sp -.ne 2 -.na -\fB\fBdu\fR\fR -.ad -.RS 6n -\fB(bool)\fR This host is on a dial-up line. -.RE - -.sp -.ne 2 -.na -\fB\fBdv\fR\fR -.ad -.RS 6n -\fB(str)\fR Device(s) to open to establish a connection. If this file refers to -a terminal line, \fBtip\fR attempts to perform an exclusive open on the device -to insure only one user at a time has access to the port. -.RE - -.sp -.ne 2 -.na -\fB\fBec\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBechocheck\fR to \fBon\fR, so -that \fBtip\fR will synchronize with the remote host during file transfer by -waiting for the echo of the last character transmitted. -.RE - -.sp -.ne 2 -.na -\fB\fBel\fR\fR -.ad -.RS 6n -\fB(str)\fR Characters marking an end-of-line. The default is no characters. -\fBtip\fR only recognizes `\fB~\fR' escapes after one of the characters in -\fBel\fR, or after a \fBRETURN.\fR -.RE - -.sp -.ne 2 -.na -\fB\fBes\fR\fR -.ad -.RS 6n -\fB(str)\fR The command prefix (escape) character for \fBtip\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBet\fR\fR -.ad -.RS 6n -\fB(num)\fR Number of seconds to wait for an echo response when echo-check mode -is on. This is a decimal number. The default value is \fB10\fR seconds. -.RE - -.sp -.ne 2 -.na -\fB\fBex\fR\fR -.ad -.RS 6n -\fB(str)\fR Set of non-printable characters not to be discarded when scripting -with beautification turned on. The default value is "\fB\et\en\eb\ef\fR". -.RE - -.sp -.ne 2 -.na -\fB\fBfo\fR\fR -.ad -.RS 6n -\fB(str)\fR Character used to force literal data transmission. The default -value is `\fB\e377\fR\&'. -.RE - -.sp -.ne 2 -.na -\fB\fBfs\fR\fR -.ad -.RS 6n -\fB(num)\fR Frame size for transfers. The default frame size is equal to -\fB1024\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBhd\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBhalfduplex\fR to \fBon\fR, so -local echo should be performed. -.RE - -.sp -.ne 2 -.na -\fB\fBhf\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBhardwareflow\fR to \fBon\fR, -so hardware flow control is used. -.RE - -.sp -.ne 2 -.na -\fB\fBie\fR\fR -.ad -.RS 6n -\fB(str)\fR Input end-of-file marks. The default is a null string (""). -.RE - -.sp -.ne 2 -.na -\fB\fBnb\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBbeautify\fR to \fIoff\fR, so -that unprintable characters will not be discarded when scripting. -.RE - -.sp -.ne 2 -.na -\fB\fBnt\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBtandem\fR to \fIoff\fR, so -that \fBXON/XOFF\fR flow control will not be used to throttle data from the -remote host. -.RE - -.sp -.ne 2 -.na -\fB\fBnv\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBverbose\fR to \fIoff\fR, so -that verbose mode will be turned on. -.RE - -.sp -.ne 2 -.na -\fB\fBoe\fR\fR -.ad -.RS 6n -\fB(str)\fR Output end-of-file string. The default is a null string (""). -When \fBtip\fR is transferring a file, this string is sent at end-of-file. -.RE - -.sp -.ne 2 -.na -\fB\fBpa\fR\fR -.ad -.RS 6n -\fB(str)\fR The type of parity to use when sending data to the host. This may -be one of \fBeven\fR, \fBodd\fR, \fBnone\fR, \fBzero\fR (always set bit -\fB8\fR to \fB0\fR), \fBone\fR (always set bit \fB8\fR to \fB1\fR). The -default is \fBnone\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpn\fR\fR -.ad -.RS 6n -\fB(str)\fR Telephone number(s) for this host. If the telephone number field -contains an `\fB@\fR' sign, \fBtip\fR searches the \fB/etc/phones\fR file for a -list of telephone numbers \(em see \fBphones\fR(4). A `\fB%\fR' sign in the -telephone number indicates a 5-second delay for the Ventel Modem. -.sp -For Hayes-compatible modems, if the telephone number starts with an 'S', the -telephone number string will be sent to the modem without the "\fBDT\fR", which -allows reconfiguration of the modem's S-registers and other parameters; for -example, to disable auto-answer: "\fBpn=S0=0DT5551234\fR"; or to also -restrict the modem to return only the basic result codes: -"\fBpn=S0=0X0DT5551234\fR". -.RE - -.sp -.ne 2 -.na -\fB\fBpr\fR\fR -.ad -.RS 6n -\fB(str)\fR Character that indicates end-of-line on the remote host. The -default value is \fB`\fR\en\fB\&'.\fR -.RE - -.sp -.ne 2 -.na -\fB\fBra\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBraise\fR to \fBon\fR, so that -lower case letters are mapped to upper case before sending them to the remote -host. -.RE - -.sp -.ne 2 -.na -\fB\fBrc\fR\fR -.ad -.RS 6n -\fB(str)\fR Character that toggles case-mapping mode. The default value is -`\fB\e377\fR\&'. -.RE - -.sp -.ne 2 -.na -\fB\fBre\fR\fR -.ad -.RS 6n -\fB(str)\fR The file in which to record session scripts. The default value is -\fBtip.record\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBrw\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBrawftp\fR to \fBon\fR, so -that all characters will be sent as is during file transfers. -.RE - -.sp -.ne 2 -.na -\fB\fBsc\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBscript\fR to \fBon\fR, so -that everything transmitted by the remote host will be recorded. -.RE - -.sp -.ne 2 -.na -\fB\fBtb\fR\fR -.ad -.RS 6n -\fB(bool)\fR Initialize the \fBtip\fR variable \fBtabexpand\fR to \fBon\fR, so -that tabs will be expanded to spaces during file transfers. -.RE - -.sp -.ne 2 -.na -\fB\fBtc\fR\fR -.ad -.RS 6n -\fB(str)\fR Indicates that the list of capabilities is continued in the named -description. This is used primarily to share common capability information. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRUsing the Capability Continuation Feature -.sp -.LP -Here is a short example showing the use of the capability continuation feature: - -.sp -.in +2 -.nf -UNIX-1200:\e - :dv=/dev/cua0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D -:br#1200:arpavax|ax:\e - :pn=7654321%:tc=UNIX-1200 -.fi -.in -2 -.sp - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/remote\fR\fR -.ad -.RS 15n -remote host description file. -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/phones\fR\fR -.ad -.RS 15n -remote host phone number database. -.RE - -.SH SEE ALSO -.sp -.LP -\fBtip\fR(1), \fBphones\fR(4) -.sp -.LP -\fISystem Administration Guide: IP Services\fR diff --git a/usr/src/man/man4/resolv.conf.4 b/usr/src/man/man4/resolv.conf.4 deleted file mode 100644 index 855acd44e2..0000000000 --- a/usr/src/man/man4/resolv.conf.4 +++ /dev/null @@ -1,257 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" Copyright (c) 1983 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. -.TH RESOLV.CONF 4 "Dec 15, 2004" -.SH NAME -resolv.conf \- resolver configuration file -.SH SYNOPSIS -.LP -.nf -\fB/etc/resolv.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBresolver\fR is a set of routines that provide access to the Internet -Domain Name System. See \fBresolver\fR(3RESOLV). \fBresolv.conf\fR is a -configuration file that contains the information that is read by the -\fBresolver\fR routines the first time they are invoked by a process. The file -is designed to be human readable and contains a list of keywords with values -that provide various types of \fBresolver\fR information. -.sp -.LP -The \fBresolv.conf\fR file contains the following configuration directives: -.sp -.ne 2 -.na -\fB\fBnameserver\fR\fR -.ad -.RS 23n -Specifies the IPv4 or IPv6 Internet address of a name server that the resolver -is to query. Up to \fIMAXNS\fR name servers may be listed, one per keyword. See -<\fBresolv.h\fR>. If there are multiple servers, the resolver library queries -them in the order listed. If no name server entries are present, the resolver -library queries the name server on the local machine. The resolver library -follows the algorithm to try a name server until the query times out. It then -tries the name servers that follow, until each query times out. It repeats all -the name servers until a maximum number of retries are made. -.RE - -.sp -.ne 2 -.na -\fB\fBdomain\fR\fR -.ad -.RS 23n -Specifies the local domain name. Most queries for names within this domain can -use short names relative to the local domain. If no domain entry is present, -the domain is determined from \fBsysinfo\fR(2) or from \fBgethostname\fR(3C). -(Everything after the first `.' is presumed to be the domain name.) If the host -name does not contain a domain part, the root domain is assumed. You can use -the \fBLOCALDOMAIN\fR environment variable to override the domain name. -.RE - -.sp -.ne 2 -.na -\fB\fBsearch\fR\fR -.ad -.RS 23n -The search list for host name lookup. The search list is normally determined -from the local domain name. By default, it contains only the local domain name. -You can change the default behavior by listing the desired domain search path -following the search keyword, with spaces or tabs separating the names. Most -\fBresolver\fR queries will be attempted using each component of the search -path in turn until a match is found. This process may be slow and will generate -a lot of network traffic if the servers for the listed domains are not local. -Queries will time out if no server is available for one of the domains. -.sp -The search list is currently limited to six domains and a total of 256 -characters. -.RE - -.sp -.ne 2 -.na -\fB\fBsortlist\fR\fIaddresslist\fR\fR -.ad -.RS 23n -Allows addresses returned by the libresolv-internal \fBgethostbyname()\fR to be -sorted. A \fBsortlist\fR is specified by IP address netmask pairs. The netmask -is optional and defaults to the natural netmask of the net. The IP address and -optional network pairs are separated by slashes. Up to 10 pairs may be -specified. For example: -.sp -.in +2 -.nf -sortlist 130.155.160.0/255.255.240.0 130.155.0.0 -.fi -.in -2 -.sp - -.RE - -.sp -.ne 2 -.na -\fB\fBoptions\fR\fR -.ad -.RS 23n -Allows certain internal resolver variables to be modified. The syntax is -.sp -.in +2 -.nf -options option ... -.fi -.in -2 -.sp - -where option is one of the following: -.sp -.ne 2 -.na -\fB\fBdebug\fR\fR -.ad -.RS 18n -Sets \fBRES_DEBUG\fR in the \fB_res.options\fR field. -.RE - -.sp -.ne 2 -.na -\fB\fBndots:\fR\fIn\fR\fR -.ad -.RS 18n -Sets a threshold floor for the number of dots which must appear in a name given -to \fBres_query()\fR before an initial absolute (as-is) query is performed. See -\fBresolver\fR(3RESOLV). The default value for \fIn\fR is 1, which means that -if there are any dots in a name, the name is tried first as an absolute name -before any search list elements are appended to it. -.RE - -.sp -.ne 2 -.na -\fB\fBtimeout:\fR\fIn\fR\fR -.ad -.br -.na -\fB\fBretrans:\fR\fIn\fR\fR -.ad -.RS 18n -Sets the amount of time the resolver will wait for a response from a remote -name server before retrying the query by means of a different name server. -Measured in seconds, the default is \fBRES_TIMEOUT\fR. See <\fBresolv.h\fR>. -The \fBtimeout\fR and \fBretrans\fR values are the starting point for an -exponential back off procedure where the \fBtimeout\fR is doubled for every -retransmit attempt. -.RE - -.sp -.ne 2 -.na -\fB\fBattempts:\fR\fIn\fR\fR -.ad -.br -.na -\fB\fBretry:\fR\fIn\fR\fR -.ad -.RS 18n -Sets the number of times the resolver will send a query to its name servers -before giving up and returning an error to the calling application. The default -is \fBRES_DFLRETRY\fR. See <\fBresolv.h\fR>. -.RE - -.sp -.ne 2 -.na -\fB\fBrotate\fR\fR -.ad -.RS 18n -Sets \fBRES_ROTATE\fR in \fB_res.options\fR. The name servers are queried -round-robin from among those listed. The query load is spread among all listed -servers, rather than having all clients try the first listed server first every -time. -.RE - -.sp -.ne 2 -.na -\fB\fBno-check-names\fR\fR -.ad -.RS 18n -Sets \fBRES_NOCHECKNAME\fR in \fB_res.options\fR. This disables the modern BIND -checking of incoming host names and mail names for invalid characters such as -underscore (\fB_\fR), non-ASCII, or control characters. -.RE - -.sp -.ne 2 -.na -\fB\fBinet6\fR\fR -.ad -.RS 18n -Sets \fBRES_USE_INET6\fR in \fB_res.options\fR. In the Solaris BIND port, this -has no effect on \fBgethostbyname\fR(3NSL). To retrieve IPv6 addresses or IPv4 -addresses, use \fBgetaddrinfo\fR(3SOCKET) instead of setting \fBinet6\fR. -.RE - -.RE - -.sp -.LP -The \fBdomain\fR and \fBsearch\fR keywords are mutually exclusive. If more than -one instance of these keywords is present, the last instance takes precedence. -.sp -.LP -You can override the \fBsearch\fR keyword of the system \fBresolv.conf\fR file -on a per-process basis by setting the environment variable \fBLOCALDOMAIN\fR to -a space-separated list of search domains. -.sp -.LP -You can amend the \fBoptions\fR keyword of the system \fBresolv.conf\fR file on -a per-process basis by setting the environment variable \fBRES_OPTIONS\fR to a -space-separated list of resolver options. -.sp -.LP -The keyword and value must appear on a single line. Start the line with the -keyword, for example, \fBnameserver\fR, followed by the value, separated by -white space. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/resolv.conf\fR\fR -.ad -.RS 20n - -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Standard BIND 8.3.3 -.TE - -.SH SEE ALSO -.sp -.LP -\fBdomainname\fR(1M), \fBsysinfo\fR(2), \fBgethostbyname\fR(3NSL), -\fBgetnameinfo\fR(3SOCKET), \fBgetipnodebyname\fR(3SOCKET), -\fBgethostname\fR(3C), \fBresolver\fR(3RESOLV), \fBattributes\fR(5) -.sp -.LP -Vixie, Paul, Dunlap, Keven J., Karels, Michael J. \fIName Server Operations -Guide for BIND\fR. Internet Software Consortium, 1996. diff --git a/usr/src/man/man4/rmtab.4 b/usr/src/man/man4/rmtab.4 deleted file mode 100644 index cd8fb2ac50..0000000000 --- a/usr/src/man/man4/rmtab.4 +++ /dev/null @@ -1,57 +0,0 @@ -'\" te -.\" Copyright (C) 1999, Sun Microsystems, -.\" Inc. All Rights Reserved -.\" 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 RMTAB 4 "Nov 15, 1990" -.SH NAME -rmtab \- remote mounted file system table -.SH SYNOPSIS -.LP -.nf -\fB/etc/rmtab\fR -.fi - -.SH DESCRIPTION -.sp -.LP -\fBrmtab\fR contains a table of filesystems that are remotely mounted by -\fBNFS\fR clients. This file is maintained by \fBmountd\fR(1M), the mount -daemon. The data in this file should be obtained only from \fBmountd\fR(1M) -using the \fBMOUNTPROC_DUMP\fR remote procedure call. -.sp -.LP -The file contains a line of information for each remotely mounted filesystem. -There are a number of lines of the form: -.sp -.in +2 -.nf -\fBhostname\fR\fB:\fR\fIfsname\fR -.fi -.in -2 - -.sp -.LP -The mount daemon adds an entry for any client that successfully executes a -mount request and deletes the appropriate entries for an unmount request. -.sp -.LP -Lines beginning with a hash (' \fB#\fR') are commented out. These lines are -removed from the file by \fBmountd\fR(1M) when it first starts up. Stale -entries may accumulate for clients that crash without sending an unmount -request. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/rmtab\fR\fR -.ad -.RS 14n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBmountd\fR(1M), \fBshowmount\fR(1M) diff --git a/usr/src/man/man4/rpc.4 b/usr/src/man/man4/rpc.4 deleted file mode 100644 index 3f626e4cfb..0000000000 --- a/usr/src/man/man4/rpc.4 +++ /dev/null @@ -1,77 +0,0 @@ -'\" te -.\" Copyright (c) 1991, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 RPC 4 "Feb 25, 2017" -.SH NAME -rpc \- rpc program number data base -.SH SYNOPSIS -.LP -.nf -\fB/etc/rpc\fR -.fi - -.SH DESCRIPTION -.LP -The \fBrpc\fR file is a local source containing user readable names that can be -used in place of \fBRPC\fR program numbers. The \fBrpc\fR file can be used in -conjunction with or instead of other rpc sources, including the \fBNIS\fR maps -``rpc.byname'' and ``rpc.bynumber''. -.sp -.LP -The rpc file has one line for each \fBRPC\fR program name. The line has the -following format: -.sp -.in +2 -.nf -\fIname-of-the-RPC-program\fR \fIRPC-program-number\fR \fIaliases\fR -.fi -.in -2 - -.sp -.LP -Items are separated by any number of blanks and/or tab characters. A -``\fB#\fR'' indicates the beginning of a comment; characters up to the end of -the line are not interpreted by routines which search the file. -.SH EXAMPLES -.LP -\fBExample 1 \fRRPC Database -.sp -.LP -Below is an example of an RPC database: - -.sp -.in +2 -.nf -# -# rpc -# -rpcbind 100000 portmap sunrpc portmapper -rusersd 100002 rusers -nfs 100003 nfsprog -mountd 100005 mount showmount -walld 100008 rwall shutdown -sprayd 100012 spray -llockmgr 100020 -nlockmgr 100021 -status 100024 -bootparam 100026 -keyserv 100029 keyserver -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/etc/nsswitch.conf\fR\fR -.ad -.RS 22n - -.RE - -.SH SEE ALSO -.LP -\fBnsswitch.conf\fR(4) diff --git a/usr/src/man/man4/rt_dptbl.4 b/usr/src/man/man4/rt_dptbl.4 deleted file mode 100644 index bace4ec80b..0000000000 --- a/usr/src/man/man4/rt_dptbl.4 +++ /dev/null @@ -1,345 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T, Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved -.\" 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 RT_DPTBL 4 "Oct 15, 2002" -.SH NAME -rt_dptbl \- real-time dispatcher parameter table -.SH DESCRIPTION -The process scheduler (or dispatcher) is the portion of the kernel that -controls allocation of the \fBCPU\fR to processes. The scheduler supports the -notion of scheduling classes where each class defines a scheduling policy, used -to schedule processes within that class. Associated with each scheduling class -is a set of priority queues on which ready to run processes are linked. These -priority queues are mapped by the system configuration into a set of global -scheduling priorities which are available to processes within the class. The -dispatcher always selects for execution the process with the highest global -scheduling priority in the system. The priority queues associated with a given -class are viewed by that class as a contiguous set of priority levels numbered -from 0 (lowest priority) to \fIn\fR (highest priority\(ema configuration -dependent value). The set of global scheduling priorities that the queues for a -given class are mapped into might not start at zero and might not be -contiguous, depending on the configuration. -.sp -.LP -The real-time class maintains an in-core table, with an entry for each priority -level, giving the properties of that level. This table is called the real-time -dispatcher parameter table (\fBrt_dptbl\fR). The \fBrt_dptbl\fR consists of an -array (\fBconfig_rt_dptbl[]\fR) of parameter structures (\fBstruct -rtdpent_t\fR), one for each of the \fIn\fR priority levels. The structure are -accessed via a pointer, (\fBrt_dptbl\fR), to the array. The properties of a -given priority level \fIi\fR are specified by the \fIi\fRth parameter structure -in this array ( \fBrt_dptbl[\fR\fIi\fR\fB]\fR ). -.sp -.LP -A parameter structure consists of the following members. These are also -described in the \fB/usr/include/sys/rt.h\fR header file. -.sp -.ne 2 -.na -\fB\fBrt_globpri\fR\fR -.ad -.RS 14n -The global scheduling priority associated with this priority level. The -\fBrt_globpri\fR values cannot be changed with \fBdispadmin\fR(1M). -.RE - -.sp -.ne 2 -.na -\fB\fBrt_quantum\fR\fR -.ad -.RS 14n -The length of the time quantum allocated to processes at this level in ticks -(\fBhz\fR). The time quantum value is only a default or starting value for -processes at a particular level as the time quantum of a real-time process can -be changed by the user with the \fBpriocntl\fR command or the \fBpriocntl\fR -system call. -.sp -In the default high resolution clock mode (\fBhires_tick\fR set to \fB1\fR), -the value of \fBhz\fR is set to \fB1000\fR. If this value is overridden to -\fB0\fR then \fBhz\fR will instead be \fB100\fR; the number of ticks per -quantum must then be decreased to maintain the same length of quantum in -absolute time. -.RE - -.sp -.LP -An administrator can affect the behavior of the real-time portion of the -scheduler by reconfiguring the \fBrt_dptbl\fR. There are two methods available -for doing this: reconfigure with a loadable module at boot-time or by using -\fBdispadmin\fR(1M) at run-time. -.SS "rt_dptbl Loadable Module" -The \fBrt_dptbl\fR can be reconfigured with a loadable module which contains a -new real time dispatch table. The module containing the dispatch table is -separate from the RT loadable module which contains the rest of the real time -software. This is the only method that can be used to change the number of real -time priority levels or the set of global scheduling priorities used by the -real time class. The relevant procedure and source code is described in the -Examples section. -.SS "dispadmin Configuration File" -The \fBrt_quantum\fR values in the \fBrt_dptbl\fR can be examined and modified -on a running system using the \fBdispadmin\fR(1M) command. Invoking -\fBdispadmin\fR for the real-time class allows the administrator to retrieve -the current \fBrt_dptbl\fR configuration from the kernel's in-core table, or -overwrite the in-core table with values from a configuration file. The -configuration file used for input to \fBdispadmin\fR must conform to the -specific format described below. -.sp -.LP -Blank lines are ignored and any part of a line to the right of a \fI#\fR symbol -is treated as a comment. The first non-blank, non-comment line must indicate -the resolution to be used for interpreting the time quantum values. The -resolution is specified as -.sp -.in +2 -.nf -RES=\fIres\fR -.fi -.in -2 - -.sp -.LP -where \fIres\fR is a positive integer between 1 and 1,000,000,000 inclusive and -the resolution used is the reciprocal of \fIres\fR in seconds. (For example, -\fBRES=1000\fR specifies millisecond resolution.) Although very fine -(nanosecond) resolution may be specified, the time quantum lengths are rounded -up to the next integral multiple of the system clock's resolution. -.sp -.LP -The remaining lines in the file are used to specify the \fBrt_quantum\fR values -for each of the real-time priority levels. The first line specifies the quantum -for real-time level 0, the second line specifies the quantum for real-time -level 1. There must be exactly one line for each configured real-time priority -level. Each \fBrt_quantum\fR entry must be either a positive integer specifying -the desired time quantum (in the resolution given by \fIres\fR), or the value --2 indicating an infinite time quantum for that level. -.SH EXAMPLES -\fBExample 1 \fRA Sample \fBdispadmin\fR Configuration File -.sp -.LP -The following excerpt from a \fBdispadmin\fR configuration file illustrates the -format. Note that for each line specifying a time quantum there is a comment -indicating the corresponding priority level. These level numbers indicate -priority within the real-time class, and the mapping between these real-time -priorities and the corresponding global scheduling priorities is determined by -the configuration specified in the \fBRT_DPTBL\fR loadable module. The level -numbers are strictly for the convenience of the administrator reading the file -and, as with any comment, they are ignored by \fBdispadmin\fR on input. -\fBdispadmin\fR assumes that the lines in the file are ordered by consecutive, -increasing priority level (from 0 to the maximum configured real-time -priority). The level numbers in the comments should normally agree with this -ordering; if for some reason they don't, however, \fBdispadmin\fR is -unaffected. - -.sp -.in +2 -.nf -# Real-Time Dispatcher Configuration File -RES=1000 - -# TIME QUANTUM PRIORITY -# (rt_quantum)LEVEL -100# 0 -100# 1 -100# 2 -100# 3 -100# 4 -100# 5 -90 # 6 -90 # 7 -\&.. . -\&.. . -\&.. . -10# 58 -10# 59 -.fi -.in -2 - -.LP -\fBExample 2 \fRReplacing The rt_dptbl Loadable Module -.sp -.LP -In order to change the size of the real time dispatch table, the loadable -module which contains the dispatch table information will have to be built. It -is recommended that you save the existing module before using the following -procedure. - -.RS +4 -.TP -1. -Place the dispatch table code shown below in a file called \fBrt_dptbl.c\fR -An example of an \fBrt_dptbl.c\fR file follows. -.RE -.RS +4 -.TP -2. -Compile the code using the given compilation and link lines supplied. -.sp -.in +2 -.nf -cc -c -0 -D_KERNEL rt_dptbl.c -ld -r -o RT_DPTBL rt_dptbl.o -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -3. -Copy the current dispatch table in \fB/usr/kernel/sched\fR to -\fBRT_DPTBL.bak\fR. -.RE -.RS +4 -.TP -4. -Replace the current \fBRT_DPTBL\fR in \fB/usr/kernel/sched\fR. -.RE -.RS +4 -.TP -5. -You will have to make changes in the \fB/etc/system\fR file to reflect the -changes to the sizes of the tables. See \fBsystem\fR(4). The \fBrt_maxpri\fR -variable may need changing. The syntax for setting this is: -.sp -.in +2 -.nf -set RT:rt_maxpri=(class-specific value for maximum \e - real-time priority) -.fi -.in -2 - -.RE -.RS +4 -.TP -6. -Reboot the system to use the new dispatch table. -.RE -.sp -.LP -Great care should be used in replacing the dispatch table using this method. If -you don't get it right, the system may not behave properly. - -.sp -.LP -The following is an example of a \fBrt_dptbl.c\fR file used for building the -new \fBrt_dptbl\fR. - -.sp -.in +2 -.nf -/* BEGIN rt_dptbl.c */ -#include <sys/proc.h> -#include <sys/priocntl.h> -#include <sys/class.h> -#include <sys/disp.h> -#include <sys/rt.h> -#include <sys/rtpriocntl.h> -/* - * This is the loadable module wrapper. - */ -#include <sys/modctl.h> -extern struct mod_ops mod_miscops; -/* - * Module linkage information for the kernel. - */ -static struct modlmisc modlmisc = { - &mod_miscops, "realtime dispatch table" -}; -static struct modlinkage modlinkage = { - MODREV_1, &modlmisc, 0 -}; -_init() -{ - return (mod_install(&modlinkage)); -} -_info (struct modinfo *modinfop) -{ - return (mod_info(&modlinkage, modinfop)); -} -rtdpent_t config_rt_dptbl[] = { - -/* prilevel Time quantum */ - -100,100, -101,100, -102,100, -103,100, -104,100, -105,100, -106,100, -107,100, -108,100, -109,100, -110,80, -111,80, -112,80, -113,80, -114,80, -115,80, -116,80, -117,80, -118,80, -119,80, -120,60, -121,60, -122,60, -123,60, -124,60, -125,60, -126,60, -127,60, -128,60, -129,60, -130,40, -131,40, -132,40, -133,40, -134,40, -135,40, -136,40, -137,40, -138,40, -139,40, -140,20, -141,20, -142,20, -143,20, -144,20, -145,20, -146,20, -147,20, -148,20, -149,20, -150,10, -151,10, -152,10, -153,10, -154,10, -155,10, -156,10, -157,10, -158,10, -159,10, - -}; -/* - * Return the address of config_rt_dptbl - */ rtdpent_t * - rt_getdptbl() -{ - return (config_rt_dptbl); -} -.fi -.in -2 - -.SH SEE ALSO -\fBpriocntl\fR(1), \fBdispadmin\fR(1M), \fBpriocntl\fR(2), \fBsystem\fR(4) -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.sp -.LP - \fIProgramming Interfaces Guide\fR diff --git a/usr/src/man/man4/sasl_appname.conf.4 b/usr/src/man/man4/sasl_appname.conf.4 deleted file mode 100644 index fb2a643dad..0000000000 --- a/usr/src/man/man4/sasl_appname.conf.4 +++ /dev/null @@ -1,170 +0,0 @@ -'\" te -.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved. -.\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 SASL_APPNAME.CONF 4 "Oct 14, 2003" -.SH NAME -sasl_appname.conf \- SASL options and configuration file -.SH SYNOPSIS -.LP -.nf -/etc/sasl/\fIappname\fR\fB\&.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fB/etc/sasl/\fIappname\fR.conf\fR file is a user-supplied configuration -file that supports user set options for server applications. -.sp -.LP -You can modify the behavior of \fBlibsasl\fR and its plug-ins for server -applications by specifying option values in \fB/etc/sasl/\fIappname\fR.conf\fR -file, where \fIappname\fR is the application defined name of the application. -For \fBsendmail\fR, the file would be \fB/etc/sasl/Sendmail.conf\fR. See your -application documentation for information on the application name. -.sp -.LP -Options that you set in a \fB\fIappname\fR.conf\fR file do not override SASL -options specified by the application itself. -.sp -.LP -The format for each option setting is: -.sp -.in +2 -.nf -option_name:value. -.fi -.in -2 - -.sp -.LP -You can comment lines in the file by using a leading #. -.sp -.LP -The SASL library supports the following options for server applications: -.sp -.ne 2 -.na -\fB\fBauto_transition\fR\fR -.ad -.RS 25n -When set to \fByes\fR, plain users and login plug-ins are automatically -transitioned to other mechanisms when they do a successful plaintext -authentication. The default value for \fBauto_transition\fR is \fBno\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBauxprop_plugin\fR\fR -.ad -.RS 25n -A space-separated list of names of auxiliary property plug-ins to use. By -default, SASL will use or query all available auxiliary property plug-ins. -.RE - -.sp -.ne 2 -.na -\fB\fBcanon_user_plugin\fR\fR -.ad -.RS 25n -The name of the canonical user plug-in to use. By default, the value of -\fBcanon_user_plugin\fR is \fBINTERNAL\fR, to indicated the use of built-in -plug-ins.. -.RE - -.sp -.ne 2 -.na -\fB\fBlog_level\fR\fR -.ad -.RS 25n -An integer value for the desired level of logging for a server, as defined in -<\fBsasl.h\fR>. This sets the \fBlog_level\fR in the \fBsasl_server_params_t -struct\fR in \fB/usr/include/sasl/saslplug.h\fR. The default value for -\fBlog_level\fR is \fB1\fR to indicate \fBSASL_LOG_ERR\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBmech_list\fR\fR -.ad -.RS 25n -Whitespace separated list of SASL mechanisms to allow, for example, -\fBDIGEST-MD5 GSSAPI\fR. The \fBmech_list\fR option is used to restrict the -mechanisms to a subset of the installed plug-ins. By default, SASL will use all -available mechanisms. -.RE - -.sp -.ne 2 -.na -\fB\fBpw_check\fR\fR -.ad -.RS 25n -Whitespace separated list of mechanisms used to verify passwords that are used -by \fBsasl_checkpass\fR(3SASL). The default value for \fBpw_check\fR is -\fBauxprop\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBreauth_timeout\fR\fR -.ad -.RS 25n -This SASL option is used by the server DIGEST-MD5 plug-in. The value of -\fBreauth_timeout\fR is the length in time (in minutes) that authentication -information will be cached for a fast reauthorization. A value of 0 will -disable reauthorization. The default value of \fBreauth_timeout\fR is 1440 (24 -hours). -.RE - -.sp -.ne 2 -.na -\fB\fBserver_load_mech_list\fR\fR -.ad -.RS 25n -A space separated list of mechanisms to load. If in the process of loading -server plug-ns no desired mechanisms are included in the plug-in, the plug-in -will be unloaded. By default, SASL loads all server plug-ins. -.RE - -.sp -.ne 2 -.na -\fB\fBuser_authid\fR\fR -.ad -.RS 25n -If the value of \fBuser_authid\fR is \fByes\fR, then the GSSAPI will acquire -the client credentials rather than use the default credentials when it creates -the GSS client security context. The default value of \fBuser_authid\fR is -\fBno\fR, whereby SASL uses the default client Kerberos identity. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5) diff --git a/usr/src/man/man4/sbus.4 b/usr/src/man/man4/sbus.4 deleted file mode 100644 index 98cd72a8f9..0000000000 --- a/usr/src/man/man4/sbus.4 +++ /dev/null @@ -1,185 +0,0 @@ -'\" te -.\" Copyright (c) 1999, Sun Microsystems, Inc. -.\" All Rights Reserved -.\" 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 SBUS 4 "Dec 31, 1996" -.SH NAME -sbus \- configuration files for SBus device drivers -.SH DESCRIPTION -.LP -The \fBSBus\fR is a geographically addressed peripheral bus present on many -\fBSPARC\fR hardware platforms. \fBSBus\fR devices are \fIself-identifying\fR -\(em that is to say the \fBSBus\fR card itself provides information to the -system so that it can identify the device driver that needs to be used. The -device usually provides additional information to the system in the form of -name-value pairs that can be retrieved using the \fBDDI\fR property interfaces. -See \fBddi_prop_op\fR(9F) for details. -.sp -.LP -The information is usually derived from a small Forth program stored in the -\fBFCode\fR \fBPROM\fR on the card, so driver configuration files should be -completely unnecessary for these devices. However, on some occasions, drivers -for \fBSBus\fR devices may need to use driver configuration files to augment -the information provided by the \fBSBus\fR card. See \fBdriver.conf\fR(4) for -further details. -.sp -.LP -When they are needed, configuration files for \fBSBus\fR device drivers should -identify the parent bus driver implicitly using the \fIclass\fR keyword. This -removes the dependency on the particular bus driver involved since this may be -named differently on different platforms. -.sp -.LP -All bus drivers of class \fBsbus\fR recognise the following properties: -.sp -.ne 2 -.na -\fB\fBreg\fR\fR -.ad -.RS 14n -An arbitrary length array where each element of the array consists of a 3-tuple -of integers. Each array element describes a logically contiguous mappable -resource on the \fBSBus.\fR -.sp -The first integer of each tuple specifies the slot number the card is plugged -into. The second integer of each 3-tuple specifies the offset in the slot -address space identified by the first element. The third integer of each -3-tuple specifies the size in bytes of the mappable resource. -.sp -The driver can refer to the elements of this array by index, and construct -kernel mappings to these addresses using \fBddi_map_regs\fR(9F). The index into -the array is passed as the \fIrnumber\fR argument of \fBddi_map_regs()\fR. -.sp -You can use the \fBddi_get*\fR and \fBddi_put*\fR family of functions to access -register space from a high-level interrupt context. -.RE - -.sp -.ne 2 -.na -\fB\fBinterrupts\fR\fR -.ad -.RS 14n -An arbitrary length array where each element of the array consists of a single -integer. Each array element describes a possible \fBSBus\fR interrupt level -that the device might generate. -.sp -The driver can refer to the elements of this array by index, and register -interrupt handlers with the system using \fBddi_add_intr\fR(9F). The index into -the array is passed as the \fIinumber\fR argument of \fBddi_add_intr()\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBregisters\fR\fR -.ad -.RS 14n -An arbitrary length array where each element of the array consists of a 3-tuple -of integers. Each array element describes a logically contiguous mappable -resource on the \fBSBus.\fR -.sp -The first integer of each tuple should be set to \fB\(mi1\fR, specifying that -any SBus slot may be matched. The second integer of each 3-tuple specifies the -offset in the slot address space identified by the first element. The third -integer of each 3-tuple specifies the size in bytes of the mappable resource. -.sp -The \fBregisters\fR property can only be used to augment an incompletely -specified \fBreg\fR property with information from a driver configuration file. -It may only be specified in a driver configuration file. -.RE - -.sp -.LP -All \fBSBus\fR devices must provide \fBreg\fR properties to the system. The -first two integer elements of the \fBreg\fR property are used to construct the -address part of the device name under \fB/devices\fR. -.sp -.LP -Only devices that generate interrupts need to provide \fBinterrupts\fR -properties. -.sp -.LP -Occasionally, it may be necessary to override or augment the configuration -information supplied by the \fBSBus\fR device. This can be achieved by writing -a driver configuration file that describes a prototype device information -(devinfo) node specification, containing the additional properties required. -.sp -.LP -For the system to merge the information, certain conditions must be met. First, -the \fBname\fR property must be the same. Second, either the first two integers -(slot number and offset) of the two \fBreg\fR properties must be the same, or -the second integer (offset) of the \fBreg\fR and \fBregisters\fR properties -must be the same. -.sp -.LP -In the event that the \fBSBus\fR card has no \fBreg\fR property at all, the -self-identifying information cannot be used, so all the details of the card -must be specified in a driver configuration file. -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample configuration file. -.sp -.LP -Here is a configuration file for an \fBSBus\fR card called \fBSUNW,netboard\fR. -The card already has a simple \fBFCode\fR \fBPROM\fR that creates \fBname\fR -and \fBreg\fR properties, and will have a complete set of properties for normal -use once the driver and firmware is complete. - -.sp -.LP -In this example, we want to augment the properties given to us by the firmware. -We use the same \fBname\fR property, and use the \fBregisters\fR property to -match the firmware \fBreg\fR property. That way we don't have to worry about -which slot the card is really plugged into. - -.sp -.LP -We want to add an \fBinterrupts\fR property while we are developing the -firmware and driver so that we can start to experiment with interrupts. The -device can generate interrupts at \fBSBus\fR level 3. Additionally, we want to -set a \fBdebug-level\fR property to 4. - -.sp -.in +2 -.nf -# -# Copyright (c) 1992, by Sun Microsystems, Inc. -#ident "@(#)SUNW,netboard.conf 1.4 92/03/10 SMI" -# -name="SUNW,netboard" class="sbus" - registers=-1,0x40000,64,-1,0x80000,1024 - interrupts=3 debug-level=4; -.fi -.in -2 -.sp - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture SPARC -.TE - -.SH SEE ALSO -.LP -\fBdriver.conf\fR(4), \fBattributes\fR(5), \fBddi_add_intr\fR(9F), -\fBddi_map_regs\fR(9F), \fBddi_prop_op\fR(9F) -.sp -.LP -\fIWriting Device Drivers\fR -.SH WARNINGS -.LP -The wildcarding mechanism of the \fBregisters\fR property matches every -instance of the particular device attached to the system. This may not always -be what is wanted. diff --git a/usr/src/man/man4/scsi.4 b/usr/src/man/man4/scsi.4 deleted file mode 100644 index 76346a4d0a..0000000000 --- a/usr/src/man/man4/scsi.4 +++ /dev/null @@ -1,344 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved -.\" 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 SCSI 4 "May 30, 2008" -.SH NAME -scsi \- configuration files for SCSI target drivers -.SH DESCRIPTION -The architecture of the illumos \fBSCSI\fR subsystem distinguishes two types of -device drivers: \fBSCSI\fR target drivers, and \fBSCSI\fR host adapter drivers. -Target drivers like \fBsd\fR(7D) and \fBst\fR(7D) manage the device on the -other end of the \fBSCSI\fR bus. Host adapter drivers manage the \fBSCSI\fR bus -on behalf of all the devices that share it. -.sp -.LP -Drivers for host adapters provide a common set of interfaces for target -drivers. These interfaces comprise the Sun Common \fBSCSI\fR Architecture ( -\fBSCSA)\fR which are documented as part of the illumos DDI/DKI. See -\fBscsi_ifgetcap\fR(9F), \fBscsi_init_pkt\fR(9F), and \fBscsi_transport\fR(9F) -for further details of these, and associated routines. -.sp -.LP -Depending on the interconnect (transport), SCSI target devices are either -self-identifying or rely on \fBdriver.conf\fR(4) entries to be recognized by -the system. For self-identifying target devices the driver binding is chosen -based on the IEEE-1275 like 'compatible' forms of the target devices. Currently -the Fibre Channel interconnects, \fBfcp\fR(7D), \fBifp\fR(7D), -\fBscsi_vhci\fR(7D), \fBsf\fR(7D), and the SATA framework drivers (see -\fBsata\fR(7D)) are self-identifying. You must specify other possible -interconnects target devices by using the target driver \fBdriver.conf\fR(4) -configuration files. -.SS "Self-Identifying" -Host adapter drivers of class scsi-self-identifying that dynamically create -self-identifying target device children establish a \fBcompatible\fR property -on each child. The compatible property is an ordered array of strings, each -string is a compatible \fBform\fR. High precedence forms are defined first. For -a particular device, the highest precedence form that has an established driver -alias selects the driver for the device. Driver associations to compatible -forms, called aliases, are administered by way of \fBadd_drv\fR(1M), -\fBupdate_drv\fR(1M), and \fBrem_drv\fR(1M) utilities. -.sp -.LP -The forms for self-identifying SCSI target devices are derived from the SCSI -target device's INQUIRY data. A diverse set of forms is defined, allowing for -flexibility in binding. -.sp -.LP -From the SCSI INQUIRY data, three types of information are extracted: -scsi_dtype, flag bits, and SCSI_ASCII vendor product revision. -.sp -.LP -The scsi_dtype is the first component of most forms. It is represented as two -hex digits. For nodes that represent embedded secondary functions, such as an -embedded enclosure service or media changer, additional forms are generated -that contain the dtype of the secondary function followed by the dtype of the -device in which the secondary function is embedded. -.sp -.LP -For forms that use flag bits, all applicable flags are concatenated (in -alphabetical order) into a single flags string. Removable media is represented -by a flag. For forms that use the SCSI_ASCII INQUIRY vendor, product, and -revision fields, a one-way conversion algorithm translates SCSI_ASCII to a IEEE -1275 compatible string. -.sp -.LP -It is possible that a device might change the INQUIRY data it returns over time -as a result of a device initialization sequence or in response to out-of-band -management. A device node's compatible property is based on the INQUIRY data -when the device node was created. -.sp -.LP -The following forms, in high to low precedence order, are defined for SCSI -target device nodes. -.sp -.in +2 -.nf -scsiclass,DDEEFFF.vVVVVVVVV.pPPPPPPPPPPPPPPPP.rRRRR (1 *1&2) -scsiclass,DDEE.vVVVVVVVV.pPPPPPPPPPPPPPPPP.rRRRR (2 *1) -scsiclass,DDFFF.vVVVVVVVV.pPPPPPPPPPPPPPPPP.rRRRR (3 *2) -scsiclass,DD.vVVVVVVVV.pPPPPPPPPPPPPPPPP.rRRRR (4) -scsiclass,DDEEFFF.vVVVVVVVV.pPPPPPPPPPPPPPPPP (5 *1&2) -scsiclass,DDEE.vVVVVVVVV.pPPPPPPPPPPPPPPPP (6 *1) -scsiclass,DDFFF.vVVVVVVVV.pPPPPPPPPPPPPPPPP (7 *2) -scsiclass,DD.vVVVVVVVV.pPPPPPPPPPPPPPPPP (8) -scsiclass,DDEEFFF (9 *1&2) -scsiclass,DDEE (10 *1) -scsiclass,DDFFF (11 *2) -scsiclass,DD (12) -scsiclass (13) - *1 only produced on a secondary function node - *2 only produced on a node with flags -.fi -.in -2 - -.sp -.LP -where: -.sp -.ne 2 -.na -\fB\fBv\fR\fR -.ad -.RS 20n -Is the letter \fBv\fR. Denotes the beginning of \fBVVVVVVVV\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBVVVVVVVV\fR\fR -.ad -.RS 20n -Translated scsi_vendor: SCSI standard INQUIRY data "Vendor identification" -SCSI_ASCII field (bytes 8-15). -.RE - -.sp -.ne 2 -.na -\fB\fBp\fR\fR -.ad -.RS 20n -Is the letter \fBp\fR. Denotes the beginning of \fBPPPPPPPPPPPPPPPP\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBPPPPPPPPPPPPPPPP\fR\fR -.ad -.RS 20n -Translated scsi_product: SCSI standard INQUIRY data "Product identification" -SCSI_ASCII field (bytes 16-31). -.RE - -.sp -.ne 2 -.na -\fB\fBr\fR\fR -.ad -.RS 20n -Is the letter \fBr\fR. Denotes the beginning of \fBRRRR\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBRRRR\fR\fR -.ad -.RS 20n -Translated scsi_revision: SCSI standard INQUIRY data "Product revision level" -SCSI_ASCII field (bytes 32-35). -.RE - -.sp -.ne 2 -.na -\fB\fBDD\fR\fR -.ad -.RS 20n -Is a two digit ASCII hexadecimal number. The value of the two digits is based -one the SCSI "Peripheral device type" command set associated with the node. On -a primary node this is the scsi_dtype of the primary command set; on a -secondary node this is the \fBscsi_dtype\fR associated with the embedded -function command set. -.RE - -.sp -.ne 2 -.na -\fB\fBEE\fR\fR -.ad -.RS 20n -Same encoding used for \fBDD\fR. This form is only generated on secondary -function nodes. The \fBDD\fR function is embedded in an \fBEE\fR device. -.RE - -.sp -.ne 2 -.na -\fB\fBFFF\fR\fR -.ad -.RS 20n -Concatenation, in alphabetical order, of the flag characters below. The -following flag characters are defined: -.sp -.ne 2 -.na -\fBR\fR -.ad -.RS 5n -Removable media: Used when \fBscsi_rmb\fR is set -.RE - -Forms using \fBFFF\fR are only be generated if there are applicable flag -characters. -.RE - -.sp -.LP -illumos might create additional \fBcompatible\fR forms not described. These -forms are for illumos internal use only. Any additional use of these forms is -discouraged. Future releases of illumos might not produce these forms. -.SS "driver.conf" -Configuration files for \fBSCSI\fR target drivers should identify the host -adapter driver implicitly using the \fIclass\fR keyword to remove any -dependency on the particular host adapter involved. -.sp -.LP -All host adapter drivers of class \fBscsi\fR recognize the following -properties: -.sp -.ne 2 -.na -\fB\fBtarget\fR\fR -.ad -.RS 10n -Integer-valued \fBSCSI\fR target identifier that this driver claims. -.RE - -.sp -.ne 2 -.na -\fB\fBlun\fR\fR -.ad -.RS 10n -Integer-valued \fBSCSI\fR logical unit number ( \fBLUN)\fR that this driver -claims. -.RE - -.sp -.LP -All \fBSCSI\fR target driver configuration file device definitions except stub -device definitions for discovery of \fBdevid\fR must provide target and -\fBlun\fR properties. These properties are used to construct the address part -of the device name under \fB/devices\fR. The stub device definitions for -discovery of \fBdevid\fR must be able to specify or imply the host adapter -drivers that might have children that bind to the target driver. So all SCSI -target driver configuration file stub device definitions must be defined by -property class or parent. -.sp -.LP -The \fBSCSI\fR target driver configuration files shipped with illumos have -entries for \fBLUN\fR \fB0\fR only. For devices that support other \fBLUNs,\fR -such as some \fBCD\fR changers, the system administrator can edit the driver -configuration file to add entries for other \fBLUNs.\fR -.SH EXAMPLES -\fBExample 1 \fRAn Example Configuration File for a SCSI Target Driver -.sp -.LP -The following is an example configuration file for a SCSI target driver called -\fBtoaster.conf\fR. - -.sp -.in +2 -.nf -# -# Copyright (c) 1992, by Sun Microsystems, Inc. -# -#ident "@(#)toaster.conf 1.2 92/05/12 SMI" -name="toaster" class="scsi" target=4 lun=0; -.fi -.in -2 -.sp - -.sp -.LP -Add the following lines to \fBsd.conf\fR for a six- \fBCD\fR changer on -\fBtarget 3\fR, with \fBLUNs\fR \fB0\fR to \fB5\fR. - -.sp -.in +2 -.nf -name="sd" class="scsi" target=3 lun=1; -name="sd" class="scsi" target=3 lun=2; -name="sd" class="scsi" target=3 lun=3; -name="sd" class="scsi" target=3 lun=4; -name="sd" class="scsi" target=3 lun=5; -.fi -.in -2 -.sp - -.sp -.LP -It is not necessary to add the line for \fBLUN\fR \fB0\fR, as it already exists -in the file shipped with illumos. - -.LP -\fBExample 2 \fRA Stub Device Definition of \fBsd.conf\fR -.sp -.LP -The following line is a stub device definition which implies the host adapter -drivers of class scsi-self-identifying might have children that bind to the -\fBsd\fR(7D) driver: - -.sp -.in +2 -.nf -name="sd" class="scsi-self-identifying"; -.fi -.in -2 -.sp - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -\fBadd_drv\fR(1M), \fBrem_drv\fR(1M), \fBupdate_drv\fR(1M), -\fBdriver.conf\fR(4), \fBattributes\fR(5), \fBfcp\fR(7D), \fBifp\fR(7D), -\fBsata\fR(7D), \fBscsi_vhci\fR(7D), \fBsd\fR(7D), \fBsf\fR(7D), \fBst\fR(7D), -\fBscsi_ifgetcap\fR(9F), \fBscsi_init_pkt\fR(9F), \fBscsi_transport\fR(9F) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIANS X3T9.2/82-2 SMALL COMPUTER SYSTEM INTERFACE (SCSI-1)\fR -.sp -.LP -\fIANS X3T9.2/375D Small Computer System Interface - 2 (SCSI-2)\fR -.sp -.LP -\fIANS X3T10/994D SCSI-3 Architecture Model (SAM)\fR -.sp -.LP -\fIIEEE 1275 SCSI Target Device Binding\fR -.SH NOTES -With \fBdriver.conf\fR(4) configuration, you need to ensure that the -\fBtarget\fR and \fBlun\fR values claimed by your target driver do not conflict -with existing target drivers on the system. For example, if the target is a -direct access device, the standard \fBsd.conf\fR file usually makes \fBsd\fR -claim it before any other driver has a chance to probe it. diff --git a/usr/src/man/man4/securenets.4 b/usr/src/man/man4/securenets.4 deleted file mode 100644 index 825b72f835..0000000000 --- a/usr/src/man/man4/securenets.4 +++ /dev/null @@ -1,174 +0,0 @@ -'\" te -.\" Copyright (C) 2000, Sun Microsystems, -.\" Inc. All Rights Reserved -.\" 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 SECURENETS 4 "May 16, 2020" -.SH NAME -securenets \- configuration file for NIS security -.SH SYNOPSIS -.nf -\fB/var/yp/securenets\fR -.fi - -.SH DESCRIPTION -The \fB/var/yp/securenets\fR file defines the networks or hosts which are -allowed access to information by the Network Information Service ("\fBNIS\fR"). -.sp -.LP -The format of the file is as follows: -.RS +4 -.TP -.ie t \(bu -.el o -Lines beginning with the ``#'' character are treated as comments. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Otherwise, each line contains two fields separated by white space. The first -field is a netmask, the second a network. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The netmask field may be either \fB255.255.255.255\fR (IPv4), -\fBffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff\fR (IPv6) , or the string ``host'' -indicating that the second field is a specific host to be allowed access. -.RE -.sp -.LP -Both \fBypserv\fR(1M) and \fBypxfrd\fR(1M) use the \fB/var/yp/securenets\fR -file. The file is read when the \fBypserv\fR(1M) and \fBypxfrd\fR(1M) daemons -begin. If \fB/var/yp/securenets\fR is present, \fBypserv\fR(1M) and -\fBypxfrd\fR(1M) respond only to \fBIP\fR addresses in the range given. In -order for a change in the \fB/var/yp/securenets\fR file to take effect, you -must kill and restart any active daemons using \fBypstop\fR(1M) and -\fBypstart\fR(1M). -.sp -.LP -An important thing to note for all the examples below is that the server must -be allowed to access itself. You accomplish this either by the server being -part of a subnet that is allowed to access the server, or by adding an -individual entry, as the following: -.sp -.in +2 -.nf -hosts 127.0.0.1 -.fi -.in -2 -.sp - -.SH EXAMPLES -\fBExample 1 \fRAccess for Individual Entries -.sp -.LP -If individual machines are to be give access, the entry could be: - -.sp -.in +2 -.nf -255.255.255.255 192.9.1.20 -.fi -.in -2 -.sp - -.sp -.LP -or - -.sp -.in +2 -.nf -host 192.0.1.20 -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRAccess for a Class C Network -.sp -.LP -If access is to be given to an entire class C network, the entry could be: - -.sp -.in +2 -.nf -255.255.255.0 192.9.1.0 -.fi -.in -2 -.sp - -.LP -\fBExample 3 \fRAccess for a Class B Network -.sp -.LP -The entry for access to a class B network could be: - -.sp -.in +2 -.nf -255.255.0.0 9.9.0.0 -.fi -.in -2 -.sp - -.LP -\fBExample 4 \fRAccess for an Individual IPv6 Address -.sp -.LP -Similarly, to allow access for an individual IPv6 address: - -.sp -.in +2 -.nf -ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff fec0::111:abba:ace0:fba5e:1 -.fi -.in -2 -.sp - -.sp -.LP -or - -.sp -.in +2 -.nf -host fec0::111:abba:ace0:fba5e:1 -.fi -.in -2 -.sp - -.LP -\fBExample 5 \fRAccess for all IPv6 Addresses Starting with fe80 -.sp -.LP -To allow access for all IPv6 addresses starting with fe80: - -.sp -.in +2 -.nf -ffff:: fe80:: -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/var/yp/securenets\fR\fR -.ad -.RS 22n -Configuration file for \fBNIS\fR security. -.RE - -.SH SEE ALSO -\fBypserv\fR(1M), \fBypstart\fR(1M), \fBypstop\fR(1M), \fBypxfrd\fR(1M) -.SH NOTES -The Network Information Service (NIS) was formerly known as Sun Yellow Pages -(YP). The functionality of the two remains the same; only the name has -changed. The name Yellow Pages is a registered trademark in the United Kingdom -of British Telecommunications plc, and may not be used without permission. diff --git a/usr/src/man/man4/sendmail.4 b/usr/src/man/man4/sendmail.4 deleted file mode 100644 index 917bd8d5c4..0000000000 --- a/usr/src/man/man4/sendmail.4 +++ /dev/null @@ -1,295 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 SENDMAIL 4 "May 13, 2017" -.SH NAME -sendmail, sendmail.cf, submit.cf \- sendmail configuration files -.SH SYNOPSIS -.LP -.nf -\fB/etc/mail/sendmail.cf\fR -.fi - -.LP -.nf -\fB/etc/mail/submit.cf\fR -.fi - -.SH DESCRIPTION -.LP -The \fBsendmail.cf\fR and \fBsubmit.cf\fR files are the configuration files for -\fBsendmail\fR(1M). Starting with version 8.12 of \fBsendmail\fR, which was -shipped with version 9 of the Solaris operating system, two configuration files -are used for submission and transmission of mail, instead of only -\fBsendmail.cf\fR, as before. These are: -.sp -.ne 2 -.na -\fB\fBsendmail.cf\fR\fR -.ad -.RS 15n -Remains the principal \fBsendmail\fR configuration file. Used for the Mail -Transmission Agent (MTA). -.RE - -.sp -.ne 2 -.na -\fB\fBsubmit.cf\fR\fR -.ad -.RS 15n -Used for the Mail Submission Program (MSP). The MSP is used to submit mail -messages. Unlike the MTA, it does not run as an SMTP daemon. -.RE - -.sp -.LP -The MSP does not require root privileges, thus the two-file model provides -better security than the pre-\fBsendmail\fR 8.12 model, in which the MSP ran as -a daemon and required root privileges. -.sp -.LP -In the default \fBsendmail\fR configuration, \fBsendmail\fR uses -\fBsubmit.cf\fR, as indicated in \fBps\fR(1) output. In \fBps\fR output, you -will observe two \fBsendmail\fR invocations, such as the ones below: -.sp -.in +2 -.nf -/usr/lib/sendmail -Ac -q15m -/usr/lib/sendmail -bd -q15m -.fi -.in -2 - -.sp -.LP -The first indicates the use of \fBsubmit.cf\fR, with the client queue -(\fB/var/spool/clientmqueue\fR) being checked\(emand, if needed, -flushed\(emevery 15 minutes. The second invocation runs \fBsendmail\fR as a -daemon, waiting for incoming SMTP connections. -.sp -.LP -As shipped, \fBsendmail.cf\fR and, in particular, \fBsubmit.cf\fR, are -appropriate for most environments. Where a knowledgeable system administrator -needs to make a change, he should use the following procedures. -.sp -.LP -For \fBsendmail.cf\fR: -.RS +4 -.TP -1. -Change directories to the directory that contains the source files for the -configuration files. -.sp -.in +2 -.nf -# \fBcd /etc/mail/cf/cf\fR -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -2. -Create a copy of the \fBsendmail\fR file for your system. -.sp -.in +2 -.nf -# \fBcp sendmail.mc `hostname`.mc\fR -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -3. -Edit \fB`hostname`.mc\fR. Make changes suitable for your system and -environment. -.RE -.RS +4 -.TP -4. -Run \fBmake\fR to generate the configuration file. -.sp -.in +2 -.nf -# \fB/usr/bin/make `hostname`.cf\fR -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -5. -Copy the newly generated file to its correct location. -.sp -.in +2 -.nf -# \fBcp `hostname`.cf /etc/mail/sendmail.cf\fR -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -6. -Restart the \fBsendmail\fR service. -.sp -.in +2 -.nf -# \fBsvcadm restart sendmail\fR -.fi -.in -2 -.sp - -.RE -.sp -.LP -You must restart \fBsendmail\fR for \fBsendmail.cf\fR file changes to take -effect, as indicated in step 6. Steps 4 - 6 can be automated. See \fBAutomated -Rebuilding of Configuration Files\fR below. -.sp -.LP -For \fBsubmit.cf\fR: -.RS +4 -.TP -1. -Change directories to the directory that contains the source files for the -configuration files. -.sp -.in +2 -.nf -# \fBcd /etc/mail/cf/cf\fR -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -2. -Create a copy of the \fBsubmit\fR file for your system. -.sp -.in +2 -.nf -# \fBcp submit.mc submit-`hostname`.mc\fR -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -3. -Edit \fBsubmit-`hostname`.mc\fR. Make changes suitable for your system and -environment. -.RE -.RS +4 -.TP -4. -Run \fBmake\fR to generate the configuration file. -.sp -.in +2 -.nf -# \fB/usr/bin/make submit-`hostname`.cf\fR -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -5. -Copy the newly generated file to its correct location. -.sp -.in +2 -.nf -# \fBcp submit-`hostname`.cf /etc/mail/submit.cf\fR -.fi -.in -2 -.sp - -.RE -.sp -.LP -You do not need to restart \fBsendmail\fR for changes to \fBsubmit.cf\fR to -take effect. Steps 4 and 5 can be automated. See \fBAutomated Rebuilding of -Configuration Files\fR below. -.SS "Enabling Access to Remote Clients" -.LP -The \fBsendmail\fR(1M) man page describes how the \fBconfig/local_only\fR -property can be set to \fBtrue\fR or \fBfalse\fR to disallow or allow, -respectively, access to remote clients for unmodified systems. -.sp -.LP -Setting values for the following properties for the service instance -\fBsvc:/network/smtp:sendmail\fR results in automated (re)building of -configuration files: -.sp -.in +2 -.nf -path_to_sendmail_mc -path_to_submit_mc -.fi -.in -2 -.sp - -.sp -.LP -The values for these properties should be strings which represent the path name -of the \fB\&.mc\fR files referred to in steps 2 and 3 of both procedures above. -Recommended values are: -.sp -.in +2 -.nf -/etc/mail/cf/cf/`hostname`.mc -/etc/mail/cf/cf/submit-`hostname`.mc -.fi -.in -2 -.sp - -.sp -.LP -Each property, if set, results in the corresponding \fB\&.mc\fR file being used -to (re)build the matching \fB\&.cf\fR file when the service is started. -.sp -.LP -These properties persist across updates. To prevent an update -from clobbering your \fB\&.cf\fR file, or renaming it to -\fB\&.cf.old\fR, you can set the desired properties instead. -.SH FILES -.ne 2 -.na -\fB\fB/etc/mail/cf/README\fR\fR -.ad -.RS 23n -Describes \fBsendmail\fR configuration files. -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -.TE - -.SH SEE ALSO -.LP -\fBmake\fR(1S), \fBps\fR(1), \fBsendmail\fR(1M), \fBsvcadm\fR(1M), -\fBattributes\fR(5) -.sp -.LP -\fISystem Administration Guide: Network Services\fR diff --git a/usr/src/man/man4/service_bundle.4 b/usr/src/man/man4/service_bundle.4 deleted file mode 100644 index 5ec1eb7733..0000000000 --- a/usr/src/man/man4/service_bundle.4 +++ /dev/null @@ -1,147 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 SERVICE_BUNDLE 4 "Mar 6, 2009" -.SH NAME -service_bundle \- service manifest file format -.SH SYNOPSIS -.LP -.nf -\fB/usr/share/lib/xml/dtd/service_bundle.dtd.1\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The service management facility, described in \fBsmf\fR(5), utilizes an -XML-based file format to marshal the description of a set of services or -service instances between systems. This file is known as a service bundle. The -primary form of a service bundle is the inventory of services that are provided -by a package, which is called a \fBservice manifest\fR. -.sp -.LP -The DTD describing the \fBservice_bundle\fR is provided at -\fB/usr/share/lib/xml/dtd/service_bundle.dtd.1\fR. The attributes and tags are -fully described in the commented DTD. The services supplied with the operating -system, stored under \fB/var/svc/manifest\fR, provide examples of correctly -formed service descriptions. -.sp -.LP -\fBservice_bundle\fR documents can also use the XML Inclusions (\fBXInclude\fR) -facility to merge multiple documents into one. A \fBservice_bundle\fR document -manipulator must therefore support the functionality defined by the XInclude -specification. -.sp -.LP -A complete service description consists of the following: -.RS +4 -.TP -.ie t \(bu -.el o -A set of properties that identify the service and identify its restarter -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A set of properties that identify each instance -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A set of framework property groups that describe the framework's understanding -of each instance -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A set of method property groups as required by \fBsvc.startd\fR(1M), or by a -delegated restarter -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Additional optional method property groups -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A set of dependency property groups -.RE -.RS +4 -.TP -.ie t \(bu -.el o -An optional group of properties that indicate services to which dependencies on -the described service were added -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A set of application property groups or application-specific typed property -groups containing application configuration data -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A template that describes supporting information about this service, such as a -description, links to documentation, and metadata about property groups and -properties. -.RE -.sp -.LP -The document type definition for the service bundle provides markup to define -each of these aspects of a service description, as well as a number of entities -that identify regular features in describing a service, such as the -\fB<create_default_instance>\fR tag. -.SS "Manifest Handling During Packaging Operations" -.sp -.LP -Service manifests within packages should be identified with the class -\fBmanifest\fR. Class action scripts that install and remove service manifests -are included in the packaging subsystem. When \fBpkgadd\fR(1M) is invoked, the -service manifest is imported. -.sp -.LP -When \fBpkgrm\fR(1M) is invoked, instances in the manifest that are disabled -are deleted. Any services in the manifest with no remaining instances are also -deleted. -.sp -.LP -If the \fB-R\fR option is supplied to \fBpkgadd\fR(1M) or \fBpkgrm\fR(1M), the -actions described in this section are done when the system is next rebooted -with that alternate root path. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBpkgadd\fR(1M), \fBpkgrm\fR(1M), \fBsvcadm\fR(1M), \fBsvccfg\fR(1M), -\fBsvc.startd\fR(1M), \fBlibscf\fR(3LIB), \fBattributes\fR(5), \fBlocale\fR(5), -\fBsmf\fR(5), \fBsmf_method\fR(5), \fBsmf_template\fR(5) -.SH NOTES -.sp -.LP -Nested \fBservice_bundle\fR elements must be of the same type. diff --git a/usr/src/man/man4/service_provider.conf.4 b/usr/src/man/man4/service_provider.conf.4 deleted file mode 100644 index d96d7bcebf..0000000000 --- a/usr/src/man/man4/service_provider.conf.4 +++ /dev/null @@ -1,183 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 SERVICE_PROVIDER.CONF 4 "Jun 18, 2004" -.SH NAME -service_provider.conf \- service provider configuration file -.SH SYNOPSIS -.LP -.nf -\fBservice_provider.conf\fR -.fi - -.SH DESCRIPTION -.LP -\fBservice_provider.conf\fR contains information about the device type that the -service provider supports. This information includes the pathname of the -service provider library, the library version and other library characteristics -that are required by the system administrative command, \fBdatadm\fR(1M). -\fBdatadm\fR(1M) puts this information in the DAT static register file, -\fBdat.conf\fR(4). -.sp -.LP -The \fBdatadm\fR program enumerates each device entry into a list of interface -adapters, that is, interfaces to external network that are available to uDAPL -consumers. This new list of interface adapters is appended to other service -providers' information in the DAT static registry, \fBdat.conf\fR. You can do -this if you invoke the \fBdatadm\fR program with the \fB-a\fR option and the -pathname of the \fBservice_provider.conf\fR file. -.sp -.LP -Each entry in the service_provider.conf is a single line of 7 fields. -.sp -.LP -The following shows the order of the fields in a \fBservice_provider.conf\fR -entry: -.sp -.in +2 -.nf -"\fIdriver_name\fR" "\fIAPI_version\fR" "\fIthreadsafe_library\fR | \e - \fInonthreadsafe_library\fR"\e -"\fIdefault_version\fR | \fInondefault_version\fR" \e - "\fIservice_provider_library_pathname\fR"\e -"\fIservice_provider_version\fR" "\fIservice_provider_instance_data\fR"\e -.fi -.in -2 - -.sp -.LP -The fields are defined as follows: -.sp -.ne 2 -.na -\fB\fIdriver_name\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a driver name in the format of \fBdriver_name\fR=\fIvalue pair\fR, -for example, \fBdriver_name=tavor\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIAPI_version\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the API version of the service provider library: For example, -\fB"u"major.minor\fR is \fBu1.2\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIthreadsafe_library\fR | \fInonthreadsafe_library\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a threadsafe or non-threadsafe library. -.RE - -.sp -.ne 2 -.na -\fB\fIdefault_version\fR | \fInondefault_version\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a default or non-default version of a library. A service provider can -offer several versions of the library. If so, one version is designated as -\fBdefault\fR with the rest as \fBnondefault\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIservice_provider_library_pathname\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the pathname of the library image. -.RE - -.sp -.ne 2 -.na -\fB\fIservice_provider_version\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the version of the service provider. By convention, specify the -company stock symbol as the service provider, followed by major and minor -version numbers, for example, \fBSUNW1.0\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIservice_provider_instance_data\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the service provider instance data. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRUsing a Logical Device Name -.sp -.LP -The following example \fBservice_provider.conf\fR entry uses a logical device -name: - -.sp -.in +2 -.nf -# -# Sample service_provider.conf entry showing an uDAPL 1.2 service -# provider, udapl_tavor.so.1 supporting a device with a driver named -# tavor -driver_name=tavor u1.2 nonthreadsafe default udapl_tavor.so.1 \e - SUNW.1.0 "" -.fi -.in -2 - -.LP -\fBExample 2 \fRUsing a Physical Device Name -.sp -.LP -The following example \fBservice_provider.conf\fR uses a physical device name: - -.sp -.in +2 -.nf -# -# Sample service_provider.conf entry showing an uDAPL 1.2 -# service provider, udapl_tavor.so.1 supporting a device named -# pci15b3,5a44 that can be located under /devices -# -pci15b3,5a44 u1.2 nonthreadsafe default \e - /usr/lib/tavor/udapl_tavor.so.1 SUNWudaplt1.0 "" -.fi -.in -2 - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -Stability Evolving -.TE - -.SH SEE ALSO -.LP -\fBdatadm\fR(1M), \fBdat.conf\fR(4), \fBattributes\fR(5) diff --git a/usr/src/man/man4/services.4 b/usr/src/man/man4/services.4 deleted file mode 100644 index 69b3ee46e0..0000000000 --- a/usr/src/man/man4/services.4 +++ /dev/null @@ -1,93 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1983 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. -.\" Copyright (C) 2000, Sun Microsystems, Inc. All Rights Reserved -.TH SERVICES 4 "Feb 25, 2017" -.SH NAME -services \- Internet services and aliases -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/services\fR -.fi - -.LP -.nf -\fB/etc/services\fR -.fi - -.SH DESCRIPTION -.LP -The \fBservices\fR file is a local source of information regarding each -service available through the Internet. The \fBservices\fR file can be used in -conjunction with or instead of other services sources, including the \fBNIS\fR -map "services.byname". Programs use the -\fBgetservbyname\fR(3SOCKET) routines to access this information. -.sp -.LP -The \fBservices\fR file contains an entry for each service. Each entry has the -form: -.sp -.in +2 -.nf -\fIservice-name port\fR/\fIprotocol aliases\fR -.fi -.in -2 - -.sp -.ne 2 -.na -\fB\fIservice-name\fR\fR -.ad -.RS 17n -This is the official Internet service name. -.RE - -.sp -.ne 2 -.na -\fB\fIport\fR/\fIprotocol\fR\fR -.ad -.RS 17n -This field is composed of the port number and protocol through which the -service is provided, for instance, \fB512/tcp\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIaliases\fR\fR -.ad -.RS 17n -This is a list of alternate names by which the service might be requested. -.RE - -.sp -.LP -Fields can be separated by any number of \fBSPACE\fR and/or \fBTAB\fR -characters. A number sign (\fB#\fR) indicates the beginning of a comment; any -characters that follow the comment character up to the end of the line are not -interpreted by routines which search the file. -.sp -.LP -Service names may contain any printable character other than a field delimiter, -a \fBNEWLINE\fR, or a comment character. -.sp -.LP -Any changes to a port assignment do not affect the actual port registration of -the service. -.SH FILES -.ne 2 -.na -\fB\fB/etc/nsswitch.conf\fR\fR -.ad -.RS 22n -configuration file for name-service switch -.RE - -.SH SEE ALSO -.LP -\fBgetservbyname\fR(3SOCKET), \fBinetd.conf\fR(4), \fBnsswitch.conf\fR(4) -.SH NOTES -.LP -\fB/etc/inet/services\fR is the official SVR4 name of the \fBservices\fR file. -The symbolic link \fB/etc/services\fR exists for \fBBSD\fR compatibility. diff --git a/usr/src/man/man4/shadow.4 b/usr/src/man/man4/shadow.4 deleted file mode 100644 index 9565697eff..0000000000 --- a/usr/src/man/man4/shadow.4 +++ /dev/null @@ -1,219 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 SHADOW 4 "Feb 25, 2017" -.SH NAME -shadow \- shadow password file -.SH DESCRIPTION -.LP -\fB/etc/shadow\fR is an access-restricted ASCII system file that stores users' -encrypted passwords and related information. The shadow file can be used in -conjunction with other shadow sources, including the \fBNIS\fR maps -\fBpasswd.byname\fR and \fBpasswd.byuid\fR. -Programs use the \fBgetspnam\fR(3C) routines to access this information. -.sp -.LP -The fields for each user entry are separated by colons. Each user is separated -from the next by a newline. Unlike the \fB/etc/passwd\fR file, -\fB/etc/shadow\fR does not have general read permission. -.sp -.LP -Each entry in the shadow file has the form: -.sp -.in +2 -.nf -\fIusername\fR:\fIpassword\fR:\fIlastchg\fR:\fImin\fR:\fImax\fR:\fIwarn\fR:\fIinactive\fR:\fIexpire\fR:\fIflag\fR -.fi -.in -2 - -.sp -.LP -The fields are defined as follows: -.sp -.ne 2 -.na -\fB\fIusername\fR\fR -.ad -.RS 12n -The user's login name (UID). -.RE - -.sp -.ne 2 -.na -\fB\fIpassword\fR\fR -.ad -.RS 12n -An encrypted password for the user generated by \fBcrypt\fR(3C), a \fIlock\fR -string to indicate that the login is not accessible, or no string, which shows -that there is no password for the login. -.sp -The lock string is defined as \fB*LK*\fR in the first four characters of the -password field. -.RE - -.sp -.ne 2 -.na -\fB\fIlastchg\fR\fR -.ad -.RS 12n -The number of days between January 1, 1970, and the date that the password was -last modified. The \fIlastchg\fR value is a decimal number, as interpreted by -\fBstrtol\fR(3C). -.RE - -.sp -.ne 2 -.na -\fB\fImin\fR\fR -.ad -.RS 12n -The minimum number of days required between password changes. This field must -be set to 0 or above to enable password aging. -.RE - -.sp -.ne 2 -.na -\fB\fImax\fR\fR -.ad -.RS 12n -The maximum number of days the password is valid. -.RE - -.sp -.ne 2 -.na -\fB\fIwarn\fR\fR -.ad -.RS 12n -The number of days before password expires that the user is warned. -.RE - -.sp -.ne 2 -.na -\fB\fIinactive\fR\fR -.ad -.RS 12n -The number of days of inactivity allowed for that user. This is counted on a -per-machine basis; the information about the last login is taken from the -machine's \fBlastlog\fR file. -.RE - -.sp -.ne 2 -.na -\fB\fIexpire\fR\fR -.ad -.RS 12n -An absolute date expressed as the number of days since the Unix Epoch (January -1, 1970). When this number is reached the login can no longer be used. For -example, an \fIexpire\fR value of \fB13514\fR specifies a login expiration of -January 1, 2007. -.RE - -.sp -.ne 2 -.na -\fB\fIflag\fR\fR -.ad -.RS 12n -Failed login count in low order four bits; remainder reserved for future use, -set to zero. -.RE - -.sp -.LP -A value of \fB-1\fR for \fImin\fR, \fImax\fR, or \fIwarn\fR disables password -aging. -.sp -.LP -The encrypted password consists of at most \fBCRYPT_MAXCIPHERTEXTLEN\fR -characters chosen from a 64-character alphabet (\fB\&.\fR, \fB/\fR, -\fB0\(mi9\fR, \fBA\(miZ\fR, \fBa\(miz\fR). Two additional special characters, -"$" and ",", can also be used and are defined in \fBcrypt\fR(3C). To update -this file, use the \fBpasswd\fR(1), \fBuseradd\fR(1M), \fBusermod\fR(1M), or -\fBuserdel\fR(1M) commands. -.sp -.LP -In order to make system administration manageable, \fB/etc/shadow\fR entries -should appear in exactly the same order as \fB/etc/passwd\fR entries; this -includes ``+'' and ``-'' entries if the \fBcompat\fR source is being used (see -\fBnsswitch.conf\fR(4)). -.sp -.LP -Values for the various time-related fields are interpreted as Greenwich Mean -Time. -.SH FILES -.ne 2 -.na -\fB\fB/etc/shadow\fR\fR -.ad -.RS 22n -shadow password file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/passwd\fR\fR -.ad -.RS 22n -password file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/nsswitch.conf\fR\fR -.ad -.RS 22n -name-service switch configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/var/adm/lastlog\fR\fR -.ad -.RS 22n -time of last login -.RE - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Stable -.TE - -.SH SEE ALSO -.LP -\fBlogin\fR(1), \fBpasswd\fR(1), \fBuseradd\fR(1M), \fBuserdel\fR(1M), -\fBusermod\fR(1M), \fBstrtol\fR(3C), \fBcrypt\fR(3C), \fBcrypt_gensalt\fR(3C), -\fBgetspnam\fR(3C), \fBputspent\fR(3C), \fBnsswitch.conf\fR(4), -\fBpasswd\fR(4), \fBattributes\fR(5), \fBpam_unix_account\fR(5), -\fBpam_unix_auth\fR(5) -.SH NOTES -.LP -If password aging is turned on in any name service the \fIpasswd:\fR line in -the \fB/etc/nsswitch.conf\fR file must have a format specified in the -\fBnsswitch.conf\fR(4) man page. -.sp -.LP -If the \fB/etc/nsswitch.conf\fR passwd policy is not in one of the supported -formats, logins will not be allowed upon password expiration, because the -software does not know how to handle password updates under these conditions. -See \fBnsswitch.conf\fR(4) for additional information. diff --git a/usr/src/man/man4/sharetab.4 b/usr/src/man/man4/sharetab.4 deleted file mode 100644 index 303017ec07..0000000000 --- a/usr/src/man/man4/sharetab.4 +++ /dev/null @@ -1,73 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" 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 SHARETAB 4 "Jul 3, 1990" -.SH NAME -sharetab \- shared file system table -.SH DESCRIPTION -.sp -.LP -\fBsharetab\fR resides in directory \fB/etc/dfs\fR and contains a table of -local resources shared by the \fBshare\fR command. -.sp -.LP -Each line of the file consists of the following fields: -.sp -.LP -\fIpathname resource fstype specific_options description\fR -.sp -.LP -where -.sp -.ne 2 -.na -\fB\fIpathname\fR\fR -.ad -.RS 20n -Indicate the path name of the shared resource. -.RE - -.sp -.ne 2 -.na -\fB\fIresource\fR\fR -.ad -.RS 20n -Indicate the symbolic name by which remote systems can access the resource. -.RE - -.sp -.ne 2 -.na -\fB\fIfstype\fR\fR -.ad -.RS 20n -Indicate the file system type of the shared resource. -.RE - -.sp -.ne 2 -.na -\fB\fIspecific_options\fR\fR -.ad -.RS 20n -Indicate file-system-type-specific options that were given to the \fBshare\fR -command when the resource was shared. -.RE - -.sp -.ne 2 -.na -\fB\fIdescription\fR\fR -.ad -.RS 20n -Describe the shared resource provided by the system administrator when the -resource was shared. -.RE - -.SH SEE ALSO -.sp -.LP -\fBshare\fR(1M) diff --git a/usr/src/man/man4/shells.4 b/usr/src/man/man4/shells.4 deleted file mode 100644 index 342028eef5..0000000000 --- a/usr/src/man/man4/shells.4 +++ /dev/null @@ -1,57 +0,0 @@ -'\" te -.\" Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved. -.\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures -.\" 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 SHELLS 4 "Nov 20, 2007" -.SH NAME -shells \- shell database -.SH SYNOPSIS -.LP -.nf -\fB/etc/shells\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBshells\fR file contains a list of the shells on the system. Applications -use this file to determine whether a shell is valid. See -\fBgetusershell\fR(3C). For each shell a single line should be present, -consisting of the shell's path, relative to root. -.sp -.LP -A hash mark (\fB#\fR) indicates the beginning of a comment; subsequent -characters up to the end of the line are not interpreted by the routines which -search the file. Blank lines are also ignored. -.sp -.LP -The following default shells are used by utilities: \fB/bin/bash\fR, -\fB/bin/csh\fR, \fB/bin/jsh\fR, \fB/bin/ksh\fR, \fB/bin/ksh93\fR, -\fB/bin/pfcsh\fR, \fB/bin/pfksh\fR, \fB/bin/pfsh\fR, \fB/bin/sh\fR, -\fB/bin/tcsh\fR, \fB/bin/zsh\fR, \fB/sbin/jsh\fR, \fB/sbin/sh\fR, -\fB/usr/bin/bash\fR, \fB/usr/bin/csh\fR, \fB/usr/bin/jsh\fR, -\fB/usr/bin/ksh\fR, \fB/usr/bin/ksh93\fR, \fB/usr/bin/pfcsh\fR, -\fB/usr/bin/pfksh\fR, \fB/usr/bin/pfsh\fR, and \fB/usr/bin/sh\fR, -\fB/usr/bin/tcsh\fR, \fB/usr/bin/zsh\fR, and \fB/usr/sfw/bin/zsh\fR. -\fB/etc/shells\fR overrides the default list. -.sp -.LP -Invalid shells in \fB/etc/shells\fR could cause unexpected behavior, such as -being unable to log in by way of \fBftp\fR(1). -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/shells\fR\fR -.ad -.RS 15n -list of shells on system -.RE - -.SH SEE ALSO -.sp -.LP -\fBvipw\fR(1B), \fBftpd\fR(1M), \fBsendmail\fR(1M), \fBgetusershell\fR(3C), -\fBaliases\fR(4) diff --git a/usr/src/man/man4/slp.conf.4 b/usr/src/man/man4/slp.conf.4 deleted file mode 100644 index ecb2e90f0c..0000000000 --- a/usr/src/man/man4/slp.conf.4 +++ /dev/null @@ -1,1149 +0,0 @@ -'\" te -.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 SLP.CONF 4 "Feb 18, 2003" -.SH NAME -slp.conf \- configuration file for Service Location Protocol agents -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/slp.conf\fR -.fi - -.SH DESCRIPTION -.sp -.LP -\fBslp.conf \fR provides all Service Location Protocol ("\fBSLP\fR") agents -with their operational configuration. \fBslpd\fR(1M) reads \fBslp.conf\fR on -startup. Service Agents ("\fBSA\fRs") and User Agents ("\fBUA\fRs") read -\fBslp.conf\fR on invocation of the \fBSA\fR and \fBUA\fR library routines; -configuration parameters are then cached on a per-process basis. All \fBSA\fR's -must use the same set of properties as \fBslpd\fR on the local machine, since -\fBslpd\fR acts as an \fBSA\fR server. -.sp -.LP -The configuration file format consists of a newline-delimited list of zero or -more property definitions. Each property definition corresponds to a particular -configurable \fBSLP\fR, network, or other parameter in one or more of the three -\fBSLP\fR agents. The file format grammar is shown in \fIRFC 2234\fR as -follows: -.sp -.in +2 -.nf -config-file = line-list -line-list = line / line line-list -line = property-line / comment-line -comment-line = ( "#" / ";" ) 1*allchar newline -property-line = property newline -property = tag "=" value-list -tag = prop / prop "." tag -prop = 1*tagchar -value-list = value / value "," value-list -value = int / bool / - "(" value-list ")" / string -int = 1*DIGIT -bool = "true" / "false" / "TRUE" / "FALSE" -newline = CR / ( CRLF ) -string = 1*stringchar -tagchar = DIGIT / ALPHA / tother / escape -tother = %x21-%x2d / %x2f / - %x3a / %x3c-%x40 / - %x5b-%x60 / %7b-%7e - ; i.e., all characters except `.', - ; and `='. -stringchar = DIGIT / ALPHA / sother / escape -sother = %x21-%x29 / %x2a-%x2b / - %x2d-%x2f / %x3a-%x40 / - %x5b-%x60 / %7b-%7e - ; i.e., all characters except `,' -allchar = DIGIT / ALPHA / HTAB / SP -escape = "\e" HEXDIG HEXDIG - ; Used for reserved characters -.fi -.in -2 - -.sp -.LP -The properties fall into one of the following categories: -.RS +4 -.TP -.ie t \(bu -.el o -\fBDA\fR Configuration -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Static Scope Configuration -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Tracing and Logging -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Serialized Proxy Registrations -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Networking Configuration Parameters -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBUA\fR Configuration -.RE -.SS "DA Configuration" -.sp -.LP -The following are configuration properties and their parameters for \fBDA\fRs: -.sp -.ne 2 -.na -\fB\fBnet.slp.isDA\fR\fR -.ad -.RS 24n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Boolean -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fBFalse\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -\fBTrue\fR or \fBFalse\fR -.RE - -A boolean that indicates whether \fBslpd\fR(1M) is to act as a \fBDA\fR. If -\fBFalse\fR, \fBslpd\fR(1M) is not run as a \fBDA\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.DAHeartBeat\fR\fR -.ad -.RS 24n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Integer -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -10800 seconds (3 hours) -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -2000 - 259200000 seconds -.RE - -A 32-bit integer giving the number of seconds for the passive \fBDA\fR -advertisement heartbeat. The default value is 10800 seconds. This property is -ignored if \fBnet.slp.isDA\fR is \fBFalse\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.DAAttributes\fR\fR -.ad -.RS 24n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -List of Strings -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -Unassigned -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -List of Attribute Tag/Value List Pairs -.RE - -A comma-separated list of parenthesized attribute tag/value list pairs that the -\fBDA\fR must advertise in \fBDA\fR advertisements. The property must be in -the \fBSLP\fR attribute list wire format, which requires that you use a -backslash ("\\") to escape reserved characters. See \fIRFC 2608\fR for more -information on reserved characters, or refer to the \fISystem Administration -Guide: Network Services\fR. -.RE - -.SS "Static Scope Configuration" -.sp -.LP -The following properties and their parameters allow you to configure various -aspects of scope and \fBDA\fR handling: -.sp -.ne 2 -.na -\fB\fBnet.slp.useScopes\fR\fR -.ad -.RS 23n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -List of Strings -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fBDefault\fR, for \fBSA\fR and \fBDA\fR; unassigned for \fBUA\fR. -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -List of Strings -.RE - -A list of strings indicating either the scopes that a \fBUA\fR or an \fBSA\fR -is allowed to use when making requests, or the scopes a \fBDA\fR must -support. If not present for the \fBDA\fR and \fBSA\fR, the default scope -\fBDefault\fR is used. If not present for the \fBUA\fR, then the user scoping -model is in force, in which active and passive \fBDA\fR or \fBSA\fR discovery -are used for scope discovery. The scope \fBDefault\fR is used if no other -information is available. If a \fBDA\fR or \fBSA\fR gets another scope in a -request, a \fBSCOPE_NOT_SUPPORTED\fR error is returned, unless the request was -multicast, in which case it is dropped. If a \fBDA\fR receives another scope in -a registration, a \fBSCOPE_NOT_SUPPORTED\fR error will be returned. Unlike -other properties, this property is "read-only", so attempts to change it -programmatically after the configuration file has been read are ignored. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.DAAddresses\fR\fR -.ad -.RS 23n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -List of Strings -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -Unassigned -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -IPv4 addresses or host names -.RE - -A list of \fBIP\fR addresses or \fBDNS\fR-resolvable names that denote -the \fBDA\fRs to use for statically configured \fBUA\fRs and \fBSA\fRs. The -property is read by \fBslpd\fR(1M), and registrations are forwarded to the -\fBDA\fRs. The \fBDA\fRs are provided to \fBUA\fRs upon request. Unlike other -properties, this property is "read-only", so attempts to change it after the -configuration file has been read are ignored. -.sp -The following grammar describes the property: -.sp -.in +2 -.nf -addr-list = addr / addr "," addr-list -addr = fqdn / hostnumber -fqdn = ALPHA / ALPHA *[ anum / "-" ] anum -anum = ALPHA / DIGIT -hostnumber = 1*3DIGIT 3("." 1*3DIGIT) -.fi -.in -2 - -The following is an example using this grammar: -.sp -.in +2 -.nf -sawah,mandi,sambal -.fi -.in -2 - -\fBIP\fR addresses can be used instead of host names in networks where -\fBDNS\fR is not deployed, but network administrators are reminded that using -\fBIP\fR addresses will complicate machine renumbering, since the \fBSLP\fR -configuration property files in statically configured networks will have to be -changed. -.RE - -.SS "Tracing and Logging" -.sp -.LP -These properties direct tracing and logging information to be sent to -\fBsyslogd\fR at the \fBLOG_INFO\fR priority. These properties affect -\fBslpd\fR(1M) only. -.sp -.ne 2 -.na -\fB\fBnet.slp.traceDATraffic\fR\fR -.ad -.RS 26n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Boolean -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fBFalse\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -\fBTrue\fR or \fBFalse\fR -.RE - -Set \fBnet.slp.traceDATraffic\fR to \fBTrue\fR to enable logging of \fBDA\fR -traffic by \fBslpd\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.traceMsg\fR\fR -.ad -.RS 26n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Boolean -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fBFalse\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -\fBTrue\fR or \fBFalse\fR -.RE - -Set \fBnet.slp.traceMsg\fR to \fBTrue\fR to display details about \fBSLP\fR -messages. The fields in all incoming messages and outgoing replies are -printed by \fBslpd\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.traceDrop\fR\fR -.ad -.RS 26n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Boolean -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fBFalse\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -\fBTrue\fR or \fBFalse\fR -.RE - -Set this property to \fBTrue\fR to display details when an \fBSLP\fRmessage is -dropped by \fBslpd\fR for any reason. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.traceReg\fR\fR -.ad -.RS 26n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Boolean -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fBFalse\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -\fBTrue\fR or \fBFalse\fR -.RE - -Set this property to \fBTrue\fR to display the table of service advertisements -when a registration or deregistration is processed by \fBslpd\fR. -.RE - -.SS "Serialized Proxy Registrations" -.sp -.LP -The following properties control reading and writing serialized -registrations. -.sp -.ne 2 -.na -\fB\fBnet.slp.serializedRegURL\fR\fR -.ad -.RS 28n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -String -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -Unassigned -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -Valid \fBURL\fR -.RE - -A string containing a \fBURL\fR pointing to a document, which contains -serialized registrations that should be processed when the \fBslpd\fR starts -up. -.RE - -.SS "Networking Configuration Parameters" -.sp -.LP -The properties that follow allow you to set various network configuration -parameters: -.sp -.ne 2 -.na -\fB\fBnet.slp.isBroadcastOnly\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Boolean -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fBFalse\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -\fBTrue\fR or \fBFalse\fR -.RE - -A boolean that indicates if broadcast should be used instead of multicast. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.multicastTTL\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Positive Integer -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fB255\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -A positive integer from 1 to 255. -.RE - -A positive integer less than or equal to 255 that defines the multicast -\fBTTL\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.DAActiveDiscoveryInterval\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Integer -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -900 seconds (15 minutes) -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -From 300 to 10800 seconds -.RE - -A 16-bit positive integer giving the number of seconds between \fBDA\fR active -discovery queries. The default value is 900 seconds (15 minutes). If the -property is set to zero, active discovery is turned off. This is useful when -the \fBDA\fRs available are explicitly restricted to those obtained from the -\fBnet.slp.DAAddresses\fR property. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.multicastMaximumWait\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Integer -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -15000 milliseconds (15 seconds) -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n - 1000 to 60000 milliseconds -.RE - -A 32-bit integer giving the maximum value for the sum of the -\fBnet.slp.multicastTimeouts\fR values and \fBnet.slp.DADiscoveryTimeouts\fR -values in milliseconds. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.multicastTimeouts\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -List of Integers -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fB3000,3000,3000,3000\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -List of Positive Integers -.RE - -A list of 32-bit integers used as timeouts, in milliseconds, to implement the -multicast convergence algorithm. Each value specifies the time to wait before -sending the next request, or until nothing new has been learned from two -successive requests. In a fast network the aggressive values of -\fB1000,1250,1500,2000,4000\fR allow better performance. The sum of the list -must equal \fBnet.slp.multicastMaximumWait\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.passiveDADetection\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Boolean -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fBTrue\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -\fBTrue\fR or \fBFalse\fR -.RE - -A boolean indicating whether \fBslpd\fR should perform passive \fBDA\fR -detection. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.DADiscoveryTimeouts\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -List of Integers. -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fB2000,2000,2000,2000,3000,4000\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -List of Positive Integers -.RE - -A list of 32-bit integers used as timeouts, in milliseconds, to implement the -multicast convergence algorithm during active \fBDA\fR discovery. Each value -specifies the time to wait before sending the next request, or until nothing -new has been learned from two successive requests. The sum of the list must -equal \fBnet.slp.multicastMaximumWait\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.datagramTimeouts\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -List of Integers -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fB3000,3000,3000\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -List of Positive Integers -.RE - -A list of 32-bit integers used as timeouts, in milliseconds, to implement -unicast datagram transmission to \fBDA\fRs. The \fIn\fRth value gives the time -to block waiting for a reply on the \fIn\fRth try to contact the \fBDA\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.randomWaitBound\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Integer -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -1000 milliseconds (1 second) -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -1000 to 3000 milliseconds -.RE - -Sets the upper bound for calculating the random wait time before attempting to -contact a \fBDA\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.MTU\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Integer -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -1400 -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -128 to 8192 -.RE - -A 16-bit integer that specifies the network packet size, in bytes. The packet -size includes \fBIP\fR and \fBTCP\fR or \fBUDP\fR headers. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.interfaces\fR\fR -.ad -.sp .6 -.RS 4n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -List of Strings -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -Default interface -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -IPv4 addresses or host names -.RE - -List of strings giving the \fBIP\fR addresses or host names of the network -interface cards on which the \fBDA\fR or \fBSA\fR should listen on port 427 for -multicast, unicast \fBUDP\fR, and \fBTCP\fR messages. The default value is -unassigned, indicating that the default network interface card should be used. -An example is: -.sp -.in +2 -.nf -195.42.42.42,195.42.142.1,195.42.120.1 -.fi -.in -2 - -The example machine has three interfaces on which the \fBDA\fR should listen. -Note that if \fBIP\fR addresses are used, the property must be renumbered if -the network is renumbered. -.RE - -.SS "UA Configuration" -.sp -.LP -The following configuration parameters apply to the \fBUA\fR: -.sp -.ne 2 -.na -\fB\fBnet.slp.locale\fR\fR -.ad -.RS 22n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -String -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fBen\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -See \fIRFC 1766\fR for a list of the locale language tag names. -.RE - -A \fIRFC 1766\fR Language Tag for the language locale. Setting this -property causes the property value to become the default locale for -\fBSLP\fR messages. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.maxResults\fR\fR -.ad -.RS 22n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -Integer -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -\fB-1\fR -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -\fB-1\fR, positive integer -.RE - -A 32 bit-integer that specifies the maximum number of results to accumulate and -return for a synchronous request before the timeout, or the maximum number of -results to return through a callback if the request results are reported -asynchronously. Positive integers and \fB-1\fR are legal values. If the value -of \fBnet.slp.maxResults\fR is \fB-1\fR, all results should be returned. -.RE - -.sp -.ne 2 -.na -\fB\fBnet.slp.typeHint\fR\fR -.ad -.RS 22n -.sp -.ne 2 -.na -\fBSetting Type\fR -.ad -.RS 19n -List of Strings -.RE - -.sp -.ne 2 -.na -\fBDefault Value\fR -.ad -.RS 19n -Unassigned -.RE - -.sp -.ne 2 -.na -\fBRange of Values\fR -.ad -.RS 19n -Service type names -.RE - -A list of service type names. In the absence of any \fBDA\fRs, \fBUA\fRs -perform \fBSA\fR discovery to find scopes. If the \fBnet.slp.typeHint\fR -property is set, only \fBSA\fR's advertising types on the list respond. Note -that \fBUA\fRs set this property programmatically. It is not typically set in -the configuration file. The default is unassigned, meaning do not restrict the -type. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -CSI Enabled -_ -Interface Stability Standard -.TE - -.SH SEE ALSO -.sp -.LP -\fBslpd\fR(1M), \fBslpd.reg\fR(4), \fBslp_api\fR(3SLP), \fBslp\fR(7P) -.sp -.LP -\fISystem Administration Guide: Network Services\fR -.sp -.LP -Alvestrand, H. \fIRFC 1766: Tags for the Identification of Languages\fR. -Network Working Group. March 1995. -.sp -.LP -Crocker, D., Overell, P. \fIRFC 2234, Augmented BNF for Syntax Specifications: -ABNF\fR. The Internet Society. 1997. -.sp -.LP -Kempf, J. and Guttman, E. \fIRFC 2614, An API for Service Location\fR. The -Internet Society. June 1999. diff --git a/usr/src/man/man4/slpd.reg.4 b/usr/src/man/man4/slpd.reg.4 deleted file mode 100644 index 7701544b0d..0000000000 --- a/usr/src/man/man4/slpd.reg.4 +++ /dev/null @@ -1,148 +0,0 @@ -'\" te -.\" Copyright (C) 2000, Sun Microsystems, Inc. All Rights Reserved -.\" 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 SLPD.REG 4 "Nov 17, 1999" -.SH NAME -slpd.reg \- serialized registration file for the service location protocol -daemon (slpd) -.SH SYNOPSIS -.LP -.nf -\fB/etc/inet/slpd.reg\fR -.fi - -.SH DESCRIPTION -.LP -The serialized registration file contains a group of registrations that -\fBslpd\fR(1M) registers when it starts. These registrations are primarily for -older service programs that do not internally support \fBSLP\fR and cannot be -converted. The character format of the registration file is required to be -\fBASCII\fR. To use serialized registrations, set the -\fBnet.slp.serializedRegURL\fR property in \fBslp.conf\fR(4) to point at a -valid \fBslpd.reg\fR file. The syntax of the serialized registration file, in -\fBABNF\fR format (see \fIRFC 2234\fR), is as follows: -.sp -.in +2 -.nf -ser-file = reg-list -reg-list = reg / reg reg-list -reg = creg / ser-reg -creg = comment-line ser-reg -comment-line = ( "#" / ";" ) 1*allchar newline -ser-reg = url-props [slist] [attr-list] newline -url-props = surl "," lang "," ltime [ "," type ] newline -surl = ;The registration's URL. See - ; [8] for syntax. -lang = 1*8ALPHA [ "-" 1*8ALPHA ] - ;RFC 1766 Language Tag see [6]. -ltime = 1*5DIGIT - ; A positive 16-bit integer - ; giving the lifetime - ; of the registration. -type = ; The service type name, see [7] - ; and [8] for syntax. -slist = "scopes" "=" scope-list newline -scope-list = scope-name / scope-name "," scope-list -scope = ; See grammar of [7] for - ; scope-name syntax. -attr-list = attr-def / attr-def attr-list -attr-def = ( attr / keyword ) newline -keyword = attr-id -attr = attr-id "=" attr-val-list -attr-id = ;Attribute id, see [7] for syntax. -attr-val-list = attr-val / attr-val "," attr-val-list -attr-val = ;Attribute value, see [7] for syntax -allchar = char / WSP -char = DIGIT / ALPHA / other -other = %x21-%x2f / %x3a-%x40 / - %x5b-%x60 / %7b-%7e - ; All printable, nonwhitespace US-ASCII - ; characters. -newline = CR / ( CRLF ) -.fi -.in -2 - -.sp -.LP -The syntax for attributes and attribute values requires that you use a -backslash to escape special characters, in addition to non-\fBASCII\fR -characters, as specified in \fIRFC 2608\fR. The \fBslpd\fR command handles -serialized registrations exactly as if they were registered by an \fBSA\fR. In -the \fBurl-props\fR production, the type token is optional. If the type token -is present for a service: \fBURL\fR, a warning is signalled, and the type name -is ignored. If the maximum lifetime of \fB65535\fR seconds is specified, the -registration is taken to be permanent, and it is continually refreshed by the -\fBDA\fR or \fBSA\fR server until it exits. -.sp -.LP -Scopes can be included in a registration by including an attribute definition -with tag \fBscopes\fR followed by a comma-separated list of scope names -immediately after the \fBurl-props\fR production. If the optional -\fBscope-list\fR is present, the registrations are made in the indicated scopes; -otherwise, they are registered in the scopes with which the \fBDA\fR or -\fBSA\fR server was configured through the \fBnet.slp.useScopes\fR property. If -any conflicts occur between the scope list and the \fBnet.slp.useScopes\fR -property, an error message is issued by way of \fBsyslog\fR(3C). Refer to -information regarding \fBLOG_INFO\fR in \fBsyslog\fR(3C). -.sp -.LP -Service advertisements are separated by a single blank line. Additionally, the -file must end with a single blank line. -.SH EXAMPLES -.LP -\fBExample 1 \fRUsing a Serialized Registration File -.sp -.LP -The following serialized registration file shows an instance of the service -type \fBfoo\fR, with a lifetime of \fB65535\fR seconds, in the \fBen\fR -locale, with scope \fBsomescope\fR: - -.sp -.in +2 -.nf -# register foo -service:foo://fooserver/foopath,en,65535 -scopes=somescope -description=bogus -security=kerberos_v5 -location=headquarters - -# next registration... -.fi -.in -2 - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -CSI Enabled -_ -Interface Stability Standard -.TE - -.SH SEE ALSO -.LP -\fBslpd\fR(1M), \fBslp_api\fR(3SLP), \fBsyslog\fR(3C), \fBslp.conf\fR(4), -\fBattributes\fR(5) -.sp -.LP -Crocker, D. and Overell, P., \fIRFC 2234, Augmented BNF for Syntax -Specifications: ABNF\fR, The Internet Society, November 1997. -.sp -.LP -Guttman, E., Perkins, C., Veizades, J., and Day, M., \fIRFC 2608, Service -Location Protocol, Version 2\fR, The Internet Society, June 1999. -.sp -.LP -Kempf, J. and Guttman, E., \fIRFC 2614, An API for Service Location\fR, The -Internet Society, June 1999. diff --git a/usr/src/man/man4/smb.4 b/usr/src/man/man4/smb.4 deleted file mode 100644 index 637d22c862..0000000000 --- a/usr/src/man/man4/smb.4 +++ /dev/null @@ -1,617 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2017, Nexenta Systems, Inc. All Rights Reserved. -.\" Copyright 2021, RackTop Systems, Inc. All Rights Reserved. -.\" 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 SMB 4 "December 28, 2020" -.SH NAME -smb \- configuration properties for Solaris CIFS server -.SH DESCRIPTION -Behavior of the Solaris CIFS server is defined by property values that are -stored in the Service Management Facility, \fBsmf\fR(5). -.sp -.LP -An authorized user can use the \fBsharectl\fR(1M) command to set global values -for these properties in SMF. -.sp -.LP -The following list describes the properties: -.sp -.ne 2 -.na -\fB\fBads_site\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the site configured in DNS to look up Active Directory information. -Sites provide a mechanism to partition or delegate administration and policy -management, which are typically used in large or complex domains. -.sp -The value should not be set if you do not have a local Active Directory site. -By default, no value is set. -.RE - -.sp -.ne 2 -.na -\fB\fBautohome_map\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the full path for the SMD autohome map file, \fBsmbautohome\fR. The -default path is \fB/etc\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBbypass_traverse_checking\fR\fR -.ad -.sp .6 -.RS 4n -When set, allows the SMB server to bypass ACL "traverse" checks. -The default value is \fBtrue\fR, for Windows compatibility. -If this parameter is \fBfalse\fR, ACL checks require that -"traverse" (directory execute) is granted on every directory -above the directory the SMB client tries to access. -Windows shares are normally setup with the higher level -directories not specifically granting such access. -.RE - -.sp -.ne 2 -.na -\fB\fBdisposition\fR\fR -.ad -.sp .6 -.RS 4n -A value that controls whether to disconnect the share or proceed if the map -command fails. The disposition property only has meaning when the map property -has been set. Otherwise it will have no effect. -.sp -.in +2 -.nf -disposition = [ continue | terminate ] -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fB\fBcontinue\fR\fR -.ad -.sp .6 -.RS 4n -Proceed with share connection if the map command fails. This is the default in -the event that disposition is not specified. -.RE - -.sp -.ne 2 -.na -\fB\fBterminate\fR\fR -.ad -.sp .6 -.RS 4n -Disconnect the share if the map command fails. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBddns_enable\fR\fR -.ad -.sp .6 -.RS 4n -Enables or disables dynamic DNS updates. A value of \fBtrue\fR enables dynamic -updates, while a value of \fBfalse\fR disables dynamic updates. By default, the -value is \fBfalse\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBencrypt\fR\fR -.ad -.sp .6 -.RS 4n -Controls SMB3 Encryption. For requests on a particular share, the server's -behavior is controlled by the stricter of this option and the per-share -"encrypt" option. -.sp -When set to \fBdisabled\fR, the server will not ask clients to encrypt requests. -When set to \fBenabled\fR, the server will ask clients to encrypt requests, -but will not require that they do so. Any message that can be encrypted -will be encrypted. -When set to \fBrequired\fR, the server will deny access to or disconnect -any client that does not support encryption or fails to encrypt requests -that they should. -.sp -In other words, the \fBenabled\fR behavior is that any message that CAN -be encrypted SHOULD be encrypted, while the \fBrequired\fR behavior is that any -message that CAN be encrypted MUST be encrypted. -.RE - -.sp -.ne 2 -.na -\fB\fBencrypt_cipher\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a list of enabled SMB 3.1.1 encryption ciphers. This property is only -used when encryption is On (see \fBencrypt\fR property) and negotiated SMB -dialect is 3.1.1 or higher (see \fBmax_protocol\fR property). Otherwise it is -ignored. -.sp -When the property is set, a list of comma separated ciphers should be specified, -or the value \fBall\fR should be used instead to enable all supported ciphers. -By default, when the property is empty, it is equivalent to value \fBall\fR - -all available ciphers will be enabled. -.sp -The list of ciphers should contain these values: -.sp -.ne 2 -.na -\fBaes128-ccm\fR -.ad -.RS 13n -AES-128-CCM cipher is enabled. It is the only cipher used for SMB 3.0.2 -dialect. -.RE - -.sp -.ne 2 -.na -\fBaes128-gcm\fR -.ad -.RS 13n -AES-128-GCM cipher is enabled. -preferred. -.RE - -.sp -.ne 2 -.na -\fBall\fR -.ad -.RS 13n -All ciphers are enabled. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBipv6_enable\fR\fR -.ad -.sp .6 -.RS 4n -Enables IPv6 Internet protocol support within the CIFS Service. Valid values -are \fBtrue\fR and \fBfalse\fR. The default value is \fBfalse\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBkeep_alive\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the number of seconds before an idle SMB connection is dropped by the -Solaris CIFS server. If set to 0, idle connections are not dropped. Valid -values are 0 and from 20 seconds and above. The default value is 0. -.RE - -.sp -.ne 2 -.na -\fB\fBlmauth_level\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the LAN Manager (LM) authentication level. The LM compatibility level -controls the type of user authentication to use in workgroup mode or domain -mode. The default value is 3. -.sp -The following describes the behavior at each level. -.sp -.ne 2 -.na -\fB2\fR -.ad -.RS 13n -In Windows workgroup mode, the Solaris CIFS server accepts LM, NTLM, LMv2, and -NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server -sends NTLM requests. -.RE - -.sp -.ne 2 -.na -\fB3\fR -.ad -.RS 13n -In Windows workgroup mode, the Solaris CIFS server accepts LM, NTLM, LMv2, and -NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server -sends LMv2 and NTLMv2 requests. -.RE - -.sp -.ne 2 -.na -\fB4\fR -.ad -.RS 13n -In Windows workgroup mode, the Solaris CIFS server accepts NTLM, LMv2, and -NTLMv2 requests. In domain mode, the SMB redirector on the Solaris CIFS server -sends LMv2 and NTLMv2 requests. -.RE - -.sp -.ne 2 -.na -\fB5\fR -.ad -.RS 13n -In Windows workgroup mode, the Solaris CIFS server accepts LMv2 and NTLMv2 -requests. In domain mode, the SMB redirector on the Solaris CIFS server sends -LMv2 and NTLMv2 requests. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBmap\fR\fR -.ad -.sp .6 -.RS 4n -The value is a command to be executed when connecting to the share. The command -can take the following arguments, which will be substituted when the command is -exec'd as described below: -.sp -.ne 2 -.na -\fB\fB%U\fR\fR -.ad -.sp .6 -.RS 4n -Windows username. -.RE - -.sp -.ne 2 -.na -\fB\fB%D\fR\fR -.ad -.sp .6 -.RS 4n -Name of the domain or workgroup of \fB%U\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB%h\fR\fR -.ad -.sp .6 -.RS 4n -The server hostname. -.RE - -.sp -.ne 2 -.na -\fB\fB%M\fR\fR -.ad -.sp .6 -.RS 4n -The client hostname, or \fB""\fR if not available. -.RE - -.sp -.ne 2 -.na -\fB\fB%L\fR\fR -.ad -.sp .6 -.RS 4n -The server NetBIOS name. -.RE - -.sp -.ne 2 -.na -\fB\fB%m\fR\fR -.ad -.sp .6 -.RS 4n -The client NetBIOS name, or \fB""\fR if not available. This option is only -valid for NetBIOS connections (port 139). -.RE - -.sp -.ne 2 -.na -\fB\fB%I\fR\fR -.ad -.sp .6 -.RS 4n -The IP address of the client machine. -.RE - -.sp -.ne 2 -.na -\fB\fB%i\fR\fR -.ad -.sp .6 -.RS 4n -The local IP address to which the client is connected. -.RE - -.sp -.ne 2 -.na -\fB\fB%S\fR\fR -.ad -.sp .6 -.RS 4n -The name of the share. -.RE - -.sp -.ne 2 -.na -\fB\fB%P\fR\fR -.ad -.sp .6 -.RS 4n -The root directory of the share. -.RE - -.sp -.ne 2 -.na -\fB\fB%u\fR\fR -.ad -.sp .6 -.RS 4n -The UID of the Unix user. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBmax_protocol\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the maximum SMB protocol level that the SMB service -should allow clients to negotiate. The default value is \fB3.11\fR. -Valid settings include: \fB1\fR, \fB2.1\fR, \fB3.0\fR, \fB3.02\fR, \fB3.11\fR -.RE - -.sp -.ne 2 -.na -\fB\fBmin_protocol\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the minimum SMB protocol level that the SMB service -should allow clients to negotiate. The default value is \fB1\fR. -Valid settings include: \fB1\fR, \fB2.1\fR, \fB3.0\fR -.RE - -.sp -.ne 2 -.na -\fB\fBmax_workers\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the maximum number of worker threads that will be launched to process -incoming CIFS requests. The SMB \fBmax_mpx\fR value, which indicates to a -client the maximum number of outstanding SMB requests that it may have pending -on the server, is derived from the \fBmax_workers\fR value. To ensure -compatibility with older versions of Windows the lower 8-bits of \fBmax_mpx\fR -must not be zero. If the lower byte of \fBmax_workers\fR is zero, \fB64\fR is -added to the value. Thus the minimum value is \fB64\fR and the default value, -which appears in \fBsharectl\fR(1M) as \fB1024\fR, is \fB1088\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnetbios_scope\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the NetBIOS scope identifier, which identifies logical NetBIOS -networks that are on the same physical network. When you specify a NetBIOS -scope identifier, the server filters the number of machines that are listed in -the browser display to make it easier to find other hosts. The value is a text -string that represents a domain name. By default, no value is set. -.RE - -.sp -.ne 2 -.na -\fB\fBoplock_enable\fR\fR -.ad -.sp .6 -.RS 4n -Controls whether "oplocks" may be granted by the SMB server. -The term "oplock" is short for "opportunistic lock", which is -the legacy name for cache delegations in SMB. -By default, oplocks are enabled. -Note that if oplocks are disabled, file I/O performance may be -severely reduced. -.RE - -.sp -.ne 2 -.na -\fB\fBpdc\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the preferred IP address for the domain controller. This property is -sometimes used when there are multiple domain controllers to indicate which one -is preferred. If the specified domain controller responds, it is chosen even if -the other domain controllers are also available. By default, no value is set. -.RE - -.sp -.ne 2 -.na -\fB\fBrestrict_anonymous\fR\fR -.ad -.sp .6 -.RS 4n -Disables anonymous access to IPC$, which requires that the client be -authenticated to get access to MSRPC services through IPC$. A value of -\fBtrue\fR disables anonymous access to IPC$, while a value of \fBfalse\fR -enables anonymous access. -.RE - -.sp -.ne 2 -.na -\fB\fBsigning_enabled\fR\fR -.ad -.sp .6 -.RS 4n -Enables SMB signing. When signing is enabled but not required it is possible -for clients to connect regardless of whether or not the client supports SMB -signing. If a packet has been signed, the signature will be verified. If a -packet has not been signed it will be accepted without signature verification. -Valid values are \fBtrue\fR and \fBfalse\fR. The default value is \fBfalse\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBsigning_required\fR\fR -.ad -.sp .6 -.RS 4n -When SMB signing is required, all packets must be signed or they will be -rejected, and clients that do not support signing will be unable to connect to -the server. The \fBsigning_required\fR setting is only taken into account when -\fBsigning_enabled\fR is \fBtrue\fR. Valid values are \fBtrue\fR and -\fBfalse\fR. The default value is \fBfalse\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBsystem_comment\fR\fR -.ad -.sp .6 -.RS 4n -Specifies an optional description for the system, which is a text string. This -property value might appear in various places, such as Network Neighborhood or -Network Places on Windows clients. By default, no value is set. -.RE - -.sp -.ne 2 -.na -\fB\fBtraverse_mounts\fR\fR -.ad -.sp .6 -.RS 4n -The \fBtraverse_mounts\fR setting determines how the SMB server -presents sub-mounts underneath an SMB share. When \fBtraverse_mounts\fR -is \fBtrue\fR (the default), sub-mounts are presented to SMB clients -like any other subdirectory. When \fBtraverse_mounts\fR is \fBfalse\fR, -sub-mounts are not shown to SMB clients. -.RE - -.sp -.ne 2 -.na -\fB\fBunmap\fR\fR -.ad -.sp .6 -.RS 4n -The value is a command to be executed when disconnecting the share. The command -can take the same substitutions listed on the \fBmap\fR property. -.RE - -.sp -.ne 2 -.na -\fB\fBwins_exclude\fR\fR -.ad -.sp .6 -.RS 4n -Specifies a comma-separated list of network interfaces that should not be -registered with WINS. NetBIOS host announcements are made on excluded -interfaces. -.RE - -.sp -.ne 2 -.na -\fB\fBwins_server_1\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the IP address of the primary WINS server. By default, no value is -set. -.RE - -.sp -.ne 2 -.na -\fB\fBwins_server_2\fR\fR -.ad -.sp .6 -.RS 4n -Specifies the IP address of the secondary WINS server. By default, no value is -set. -.RE - -.SH ATTRIBUTES -See the \fBattributes\fR(5) man page for descriptions of the following -attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -\fBsharectl\fR(1M), \fBsmbadm\fR(1M), \fBsmbd\fR(1M), \fBsmbstat\fR(1M), -\fBattributes\fR(5), \fBsmf\fR(5) diff --git a/usr/src/man/man4/smbautohome.4 b/usr/src/man/man4/smbautohome.4 deleted file mode 100644 index 448321c825..0000000000 --- a/usr/src/man/man4/smbautohome.4 +++ /dev/null @@ -1,201 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 SMBAUTOHOME 4 "Feb 25, 2017" -.SH NAME -smbautohome \- CIFS autohome configuration -.SH SYNOPSIS -.LP -.nf -\fBsmbautohome\fR -.fi - -.SH DESCRIPTION -.LP -The Solaris CIFS service can automatically share home directories when a CIFS -client connects. The autohome map file, \fB/etc/smbautohome\fR, uses the search -options and rules to determine whether to share a home directory when a CIFS -client connects to the server. -.sp -.LP -For example, the following entries specify the autohome rules for a particular -environment: -.sp -.in +2 -.nf -+nsswitch dn=ad,dn=sun,dn=com,ou=users -jane /home/?/& dn=ad,dn=sun,dn=com,ou=users -.fi -.in -2 -.sp - -.sp -.LP -The \fBnsswitch\fR autohome entry uses the naming service to match users to -home directories. The second autohome entry specifies that the home directory -for user \fBjane\fR is \fB/home/j/jane\fR. -.SS "autohome Map Entry Format" -.LP -A map entry, which is also referred to as a mapping, uses the following format: -.sp -.in +2 -.nf -\fIkey\fR \fIlocation\fR [ \fIoptions\fR ] -.fi -.in -2 -.sp - -.sp -.LP -\fIkey\fR is a user name, \fIlocation\fR is the fully qualified path for the -user's home directory, and \fIoptions\fR specifies the share options, for -example, an AD container or description. See \fBsharemgr\fR(1M) for information -on share options. -.sp -.LP -If you intend to publish the share in Active Directory (AD), you \fBmust\fR -specify an AD container name, which is specified as a comma-separated list of -attribute name-value pairs. The attributes use the LDAP distinguished name (DN) -or relative distinguished name (RDN) format. -.sp -.LP -The DN or RDN must be specified in LDAP format by using the following attribute -types: -.RS +4 -.TP -.ie t \(bu -.el o -\fBcn=\fR represents the common name -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBou=\fR represents the organizational unit -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBdc=\fR represents the domain component -.RE -.sp -.LP -The attribute type that is used to describe an object's RDN is called a -\fBnaming attribute\fR. AD uses the naming attributes as follows: -.RS +4 -.TP -.ie t \(bu -.el o -\fBcn\fR for the \fBuser\fR object class -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBou\fR for the \fBOU\fR (organizational unit) object class -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBdc\fR for the \fBdomainDns\fR object class -.RE -.SS "autohome Map Key Substitution" -.LP -The autohome feature supports the following wildcard substitutions for the -value of the key field: -.RS +4 -.TP -.ie t \(bu -.el o -The ampersand character (\fB&\fR) is expanded to the value of the key field for -the entry in which it occurs. In the following example, \fB&\fR expands to -\fBjane\fR: -.sp -.in +2 -.nf -jane /home/& -.fi -.in -2 - -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The question mark character (\fB?\fR) is expanded to the value of the first -character in the key field for the entry in which it occurs. In the following -example, \fB?\fR expands to \fBj\fR: -.sp -.in +2 -.nf -jane /home/?/& -.fi -.in -2 - -.RE -.SS "Wildcard Rule" -.LP -When supplied in the key field, the asterisk character (\fB*\fR) is recognized -as the "catch-all" entry. Such an entry matches any key not previously matched. -.sp -.LP -For example, the following entry would map any user to a home directory in -\fB/home\fR in which the home directory name was the same as the user name: -.sp -.in +2 -.nf -* /home/& -.fi -.in -2 - -.sp -.LP -The wildcard rule is \fBonly\fR applied if an appropriate rule is not matched -by another map entry. -.SS "NSSwitch Map" -.LP -The \fBnsswitch\fR map is used to request that the home directory be obtained -from a password database, such as the local, NIS, or LDAP databases. If -an AD path is appended, it is used to publish shares. -.sp -.in +2 -.nf -+nsswitch -.fi -.in -2 - -.sp -.LP -Like the "catch-all" entry, the \fBnsswitch\fR map is \fBonly\fR searched if an -appropriate rule is not matched by another map entry. -.sp -.LP -The wildcard and \fBnsswitch\fR rules are mutually exclusive. Do not include an -\fBnsswitch\fR rule if a wildcard rule has already been defined. -.SH FILES -.LP -\fB/etc/smbautohome\fR -.SH ATTRIBUTES -.LP -See the \fBattributes\fR(5) man page for descriptions of the following -attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Uncommitted -.TE - -.SH SEE ALSO -.LP -\fBsharectl\fR(1M), \fBsharemgr\fR(1M), \fBsmbadm\fR(1M), \fBsmbd\fR(1M), -\fBsmbstat\fR(1M), \fBsmb\fR(4), \fBattributes\fR(5) diff --git a/usr/src/man/man4/smhba.conf.4 b/usr/src/man/man4/smhba.conf.4 deleted file mode 100644 index a960c3526f..0000000000 --- a/usr/src/man/man4/smhba.conf.4 +++ /dev/null @@ -1,95 +0,0 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 SMHBA.CONF 4 "May 16, 2020" -.SH NAME -smhba.conf \- configuration file for the SMHBAAPI library -.SH DESCRIPTION -The \fB/etc/smhba.conf\fR file is used to specify the Vendor-Specific Libraries -that are installed on the system. This file is used by the Common Library to -load the individual VSLs when \fBHBA_LoadLibrary\fR(3HBAAPI) is called. If -changes are made to the file while the library is in use, the library should be -freed and reloaded. A version 1 VSL is compatible only with a version 1 Common -Library. A version 2 VSL is compatible with both a version 1 and a version 2 -Common Library. -.sp -.LP -Each VSL entry is a single line of the form: -.sp -.in +2 -.nf -"name" "library path" -.fi -.in -2 - -.sp -.LP -where: -.sp -.ne 2 -.na -\fB\fIname\fR\fR -.ad -.RS 16n -is the description of library. The library name should be prepended with the -domain of the manufacturer of the library. -.RE - -.sp -.ne 2 -.na -\fB\fIlibrary path\fR\fR -.ad -.RS 16n -is the absolute path to the shared object library file. -.RE - -.SH EXAMPLES -\fBExample 1 \fRContents of \fB/etc/smhba.conf\fR -.sp -.in +2 -.nf -# -# This file contains names and references to SM-HBA libraries -# -# Format: -# -# <library name> <library pathname> -# -# The library name should be prepended with the domain of -# the manufacturer or driver author. -com.sun.sashba /usr/lib/libsun_sas.so.1 -com.sun.sashba64 /usr/lib/64/libsun_sas.so.1 -.fi -.in -2 - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Committed -_ -Standard T{ -ANSI INCITS 428 Storage Management Host Bus Adapter Application Programming Interface(SM-HBA) -T} -.TE - -.SH SEE ALSO -\fBHBA_LoadLibrary\fR(3HBAAPI), \fBlibSMHBAAPI\fR(3LIB), \fBattributes\fR(5) -.SH NOTES -The SMHBAAPI library is provided in both 32-and 64-bit versions, but only one -configuration file is specified. As a result, both 32- and 64-bit VSL libraries -must be specified within the same file. When using the 32-bit Common Library, -the 64-bit VSLs will fail to load. When using the 64-bit Common Library, the -32-bit VSLs will fail to load. These failures are silently ignored by the -Common Library during normal usage, but can result in warning messages when -running client applications in a debugger. diff --git a/usr/src/man/man4/sock2path.d.4 b/usr/src/man/man4/sock2path.d.4 deleted file mode 100644 index d7a5f188e3..0000000000 --- a/usr/src/man/man4/sock2path.d.4 +++ /dev/null @@ -1,58 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. -.\" 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 SOCK2PATH.D 4 "Apr 12, 2014" -.SH NAME -sock2path.d \- socket mapping files that map sockets to transport providers -.SH SYNOPSIS -.LP -.nf -\fB/etc/sock2path.d\fR -.fi - -.SH DESCRIPTION -.sp -.LP -\fB/etc/sock2path.d\fR is a directory containing files with mappings -between the \fBsocket\fR(3SOCKET) call parameters and the transport -provider driver. The mapping file format is described in the -\fBsoconfig\fR(1M) manual page. -.sp -.LP -The \fBinit\fR(1M) utility uses the \fBsoconfig\fR utility with the -\fBsock2path.d\fR directory during the boot sequence. -.SH EXAMPLES -.LP -\fBExample 1 \fRAn Example of a Mapping File -.sp -.LP -The following is an example of a mapping file: - -.sp -.in +2 -.nf -# Family Type Protocol Module | Path - 2 2 0 tcp - 2 2 6 tcp - 26 2 0 tcp - 26 2 6 tcp - 2 1 0 udp - 2 1 17 udp - 26 1 0 udp - 26 1 17 udp - 1 2 0 /dev/ticotsord - 1 6 0 /dev/ticotsord - 1 1 0 /dev/ticlts - 2 4 0 icmp - 26 4 0 icmp - 24 4 0 rts - 27 4 2 /dev/keysock -.fi -.in -2 - -.SH SEE ALSO -.sp -.LP -\fBinit\fR(1M), \fBsoconfig\fR(1M), \fBsocket\fR(3SOCKET) diff --git a/usr/src/man/man4/space.4 b/usr/src/man/man4/space.4 deleted file mode 100644 index 7a3b61def2..0000000000 --- a/usr/src/man/man4/space.4 +++ /dev/null @@ -1,77 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved -.\" 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 SPACE 4 "Feb 7, 1997" -.SH NAME -space \- disk space requirement file -.SH DESCRIPTION -.sp -.LP -\fBspace\fR is an \fBASCII\fR file that gives information about disk space -requirements for the target environment. The \fBspace\fR file defines space -needed beyond what is used by objects defined in the \fBprototype\fR(4) file; -for example, files which will be installed with the \fBinstallf\fR(1M) command. -The \fBspace\fR file should define the maximum amount of additional space that -a package will require. -.sp -.LP -The generic format of a line in this file is: -.sp -.LP -\fIpathname blocks inodes\fR -.sp -.LP -Definitions for the fields are as follows: -.sp -.ne 2 -.na -\fB\fIpathname\fR\fR -.ad -.RS 12n -Specify a directory name which may or may not be the mount point for a -filesystem. Names that do not begin with a slash ('\fB/\fR') indicate -relocatable directories. -.RE - -.sp -.ne 2 -.na -\fB\fIblocks\fR\fR -.ad -.RS 12n -Define the number of disk blocks required for installation of the files and -directory entries contained in the pathname (using a 512-byte block size). -.RE - -.sp -.ne 2 -.na -\fB\fIinodes\fR\fR -.ad -.RS 12n -Define the number of inodes required for installation of the files and -directory entries contained in the pathname. -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample file. -.sp -.in +2 -.nf -# extra space required by config data which is -# dynamically loaded onto the system -data 500 1 -.fi -.in -2 -.sp - -.SH SEE ALSO -.sp -.LP -\fBinstallf\fR(1M), \fBprototype\fR(4) -.sp -.LP -\fIApplication Packaging Developer\&'s Guide\fR diff --git a/usr/src/man/man4/sulog.4 b/usr/src/man/man4/sulog.4 deleted file mode 100644 index 62f7623da2..0000000000 --- a/usr/src/man/man4/sulog.4 +++ /dev/null @@ -1,139 +0,0 @@ -'\" te -.\" Copyright (c) 1994, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 SULOG 4 "Jun 6, 1994" -.SH NAME -sulog \- su command log file -.SH SYNOPSIS -.LP -.nf -\fB/var/adm/sulog\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBsulog\fR file is a record of all attempts by users on the system to -execute the \fBsu\fR(1M) command. Each time \fBsu\fR(1M) is executed, an -entry is added to the \fBsulog\fR file. -.sp -.LP -Each entry in the \fBsulog\fR file is a single line of the form: -.sp -.in +2 -.nf -\fBSU\fR \fBdate\fR \fBtime\fR -\fIresult port user\fR\fB-\fR\fInewuser\fR -.fi -.in -2 -.sp - -.sp -.LP -where -.sp -.ne 2 -.na -\fB\fBdate\fR\fR -.ad -.RS 11n -The month and date \fBsu\fR(1M) was executed. \fBdate\fR is displayed in the -form \fImm\fR\fB/\fR\fBdd\fR where \fImm\fR is the month number and \fBdd\fR -is the day number in the month. -.RE - -.sp -.ne 2 -.na -\fB\fBtime\fR\fR -.ad -.RS 11n -The time \fBsu\fR(1M) was executed. \fBtime\fR is displayed in the form -\fIHH\fR\fB/\fR\fIMM\fR where \fIHH\fR is the hour number (24 hour system) and -\fIMM\fR is the minute number. -.RE - -.sp -.ne 2 -.na -\fB\fIresult\fR\fR -.ad -.RS 11n -The result of the \fBsu\fR(1M) command. A ` + ' sign is displayed in this -field if the su attempt was successful; otherwise a ` - ' sign is displayed. -.RE - -.sp -.ne 2 -.na -\fB\fIport\fR\fR -.ad -.RS 11n -The name of the terminal device from which \fBsu\fR(1M) was executed. -.RE - -.sp -.ne 2 -.na -\fB\fIuser\fR\fR -.ad -.RS 11n -The user id of the user executing the \fBsu\fR(1M) command. -.RE - -.sp -.ne 2 -.na -\fB\fInewuser\fR\fR -.ad -.RS 11n -The user id being switched to with \fBsu\fR(1M). -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample \fBsulog\fR file. -.sp -.LP -Here is a sample \fBsulog\fR file: - -.sp -.in +2 -.nf -SU 02/25 09:29 + console root-sys -SU 02/25 09:32 + pts/3 user1-root -SU 03/02 08:03 + pts/5 user1-root -SU 03/03 08:19 + pts/5 user1-root -SU 03/09 14:24 - pts/5 guest3-root -SU 03/09 14:24 - pts/5 guest3-root -SU 03/14 08:31 + pts/4 user1-root -.fi -.in -2 -.sp - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/var/adm/sulog\fR\fR -.ad -.RS 19n -su log file -.RE - -.sp -.ne 2 -.na -\fB\fB/etc/default/su\fR\fR -.ad -.RS 19n -contains the default location of \fBsulog\fR -.RE - -.SH SEE ALSO -.sp -.LP -\fBsu\fR(1M) diff --git a/usr/src/man/man4/swap.4 b/usr/src/man/man4/swap.4 new file mode 100644 index 0000000000..0d2faddf6d --- /dev/null +++ b/usr/src/man/man4/swap.4 @@ -0,0 +1,92 @@ +.\" +.\" 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 2017, Joyent, Inc. +.\" +.Dd Aug 14, 2017 +.Dt SWAP 4 +.Os +.Sh NAME +.Nm swap +.Nd swap space +.Sh DESCRIPTION +The operating system uses demand paging as the primary mechanism to implement +virtual memory. +The system can also use traditional swapping, wherein an entire process state +is moved between physical memory and swap space on disk, but it is very rare +for the system to actually swap an entire process out to disk. +A system which is swapping does not have enough enough physical memory to +support the workload on the machine. +In this case, work should be reduced or more memory added. +.Pp +Given that the system rarely, if ever, swaps, but still has swap space +configured, the question arises as to what this space is for? +.Pp +In a demand paged virtual memory system, every page mapped by a process is +backed by some object. +For the actual program code used by the process, the backing objects are the +underlying files in the filesystem for the program's binary, and any +dynamically linked libraries. +The portions of a process that are not backed by a named file, including its +stack and its heap, are called anonymous memory. +The system uses the swap space as the backing store for these pages. +When the system determines that it needs to page out one of the anonymous pages, +the swap space is where that page is written. +.Pp +Unlike some other operating systems, illumos reserves the backing storage +space for anonymous memory at the time of allocation. +For example, if a process asks for more heap space, the total size of the +swap allocation that may be required to store the new pages if they need to +be paged out is reserved at that time. +This does not mean that anything is written to the swap space, but simply that +the space is reserved for the entire allocation. +Thus, a process will always get a correct error from the +.Xr sbrk 2 +system call if swap space is unavailable. +Some other operating systems don't allocate backing store for anonymous memory +until it is used, so the error handling when space is not available can be +complex or problematic on those systems. +.Pp +The +.Xr vmstat 8 +command can be used to monitor swap and paging activity. +The +.Xr pmap 1 +command can be used to inspect all of the mappings in a process address space, +and their backing objects. +The +.Xr swap 8 +command can be used to monitor, add and remove swap space. +.Pp +The operating system provides the +.Ql zone.max-swap +resource control to limit the amount of +anonymous memory used by all of the processes within a zone. +This resource control can also be configured under the +.Xr capped-memory 2 +setting for a zone. +See the +.Xr prctl 1 +and +.Xr zonecfg 8 +man pages for information on setting this limit. +The zone's usage against this resource control can be seen using the +.Ql swapresv_zone_{zoneid} +kstat. +.Sh SEE ALSO +.Xr pmap 1 , +.Xr prctl 1 , +.Xr sbrk 2 , +.Xr resource_controls 7 , +.Xr kstat 8 , +.Xr swap 8 , +.Xr vmstat 8 , +.Xr zonecfg 8 diff --git a/usr/src/man/man4/sysbus.4 b/usr/src/man/man4/sysbus.4 deleted file mode 100644 index 77970edacc..0000000000 --- a/usr/src/man/man4/sysbus.4 +++ /dev/null @@ -1,126 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved -.\" 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 SYSBUS 4 "December 28, 2020" -.SH NAME -sysbus, isa \- device tree properties for ISA bus device drivers -.SH DESCRIPTION -Solaris for x86 supports the \fBISA\fR bus as the system bus. Drivers for -devices on this bus use the device tree built by the booting system to -retrieve the necessary system resources used by the driver. These resources -include device I/O port addresses, any interrupt capabilities that the device -can have, any DMA channels it can require, and any memory-mapped addresses it -can occupy. -.sp -.LP -Configuration files for \fBISA\fR device drivers are only necessary to describe -properties used by a particular driver that are not part of the standard -properties found in the device tree. See \fBdriver.conf\fR(4) for further -details of configuration file syntax. -.sp -.LP -The \fBISA\fR nexus drivers all belong to class \fBsysbus\fR. All bus drivers -of class \fBsysbus\fR recognize the following properties: -.sp -.ne 2 -.na -\fB\fBinterrupts\fR\fR -.ad -.RS 16n -An arbitrary-length array where each element of the array represents a hardware -interrupt (IRQ) that is used by the device. In general, this array only has -one entry unless a particular device uses more than one IRQ. -.sp -Solaris defaults all \fBISA\fR interrupts to IPL 5. This interrupt priority -can be overridden by placing an \fBinterrupt-priorities\fR property in a .conf -file for the driver. Each entry in the array of integers for the -\fBinterrupt-priorities\fR property is matched one-to-one with the elements in -the \fBinterrupts\fR property to specify the \fBIPL\fR value that is used by -the system for this interrupt in this driver. This is the priority that this -device's interrupt handler receives relative to the interrupt handlers of other -drivers. The priority is an integer from \fB1\fR to \fB16\fR. Generally, -disks are assigned a priority of \fB5\fR, while mice and printers are lower, -and serial communication devices are higher, typically \fB7\fR. \fB10\fR is -reserved by the system and must not be used. Priorities \fB11\fR and greater -are high level priorities and are generally not recommended (see -\fBddi_intr_hilevel\fR(9F)). -.sp -The driver can refer to the elements of this array by index using -\fBddi_add_intr\fR(9F). The index into the array is passed as the -\fIinumber\fR argument of \fBddi_add_intr()\fR. -.sp -Only devices that generate interrupts have an \fBinterrupts\fR property. -.RE - -.sp -.ne 2 -.na -\fB\fBreg\fR\fR -.ad -.RS 16n -An arbitrary-length array where each element of the array consists of a 3-tuple -of integers. Each array element describes a contiguous memory address range -associated with the device on the bus. -.sp -The first integer of the tuple specifies the memory type, \fB0\fR specifies a -memory range and \fB1\fR specifies an I/O range. The second integer specifies -the base address of the memory range. The third integer of each 3-tuple -specifies the size, in bytes, of the mappable region. -.sp -The driver can refer to the elements of this array by index, and construct -kernel mappings to these addresses using \fBddi_map_regs\fR(9F). The index into -the array is passed as the \fIrnumber\fR argument of \fBddi_map_regs()\fR. -.sp -All \fBsysbus\fR devices have \fBreg\fR properties. The first tuple of this -property is used to construct the address part of the device name under -\fB/devices\fR. In the case of \fBPlug and Play ISA\fR devices, the first tuple -is a special tuple that does not denote a memory range, but is used by the -system only to create the address part of the device name. This special tuple -can be recognized by determining if the top bit of the first integer is set to -a one. -.sp -The order of the tuples in the reg property is determined by the boot system -probe code and depends on the characteristics of each particular device. -However, the reg property maintains the same order of entries from system boot -to system boot. The recommended way to determine the reg property for a -particular device is to use the \fBprtconf\fR(1M) command after installing the -particular device. The output of the \fBprtconf\fR command can be examined to -determine the reg property for any installed device. -.sp -You can use the \fBddi_get*\fR and \fBddi_put*\fR family of functions to access -register space from a high-level interrupt context. -.RE - -.sp -.ne 2 -.na -\fB\fBdma-channels\fR\fR -.ad -.RS 16n -A list of integers that specifies the DMA channels used by this device. Only -devices that use DMA channels have a \fBdma-channels\fR property. -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture x86 -.TE - -.SH SEE ALSO -\fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBscsi\fR(4), \fBattributes\fR(5), -\fBddi_add_intr\fR(9F), \fBddi_intr_hilevel\fR(9F), \fBddi_map_regs\fR(9F), -\fBddi_prop_op\fR(9F) -.sp -.LP -\fIWriting Device Drivers\fR diff --git a/usr/src/man/man4/syslog.conf.4 b/usr/src/man/man4/syslog.conf.4 deleted file mode 100644 index 7dcc4f5731..0000000000 --- a/usr/src/man/man4/syslog.conf.4 +++ /dev/null @@ -1,424 +0,0 @@ -'\" te -.\" Copyright (c) 2013 Gary Mills -.\" Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright (c) 1983 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. -.TH SYSLOG.CONF 4 "Nov 19, 2013" -.SH NAME -syslog.conf \- configuration file for syslogd system log daemon -.SH SYNOPSIS -.LP -.nf -\fB/etc/syslog.conf\fR -.fi - -.SH DESCRIPTION -.LP -The file \fB/etc/syslog.conf\fR contains information used by the system log -daemon, \fBsyslogd\fR(1M), to forward a system message to appropriate log files -and/or users. \fBsyslogd\fR preprocesses this file through \fBm4\fR(1) to -obtain the correct information for certain log files, defining \fBLOGHOST\fR if -the address of "loghost" is the same as one of the addresses of the host that -is running \fBsyslogd\fR. -.sp -.LP -A configuration entry is composed of two TAB-separated fields: -.sp -.in +2 -.nf -\fIselector action\fR -.fi -.in -2 - -.sp -.LP -The \fIselector\fR field contains a semicolon-separated list of priority -specifications of the form: -.sp -.in +2 -.nf -\fIfacility\fR\fB\&.\fR\fIlevel\fR [ \fB;\fR \fIfacility\fR\fB\&.\fR\fIlevel\fR ] -.fi -.in -2 - -.sp -.LP -where \fIfacility\fR is a system facility, or comma-separated list of -facilities, and \fIlevel\fR is an indication of the severity of the condition -being logged. -The presence of a facility name only implies that it is available. -Each individual service determines which facility it will use for logging. -In particular, many facilities are only useful for \fBsyslog\fR messages -that are forwarded from other operating systems. -Recognized values for \fIfacility\fR include: -.sp -.ne 2 -.na -\fB\fBkern\fR\fR -.ad -.RS 12n -Messages generated by the kernel. -.RE - -.sp -.ne 2 -.na -\fB\fBuser\fR\fR -.ad -.RS 12n -Messages generated by user processes. This is the default priority for messages -from programs or facilities not listed in this file. -.RE - -.sp -.ne 2 -.na -\fB\fBmail\fR\fR -.ad -.RS 12n -The mail system. -.RE - -.sp -.ne 2 -.na -\fB\fBdaemon\fR\fR -.ad -.RS 12n -Various system daemons. -.RE - -.sp -.ne 2 -.na -\fB\fBauth\fR\fR -.ad -.RS 12n -The authorization system: \fBlogin\fR(1), \fBsu\fR(1M), \fBgetty\fR(1M), among -others. -.RE - -.sp -.ne 2 -.na -\fB\fBlpr\fR\fR -.ad -.RS 12n -The line printer spooling system: \fBlpr\fR(1B), \fBlpc\fR(1B), among others. -.RE - -.sp -.ne 2 -.na -\fB\fBnews\fR\fR -.ad -.RS 12n -Designated for the USENET network news system. -.RE - -.sp -.ne 2 -.na -\fB\fBuucp\fR\fR -.ad -.RS 12n -Designated for the UUCP system; it does not currently use the \fBsyslog\fR -mechanism. -.RE - -.sp -.ne 2 -.na -\fB\fBaltcron\fR\fR -.ad -.RS 12n -Designated for the BSD cron/at system. -.RE - -.sp -.ne 2 -.na -\fB\fBauthpriv\fR\fR -.ad -.RS 12n -Designated for the BSD security/authorization system. -.RE - -.sp -.ne 2 -.na -\fB\fBftp\fR\fR -.ad -.RS 12n -Designated for the file transfer system. -.RE - -.sp -.ne 2 -.na -\fB\fBntp\fR\fR -.ad -.RS 12n -Designated for the network time system. -.RE - -.sp -.ne 2 -.na -\fB\fBaudit\fR\fR -.ad -.RS 12n -Designated for audit messages generated by systems that audit by means of -syslog. -.RE - -.sp -.ne 2 -.na -\fB\fBconsole\fR\fR -.ad -.RS 12n -Designated for the BSD console system. -.RE - -.sp -.ne 2 -.na -\fB\fBcron\fR\fR -.ad -.RS 12n -Designated for \fBcron\fR/\fBat\fR messages generated by systems that do -logging through \fBsyslog\fR. -The current versions of \fBcron\fR and \fBat\fR do not use this facility -for logging. -.RE - -.sp -.ne 2 -.na -\fB\fBlocal0-7\fR\fR -.ad -.RS 12n -Designated for local use. -.RE - -.sp -.ne 2 -.na -\fB\fBmark\fR\fR -.ad -.RS 12n -For timestamp messages produced internally by \fBsyslogd\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB*\fR\fR -.ad -.RS 12n -An asterisk indicates all facilities except for the \fBmark\fR facility. -.RE - -.sp -.LP -Recognized values for \fIlevel\fR are (in descending order of severity): -.sp -.ne 2 -.na -\fB\fBemerg\fR\fR -.ad -.RS 11n -For panic conditions that would normally be broadcast to all users. -.RE - -.sp -.ne 2 -.na -\fB\fBalert\fR\fR -.ad -.RS 11n -For conditions that should be corrected immediately, such as a corrupted system -database. -.RE - -.sp -.ne 2 -.na -\fB\fBcrit\fR\fR -.ad -.RS 11n -For warnings about critical conditions, such as hard device errors. -.RE - -.sp -.ne 2 -.na -\fB\fBerr\fR\fR -.ad -.RS 11n -For other errors. -.RE - -.sp -.ne 2 -.na -\fB\fBwarning\fR\fR -.ad -.RS 11n -For warning messages. -.RE - -.sp -.ne 2 -.na -\fB\fBnotice\fR\fR -.ad -.RS 11n -For conditions that are not error conditions, but may require special handling. -A configuration entry with a \fIlevel\fR value of \fBnotice\fR must appear on a -separate line. -.RE - -.sp -.ne 2 -.na -\fB\fBinfo\fR\fR -.ad -.RS 11n -Informational messages. -.RE - -.sp -.ne 2 -.na -\fB\fBdebug\fR\fR -.ad -.RS 11n -For messages that are normally used only when debugging a program. -.RE - -.sp -.ne 2 -.na -\fB\fBnone\fR\fR -.ad -.RS 11n -Do not send messages from the indicated \fIfacility\fR to the selected file. -For example, a \fIselector\fR of -.sp -\fB*.debug;mail.none\fR -.sp -sends all messages \fIexcept\fR mail messages to the selected file. -.RE - -.sp -.LP -For a given \fIfacility\fR and \fIlevel\fR, \fBsyslogd\fR matches all messages -for that level and all higher levels. For example, an entry that specifies a -level of \fBcrit\fR also logs messages at the \fBalert\fR and \fBemerg\fR -levels. -.sp -.LP -The \fIaction\fR field indicates where to forward the message. Values for this -field can have one of four forms: -.RS +4 -.TP -.ie t \(bu -.el o -A filename, beginning with a leading slash, which indicates that messages -specified by the \fIselector\fR are to be written to the specified file. The -file is opened in append mode if it exists. If the file does not exist, logging -silently fails for this action. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The name of a remote host, prefixed with an \fB@\fR, as with: -\fB@\fR\fIserver\fR, which indicates that messages specified by the -\fIselector\fR are to be forwarded to the \fBsyslogd\fR on the named host. The -hostname "loghost" is treated, in the default \fBsyslog.conf\fR, as the -hostname given to the machine that logs \fBsyslogd\fR messages. Every machine -is "loghost" by default, per the hosts database. It is also possible to specify -one machine on a network to be "loghost" by, literally, naming the machine -"loghost". If the local machine is designated to be "loghost", then -\fBsyslogd\fR messages are written to the appropriate files. Otherwise, they -are sent to the machine "loghost" on the network. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A comma-separated list of usernames, which indicates that messages specified by -the \fIselector\fR are to be written to the named users if they are logged in. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -An asterisk, which indicates that messages specified by the \fIselector\fR are -to be written to all logged-in users. -.RE -.sp -.LP -Blank lines are ignored. Lines for which the first nonwhite character is -a '\fB#\fR' are treated as comments. -.SH EXAMPLES -.LP -\fBExample 1 \fRA Sample Configuration File -.sp -.LP -With the following configuration file: - -.sp - -.sp -.TS -l l -l l . -\fB*.notice\fR \fB/var/log/notice\fR -\fBmail.info\fR \fB/var/log/notice\fR -\fB*.crit\fR \fB/var/log/critical\fR -\fBkern,mark.debug\fR \fB/dev/console\fR -\fBkern.err\fR \fB@server\fR -\fB*.emerg\fR \fB*\fR -\fB*.alert\fR \fBroot,operator\fR -\fB*.alert;auth.warning\fR \fB/var/log/auth\fR -.TE - -.sp -.LP -\fBsyslogd\fR(1M) logs all mail system messages except \fBdebug\fR messages and -all \fBnotice\fR (or higher) messages into a file named \fB/var/log/notice\fR. -It logs all critical messages into \fB/var/log/critical\fR, and all kernel -messages and 20-minute marks onto the system console. - -.sp -.LP -Kernel messages of \fBerr\fR (error) severity or higher are forwarded to the -machine named \fBserver\fR. Emergency messages are forwarded to all users. The -users \fBroot\fR and \fBoperator\fR are informed of any \fBalert\fR messages. -All messages from the authorization system of \fBwarning\fR level or higher are -logged in the file \fB/var/log/auth\fR. - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Stable -.TE - -.SH SEE ALSO -.LP -\fBat\fR(1), \fBcrontab\fR(1), \fBlogger\fR(1), \fBlogin\fR(1), \fBlp\fR(1), -\fBlpc\fR(1B), \fBlpr\fR(1B), \fBm4\fR(1), \fBcron\fR(1M), \fBgetty\fR(1M), -\fBin.ftpd\fR(1M), \fBsu\fR(1M), \fBsyslogd\fR(1M), \fBsyslog\fR(3C), -\fBhosts\fR(4), \fBattributes\fR(5) diff --git a/usr/src/man/man4/system.4 b/usr/src/man/man4/system.4 deleted file mode 100644 index 7420c833ba..0000000000 --- a/usr/src/man/man4/system.4 +++ /dev/null @@ -1,366 +0,0 @@ -'\" te -.\" Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2016 Hans Rosenfeld <rosenfeld@grumpf.hope-2000.org> -.\" Copyright 2019 OmniOS Community Edition (OmniOSce) Association. -.\" Copyright 2019 Peter Tribble -.\" Copyright 1989 AT&T -.\" 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 SYSTEM 4 "Apr 20, 2019" -.SH NAME -system \- system configuration information file -.SH DESCRIPTION -.LP -The \fBsystem\fR file is used for customizing the operation of the operating -system kernel. The recommended procedure is to preserve the original -\fBsystem\fR file before modifying it. -.sp -.LP -It is not recommended to edit the \fB/etc/system\fR file directly but rather -to deliver configuration fragments into files under \fB/etc/system.d\fR; -files in this directory are combined in alphabetical order and read by the -kernel before \fB/etc/system\fR is processed. Directives in \fB/etc/system\fR -therefore take precedence over any settings delivered in fragment files. -.sp -.LP -The recommended naming schema for the fragment files is to use the name of -the package which is delivering the file with '\fB/\fR' characters replaced -by '\fB:\fR'; file names that start with a dot (\fB.\fR) will be ignored. -.sp -.LP -If \fB/etc/system.d/\fR exists and contains any fragment files, -then the directory must also be writable or it will not be possible to -create or update the system boot archive. -.sp -.LP -The \fBsystem\fR file contains commands which are read by the kernel during -initialization and used to customize the operation of your system. These -commands are useful for modifying the system's treatment of its loadable kernel -modules. -.sp -.LP -The syntax of the \fBsystem\fR file consists of a list of keyword/value pairs -which are recognized by the system as valid commands. Comment lines must begin -with an asterisk (\fB*\fR) or a hash mark (\fB#\fR) and end with a newline -character. All commands are case-insensitive except where noted. -.sp -.LP -Commands that modify the system's operation with respect to loadable kernel -modules require you to specify the module type by listing the module's -namespace. The following namespaces are currently supported on all platforms: -.sp -.ne 2 -.na -\fB\fBdrv\fR\fR -.ad -.RS 10n -Modules in this namespace are device drivers. -.RE - -.sp -.ne 2 -.na -\fB\fBexec\fR\fR -.ad -.RS 10n -Modules in this namespace are execution format modules. The following -\fBexec\fR modules are currently provided: -.sp -.ne 2 -.na -\fBOnly on SPARC systems:\fR -.ad -.RS 28n -.sp -.in +2 -.nf -aoutexec -.fi -.in -2 -.sp - -.RE - -.sp -.ne 2 -.na -\fBOn SPARC and IA systems:\fR -.ad -.RS 28n -.sp -.in +2 -.nf -elfexec -intpexec -javaexec -.fi -.in -2 -.sp - -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBfirmware\fR\fR -.ad -.RS 10n -Raw firmware images in subdirectories, one for each device driver -module using \fBfirmload\fR(9F). -.RE - -.sp -.ne 2 -.na -\fB\fBfs\fR\fR -.ad -.RS 10n -These modules are filesystems. -.RE - -.sp -.ne 2 -.na -\fB\fBsched\fR\fR -.ad -.RS 10n -These modules implement a process scheduling algorithm. -.RE - -.sp -.ne 2 -.na -\fB\fBstrmod\fR\fR -.ad -.RS 10n -These modules are \fBSTREAMS\fR modules. -.RE - -.sp -.ne 2 -.na -\fB\fBsys\fR\fR -.ad -.RS 10n -These modules implement loadable system-call modules. -.RE - -.sp -.ne 2 -.na -\fB\fBmisc\fR\fR -.ad -.RS 10n -These modules do not fit into any of the above categories, so are considered -"miscellaneous" modules. -.RE - -.sp -.LP -SPARC only: -.sp -.ne 2 -.na -\fB\fBdacf\fR\fR -.ad -.RS 8n -These modules provide rules and actions for device auto-configuration. -.RE - -.sp -.ne 2 -.na -\fB\fBtod\fR\fR -.ad -.RS 8n -These modules provide support for the time of day hardware. -.RE - -.sp -.ne 2 -.na -\fB\fBcpu\fR\fR -.ad -.RS 8n -These modules provide \fBCPU\fR-specific kernel routines. -.RE - -.sp -.LP -A description of each of the supported commands follows: -.sp -.ne 2 -.na -\fB\fBexclude:\fR <\fInamespace\fR>/<\fImodulename\fR>\fR -.ad -.sp .6 -.RS 4n -Do not allow the listed loadable kernel module to be loaded. \fBexclude\fR -commands are cumulative; the list of modules to \fBexclude\fR is created by -combining every \fBexclude\fR entry in the \fBsystem\fR file. -.RE - -.sp -.ne 2 -.na -\fB\fBinclude:\fR <\fInamespace\fR>/<\fImodulename\fR>\fR -.ad -.sp .6 -.RS 4n -Include the listed loadable kernel module. This is the system's default, so -using \fBinclude\fR does not modify the system's operation. \fBinclude\fR -commands are cumulative. -.RE - -.sp -.ne 2 -.na -\fB\fBforceload:\fR <\fInamespace\fR>/<\fImodulename\fR>\fR -.ad -.sp .6 -.RS 4n -Force this kernel module to be loaded during kernel initialization. The default -action is to automatically load the kernel module when its services are first -accessed. \fBforceload\fR commands are cumulative. -.RE - -.sp -.ne 2 -.na -\fB\fBrootdev:\fR <\fIdevice name\fR>\fR -.ad -.sp .6 -.RS 4n -Set the root device to the listed value instead of using the default root -device as supplied by the boot program. -.RE - -.sp -.ne 2 -.na -\fB\fBrootfs:\fR <\fIroot filesystem type\fR>\fR -.ad -.sp .6 -.RS 4n -Set the root filesystem type to the listed value. -.RE - -.sp -.ne 2 -.na -\fB\fBmoddir:\fR <\fIfirst module path\fR>[[{:, }<\fIsecond ...\fR>]...]\fR -.ad -.sp .6 -.RS 4n -Set the search path for loadable kernel modules. This command operates very -much like the \fBPATH\fR shell variable. Multiple directories to search can be -listed together, delimited either by blank spaces or colons. -.RE - -.sp -.ne 2 -.na -\fB\fBset\fR [\fI<module>\fR:]\fI<symbol>\fR {=, |, &} [~][-]\fI<value>\fR\fR -.ad -.sp .6 -.RS 4n -Set an integer or character pointer in the kernel or in the selected kernel -module to a new value. This command is used to change kernel and module -parameters and thus modify the operation of your system. Assignment operations -are not cumulative, whereas bitwise \fBAND\fR and \fBOR\fR operations are -cumulative. -.sp -Operations that are supported for modifying integer variables are: simple -assignment, inclusive bitwise \fBOR,\fR bitwise \fBAND,\fR one's complement, -and negation. Variables in a specific loadable module can be targeted for -modification by specifying the variable name prefixed with the kernel module -name and a colon (:) separator. Values can be specified as hexadecimal (0x10), -Octal (046), or Decimal (5). -.sp -The only operation supported for modifying character pointers is simple -assignment. Static string data such as character arrays cannot be modified -using the \fBset\fR command. Use care and ensure that the variable you are -modifying is in fact a character pointer. The \fBset\fR command is very -powerful, and will likely cause problems if used carelessly. The following -escape sequences are supported within the quoted string: -.sp -.in +2 -.nf -\en (newline) -\et (tab) -\eb (backspace) -.fi -.in -2 -.sp - -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample \fBsystem\fR file. -.sp -.LP -The following is a sample \fBsystem\fR file. - -.sp -.in +2 -.nf -* Force the ELF exec kernel module to be loaded during kernel -* initialization. Execution type modules are in the exec namespace. -forceload: exec/elfexec -* Change the root device to /sbus@1,f8000000/esp@0,800000/sd@3,0:a. -* You can derive root device names from /devices. -* Root device names must be the fully expanded Open Boot Prom -* device name. This command is platform and configuration specific. -* This example uses the first partition (a) of the SCSI disk at -* SCSI target 3 on the esp host adapter in slot 0 (on board) -* of the SBus of the machine. -* Adapter unit-address 3,0 at sbus unit-address 0,800000. -rootdev: /sbus@1,f8000000/esp@0,800000/sd@3,0:a -* Set the filesystem type of the root to ufs. Note that -* the equal sign can be used instead of the colon. -rootfs:ufs -* Set the search path for kernel modules to look first in -* /usr/phil/mod_test for modules, then in /kernel/modules (the -* default) if not found. Useful for testing new modules. -* Note that you can delimit your module pathnames using -* colons instead of spaces: moddir:/newmodules:/kernel/modules -moddir:/usr/phil/mod_test /kernel/modules. -* Set the configuration option {_POSIX_CHOWN_RESTRICTED} : -* This configuration option is enabled by default. -set rstchown = 1 -* Disable the configuration option {_POSIX_CHOWN_RESTRICTED} : -set rstchown = 0 -* Turn on debugging messages in the modules mydriver. This is useful -* during driver development. -set mydriver:debug = 1 -* Bitwise AND the kernel variable "moddebug" with the -* one's complement of the hex value 0x880, and set -* "moddebug" to this new value. -set moddebug & ~0x880 -* Demonstrate the cumulative effect of the SET -* bitwise AND/OR operations by further modifying "moddebug" -* by ORing it with 0x40. -set moddebug | 0x40 -.fi -.in -2 -.sp - -.SH SEE ALSO -.LP -\fBboot\fR(1M), \fBinit\fR(1M), \fBkernel\fR(1M) -.SH WARNINGS -.LP -Use care when modifying the \fBsystem\fR file; it modifies the operation of the -kernel. If you preserved the original \fBsystem\fR file, you can boot using -\fBboot -a\fR, which will ask you to specify the path to the saved file. This -should allow the system to boot correctly. If you cannot locate a \fBsystem\fR -file that will work, you may specify \fB/dev/null\fR. This acts as an empty -\fBsystem\fR file, and the system will attempt to boot using its default -settings. -.SH NOTES -.LP -The \fBsystem\fR files are read only once, at boot time. diff --git a/usr/src/man/man4/term.4 b/usr/src/man/man4/term.4 deleted file mode 100644 index dbf0b42b19..0000000000 --- a/usr/src/man/man4/term.4 +++ /dev/null @@ -1,218 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved -.\" 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 TERM 4 "Jul 3, 1996" -.SH NAME -term \- format of compiled term file -.SH SYNOPSIS -.LP -.nf -\fB/usr/share/lib/terminfo/?/*\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fBterm\fR file is compiled from \fBterminfo\fR(4) source files using -\fBtic\fR(1M). Compiled files are organized in a directory hierarchy under the -first letter of each terminal name. For example, the \fBvt100\fR file would -have the pathname \fB/usr/lib/terminfo/v/vt100\fR. The default directory is -\fB/usr/share/lib/terminfo\fR. Synonyms for the same terminal are implemented -by multiple links to the same compiled file. -.sp -.LP -The format has been chosen so that it is the same on all hardware. An 8-bit -byte is assumed, but no assumptions about byte ordering or sign extension are -made. Thus, these binary \fBterminfo\fR files can be transported to other -hardware with 8-bit bytes. -.sp -.LP -Short integers are stored in two 8-bit bytes. The first byte contains the least -significant 8 bits of the value, and the second byte contains the most -significant 8 bits. (Thus, the value represented is -256*\fIsecond\fR+\fIfirst\fR.) The value \fB\(mi1\fR is represented by -\fB0377,0377\fR, and the value \fB\(mi2\fR is represented by \fB0376,0377\fR; -other negative values are illegal. The \fB\(mi1\fR generally means that a -capability is missing from this terminal. The \fB\(mi2\fR means that the -capability has been cancelled in the \fBterminfo\fR source and also is to be -considered missing. -.sp -.LP -The compiled file is created from the source file descriptions of the terminals -(see the \fB-I\fR option of \fBinfocmp\fR) by using the \fBterminfo\fR -compiler, \fBtic\fR, and read by the routine \fBsetupterm\fR (see -\fBcurses\fR(3CURSES)). The file is divided into six parts in the following -order: the header, terminal names, boolean flags, numbers, strings, and string -table. -.sp -.LP -The header section begins the file six short integers in the format described -below. These integers are: -.RS +4 -.TP -1. -the magic number (octal \fB0432\fR); -.RE -.RS +4 -.TP -2. -the size, in bytes, of the names section; -.RE -.RS +4 -.TP -3. -the number of bytes in the boolean section -.RE -.RS +4 -.TP -4. -the number of short integers in the numbers section; -.RE -.RS +4 -.TP -5. -the number of offsets (short integers) in the strings section; -.RE -.RS +4 -.TP -6. -the size, in bytes, of the string table. -.RE -.sp -.LP -The terminal name section comes next. It contains the first line of the -\fBterminfo\fR description, listing the various names for the terminal, -separated by the bar ( | ) character (see \fBterm\fR(5)). The section is -terminated with an \fBASCII NUL\fR character. -.sp -.LP -The terminal name section is followed by the Boolean section, number section, -string section, and string table. -.sp -.LP -The boolean flags section consists of one byte for each flag. This byte is -either \fB0\fR or \fB1\fR as the flag is present or absent. The value of -\fB2\fR means that the flag has been cancelled. The capabilities are in the -same order as the file <\fBterm.h\fR>. -.sp -.LP -Between the boolean flags section and the number section, a null byte is -inserted, if necessary, to ensure that the number section begins on an even -byte offset. All short integers are aligned on a short word boundary. -.sp -.LP -The numbers section is similar to the boolean flags section. Each capability -takes up two bytes, and is stored as a short integer. If the value represented -is \fB\(mi1\fR or \fB\(mi2\fR, the capability is taken to be missing. -.sp -.LP -The strings section is also similar. Each capability is stored as a short -integer, in the format above. A value of \fB\(mi1\fR or \fB\(mi2\fR means the -capability is missing. Otherwise, the value is taken as an offset from the -beginning of the string table. Special characters in ^X or \ec notation are -stored in their interpreted form, not the printing representation. Padding -information ($<nn>) and parameter information (%x) are stored intact in -uninterpreted form. -.sp -.LP -The final section is the string table. It contains all the values of string -capabilities referenced in the string section. Each string is null terminated. -.sp -.LP -Note that it is possible for \fBsetupterm\fR to expect a different set of -capabilities than are actually present in the file. Either the database may -have been updated since \fBsetupterm\fR has been recompiled (resulting in extra -unrecognized entries in the file) or the program may have been recompiled more -recently than the database was updated (resulting in missing entries). The -routine \fBsetupterm\fR must be prepared for both possibilities\(emthis is why -the numbers and sizes are included. Also, new capabilities must always be added -at the end of the lists of boolean, number, and string capabilities. -.sp -.LP -As an example, here is terminal information on the AT&T Model 37 KSR terminal -as output by the \fBinfocmp \fR\fB-I\fR\fB tty37\fR command: -.sp -.in +2 -.nf -37|tty37|AT&T model 37 teletype, - hc, os, xon, - bel=^G, cr=\er, cub1=\eb, cud1=\en, cuu1=\eE7, hd=\eE9, - hu=\eE8, ind=\en, -.fi -.in -2 -.sp - -.sp -.LP -The following is an octal dump of the corresponding \fBterm\fR file, produced -by the \fBod -c /usr/share/lib/terminfo/t/tty37\fR command: -.sp -.in +2 -.nf -0000000 032 001 \e0 032 \e0 013 \e0 021 001 3 \e0 3 7 | t -0000020 t y 3 7 | A T & T m o d e l -0000040 3 7 t e l e t y p e \e0 \e0 \e0 \e0 \e0 -0000060 \e0 \e0 \e0 001 \e0 \e0 \e0 \e0 \e0 \e0 \e0 001 \e0 \e0 \e0 \e0 -0000100 001 \e0 \e0 \e0 \e0 \e0 377 377 377 377 377 377 377 377 377 377 -0000120 377 377 377 377 377 377 377 377 377 377 377 377 377 377 & \e0 -0000140 \e0 377 377 377 377 377 377 377 377 377 377 377 377 377 377 -0000160 377 377 " \e0 377 377 377 377 ( \e0 377 377 377 377 377 377 -0000200 377 377 0 \e0 377 377 377 377 377 377 377 377 - \e0 377 377 -0000220 377 377 377 377 377 377 377 377 377 377 377 377 377 377 377 377 - * -0000520 377 377 377 377 377 377 377 377 377 377 377 377 377 377 $ \e0 -0000540 377 377 377 377 377 377 377 377 377 377 377 377 377 377 * \e0 -0000560 377 377 377 377 377 377 377 377 377 377 377 377 377 377 377 377 - * -0001160 377 377 377 377 377 377 377 377 377 377 377 377 377 377 3 7 -0001200 | t t y 3 7 | A T & T m o d e -0001220 l 3 7 t e l e t y p e \e0 \er \e0 -0001240 \en \e0 \en \e0 007 \e0 \eb \e0 033 8 \e0 033 9 \e0 033 7 -0001260 \e0 \e0 -0001261 -.fi -.in -2 -.sp - -.sp -.LP -Some limitations: total compiled entries cannot exceed 4096 bytes; all entries -in the name field cannot exceed 128 bytes. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/usr/share/lib/terminfo/?/*\fR\fR -.ad -.sp .6 -.RS 4n -compiled terminal description database -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/include/term.h\fR\fR -.ad -.sp .6 -.RS 4n -\fBterminfo\fR header -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/xpg4/include/term.h\fR\fR -.ad -.sp .6 -.RS 4n -X/Open Curses \fBterminfo\fR header -.RE - -.SH SEE ALSO -.sp -.LP -\fBinfocmp\fR(1M), \fBcurses\fR(3CURSES), \fBcurses\fR(3XCURSES), -\fBterminfo\fR(4), \fBterm\fR(5) diff --git a/usr/src/man/man4/terminfo.4 b/usr/src/man/man4/terminfo.4 deleted file mode 100644 index 1666d8e3f9..0000000000 --- a/usr/src/man/man4/terminfo.4 +++ /dev/null @@ -1,2917 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved. -.\" 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 TERMINFO 4 "June 20, 2021" -.SH NAME -terminfo \- terminal and printer capability database -.SH SYNOPSIS -.nf -\fB/usr/share/lib/terminfo/?/*\fR -.fi - -.SH DESCRIPTION -The \fBterminfo\fR database describes the capabilities of devices such as -terminals and printers. Devices are described in \fBterminfo\fR source files by -specifying a set of capabilities, by quantifying certain aspects of the device, -and by specifying character sequences that affect particular results. This -database is often used by screen oriented applications such as \fBvi\fR and -\fBcurses\fR-based programs, as well as by some system commands such as -\fBls\fR and \fBmore\fR. This usage allows them to work with a variety of -devices without changes to the programs. -.sp -.LP -\fBterminfo\fR descriptions are located in the directory pointed to by the -environment variable \fBTERMINFO\fR or in \fB/usr/share/lib/terminfo\fR. -\fBterminfo\fR descriptions are generated by \fBtic\fR(1M). -.sp -.LP -\fBterminfo\fR source files consist of one or more device descriptions. Each -description consists of a header (beginning in column 1) and one or more lines -that list the features for that particular device. Every line in a -\fBterminfo\fR source file must end in a comma (\fB,\fR). Every line in a -\fBterminfo\fR source file except the header must be indented with one or more -white spaces (either spaces or tabs). -.sp -.LP -Entries in \fBterminfo\fR source files consist of a number of comma-separated -fields. White space after each comma is ignored. Embedded commas must be -escaped by using a backslash. Each device entry has the following format: -.sp -.in +2 -.nf -\fBalias\fR1 | \fBalias\fR2 | .\|.\|. | \fBalias\fRn | \fIfullname\fR, - capability1, \fIcapability\fR2, - . - . - . - \fIcapability\fRn, -.fi -.in -2 -.sp - -.sp -.LP -The first line, commonly referred to as the header line, must begin in column -one and must contain at least two aliases separated by vertical bars. The last -field in the header line must be the long name of the device and it may -contain any string. Alias names must be unique in the \fBterminfo\fR database -and they must conform to system file naming conventions. See \fBtic\fR(1M). -They cannot, for example, contain white space or slashes. -.sp -.LP -Every device must be assigned a name, such as "vt100". Device names (except the -long name) should be chosen using the following conventions. The name should -not contain hyphens because hyphens are reserved for use when adding suffixes -that indicate special modes. -.sp -.LP -These special modes may be modes that the hardware can be in, or user -preferences. To assign a special mode to a particular device, append a suffix -consisting of a hyphen and an indicator of the mode to the device name. For -example, the \fB-w\fR suffix means "wide mode". When specified, it allows for a -width of 132 columns instead of the standard 80 columns. Therefore, if you want -to use a "vt100" device set to wide mode, name the device "vt100-w". Use the -following suffixes where possible. -.sp - -.sp -.TS -l l l l -l l l l . - Suffix Meaning Example - \fB-w\fR Wide mode (more than 80 columns) \fB5410-w\fR - \fB-am\fR With auto. margins (usually default) \fBvt100-am\fR - \fB-nam\fR Without automatic margins \fBvt100-nam\fR - \fI-n\fR Number of lines on the screen \fB2300-40\fR - \fB-na\fR No arrow keys (leave them in local) \fBc100-na\fR - -\fIn\fRp Number of pages of memory \fBc100-4p\fR - \fB-rv\fR Reverse video \fB4415-rv\fR -.TE - -.sp -.LP -The \fBterminfo\fR reference manual page is organized in two sections: -.RS +4 -.TP -.ie t \(bu -.el o -\fBPART 1: DEVICE CAPABILITIES\fR -.RE -.RS +4 -.TP -.ie t \(bu -.el o -\fBPART 2: PRINTER CAPABILITIES\fR -.RE -.SS "PART 1: DEVICE CAPABILITIES" -Capabilities in \fBterminfo\fR are of three types: Boolean capabilities (which -show that a device has or does not have a particular feature), numeric -capabilities (which quantify particular features of a device), and string -capabilities (which provide sequences that can be used to perform particular -operations on devices). -.sp -.LP -In the following table, a \fBVariable\fR is the name by which a \fBC\fR -programmer accesses a capability (at the \fBterminfo\fR level). A \fBCapname\fR -is the short name for a capability specified in the \fBterminfo\fR source file. -It is used by a person updating the source file and by the \fBtput\fR command. -A \fBTermcap Code\fR is a two-letter sequence that corresponds to the -\fBtermcap\fR capability name. (Note that \fBtermcap\fR is no longer -supported.) -.sp -.LP -Capability names have no real length limit, but an informal limit of five -characters has been adopted to keep them short. Whenever possible, capability -names are chosen to be the same as or similar to those specified by the ANSI -X3.64-1979 standard. Semantics are also intended to match those of the ANSI -standard. -.sp -.LP -All string capabilities listed below may have padding specified, with the -exception of those used for input. Input capabilities, listed under the -\fBStrings\fR section in the following tables, have names beginning with -\fBkey_\fR. The \fB#i\fR symbol in the description field of the following -tables refers to the \fIi\fRth parameter. -.SS "Booleans" -.in +2 -.nf -________________________________________________________________ - Cap- Termcap -Variable name Code Description -________________________________________________________________ - -auto_left_margin bw bw cub1 wraps from column 0 to - last column -auto_right_margin am am Terminal has automatic margins -back_color_erase bce be Screen erased with background - color -can_change ccc cc Terminal can re-define existing - color -ceol_standout_glitch xhp xs Standout not erased by - overwriting (hp) -col_addr_glitch xhpa YA Only positive motion - for hpa/mhpa caps -cpi_changes_res cpix YF Changing character pitch - changes resolution -cr_cancels_micro_mode crxm YB Using cr turns off micro mode -dest_tabs_magic_smso xt xt Destructive tabs, magic - smso char (t1061) -eat_newline_glitch xenl xn Newline ignored after - 80 columns (Concept) -erase_overstrike eo eo Can erase overstrikes with a - blank -generic_type gn gn Generic line type - (for example, dialup, switch) -hard_copy hc hc Hardcopy terminal -hard_cursor chts HC Cursor is hard to see -has_meta_key km km Has a meta key (shift, - sets parity bit) -has_print_wheel daisy YC Printer needs operator - to change character set -has_status_line hs hs Has extra "status line" -hue_lightness_saturation hls hl Terminal uses only HLS - color notation (Tektronix) -insert_null_glitch in in Insert mode distinguishes nulls -lpi_changes_res lpix YG Changing line pitch - changes resolution -memory_above da da Display may be retained - above the screen -memory_below db db Display may be retained - below the screen -move_insert_mode mir mi Safe to move while in insert - mode -move_standout_mode msgr ms Safe to move in standout modes -needs_xon_xoff nxon nx Padding won't work, - xon/xoff required -no_esc_ctlc xsb xb Beehive (f1=escape, f2=ctrl C) -no_pad_char npc NP Pad character doesn't exist -non_dest_scroll_region ndscr ND Scrolling region - is nondestructive -non_rev_rmcup nrrmc NR smcup does not reverse rmcup -over_strike os os Terminal overstrikes - on hard-copy terminal -prtr_silent mc5i 5i Printer won't echo on screen -row_addr_glitch xvpa YD Only positive motion - for vpa/mvpa caps -semi_auto_right_margin sam YE Printing in last column causes - cr -status_line_esc_ok eslok es Escape can be used on - the status line -tilde_glitch hz hz Hazeltine; can't print tilde (~) -transparent_underline ul ul Underline character overstrikes -xon_xoff xon xo Terminal uses xon/xoff - handshaking -.fi -.in -2 -.sp - -.SS "Numbers" -.in +2 -.nf -________________________________________________________________ - Cap- Termcap -Variable name Code Description -________________________________________________________________ - -bit_image_entwining bitwin Yo Number of passes for each - bit-map row -bit_image_type bitype Yp Type of bit image device -buffer_capacity bufsz Ya Number of bytes buffered - before printing -buttons btns BT Number of buttons on the mouse -columns cols co Number of columns in a line -dot_horz_spacing spinh Yc Spacing of dots horizontally - in dots per inch -dot_vert_spacing spinv Yb Spacing of pins vertically - in pins per inch -init_tabs it it Tabs initially every # spaces -label_height lh lh Number of rows in each label -label_width lw lw Number of columns in each label -lines lines li Number of lines on a screen or - a page -lines_of_memory lm lm Lines of memory if > lines; - 0 means varies -max_attributes ma ma Maximum combined video attributes - terminal can display -magic_cookie_glitch xmc sg Number of blank characters - left by smso or rmso -max_colors colors Co Maximum number of colors - on the screen -max_micro_address maddr Yd Maximum value in - micro_..._address -max_micro_jump mjump Ye Maximum value in parm_..._micro -max_pairs pairs pa Maximum number of - color-pairs on the screen -maximum_windows Wnum MW Maximum number of definable windows -micro_char_size mcs Yf Character step size when - in micro mode -micro_line_size mls Yg Line step size when in micro mode -no_color_video ncv NC Video attributes that - can't be used with colors -num_labels nlab Nl Number of labels on screen -number_of_pins npins Yh Number of pins in print-head -output_res_char orc Yi Horizontal resolution in - units per character -output_res_line orl Yj Vertical resolution in units per - line -output_res_horz_inch orhi Yk Horizontal resolution in - units per inch -output_res_vert_inch orvi Yl Vertical resolution in - units per inch -padding_baud_rate pb pb Lowest baud rate -print_rate cps Ym Print rate in characters per second - where padding needed -virtual_terminal vt vt Virtual terminal number (system) -wide_char_size widcs Yn Character step size when - in double wide mode -width_status_line wsl ws Number of columns in status line -.fi -.in -2 -.sp - -.SS "Strings" -.in +2 -.nf -________________________________________________________________ - Cap- Termcap -Variable name Code Description -________________________________________________________________ - -acs_chars acsc ac Graphic charset pairs aAbBcC -alt_scancode_esc scesa S8 Alternate escape for - scancode emulation - (default is for vt100) -back_tab cbt bt Back tab -bell bel bl Audible signal (bell) -bit_image_carriage_return bicr Yv Move to beginning of - same row (use tparm) -bit_image_newline binel Zz Move to next row of - the bit image (use tparm) -bit_image_repeat birep Zy Repeat bit-image cell - #1 #2 times (use tparm) -carriage_return cr cr Carriage return -change_char_pitch cpi ZA Change number of - characters per inch -change_line_pitch lpi ZB Change number of lines per inch -change_res_horz chr ZC Change horizontal resolution -change_res_vert cvr ZD Change vertical resolution -change_scroll_region csr cs Change to lines #1 - through #2 (vt100) -char_padding rmp rP Like ip but when in replace - mode -char_set_names csnm Zy List of character set names -clear_all_tabs tbc ct Clear all tab stops -clear_margins mgc MC Clear all margins - (top, bottom, and sides) -clear_screen clear cl Clear screen and home cursor -clr_bol el1 cb Clear to beginning of - line, inclusive -clr_eol el ce Clear to end of line -clr_eos ed cd Clear to end of display -code_set_init csin ci Init sequence - for multiple codesets -color_names colornm Yw Give name for color #1 -column_address hpa ch Horizontal position -command_character cmdch CC Terminal settable cmd - character in prototype -create_window cwin CW Define win #1 to go - from #2,#3to #4,#5 -cursor_address cup cm Move to row #1 col #2 -cursor_down cud1 do Down one line -cursor_home home ho Home cursor (if no cup) -cursor_invisible civis vi Make cursor invisible -cursor_left cub1 le Move left one space. -cursor_mem_address mrcup CM Memory relative cursor - addressing -cursor_normal cnorm ve Make cursor appear - normal (undo vs/vi) -cursor_right cuf1 nd Non-destructive space - (cursor or carriage right) -cursor_to_ll ll ll Last line, first - column (if no cup) -cursor_up cuu1 up Upline (cursor up) -cursor_visible cvvis vs Make cursor very visible -define_bit_image_region defbi Yx Define rectangular bit- - image region (use tparm) -define_char defc ZE Define a character in - a character set -delete_character dch1 dc Delete character -delete_line dl1 dl Delete line -device_type devt dv Indicate language/ - codeset support -dial_phone dial DI Dial phone number #1 -dis_status_line dsl ds Disable status line -display_clock dclk DK Display time-of-day clock -display_pc_char dispc S1 Display PC character -down_half_line hd hd Half-line down (forward - 1/2 linefeed) -ena_acs enacs eA Enable alternate character set -end_bit_image_region endbi Yy End a bit-image region - (use tparm) -enter_alt_charset_mode smacs as Start alternate character set -enter_am_mode smam SA Turn on automatic margins -enter_blink_mode blink mb Turn on blinking -enter_bold_mode bold md Turn on bold (extra - bright) mode -enter_ca_mode smcup ti String to begin programs - that use cup -enter_delete_mode smdc dm Delete mode (enter) -enter_dim_mode dim mh Turn on half-bright mode -enter_doublewide_mode swidm ZF Enable double wide printing -enter_draft_quality sdrfq ZG Set draft quality print mode -enter_insert_mode smir im Insert mode (enter) -enter_italics_mode sitm ZH Enable italics -enter_leftward_mode slm ZI Enable leftward carriage - motion -enter_micro_mode smicm ZJ Enable micro motion - capabilities -enter_near_letter_quality snlq ZK Set near-letter quality print -enter_normal_quality snrmq ZL Set normal quality -enter_pc_charset_mode smpch S2 Enter PC character display mode -enter_protected_mode prot mp Turn on protected mode -enter_reverse_mode rev mr Turn on reverse video mode -enter_scancode_mode smsc S4 Enter PC scancode mode -enter_scancode_mode smsc S4 Enter PC scancode mode -enter_secure_mode invis mk Turn on blank mode - (characters invisible) -enter_shadow_mode sshm ZM Enable shadow printing -enter_standout_mode smso so Begin standout mode -enter_subscript_mode ssubm ZN Enable subscript printing -enter_superscript_mode ssupm ZO Enable superscript printing -enter_underline_mode smul us Start underscore mode -enter_upward_mode sum ZP Enable upward carriage motion - mode -enter_xon_mode smxon SX Turn on xon/xoff handshaking -erase_chars ech ec Erase #1 characters -exit_alt_charset_mode rmacs ae End alternate character set -exit_am_mode rmam RA Turn off automatic margins -exit_attribute_mode sgr0 me Turn off all attributes -exit_ca_mode rmcup te String to end programs - that use cup -exit_delete_mode rmdc ed End delete mode -exit_doublewide_mode rwidm ZQ Disable double wide printing -exit_insert_mode rmir ei End insert mode -exit_italics_mode ritm ZR Disable italics -exit_leftward_mode rlm ZS Enable rightward (normal) - carriage motion -exit_micro_mode rmicm ZT Disable micro motion - capabilities -exit_pc_charset_mode rmpch S3 Disable PC character - display mode -exit_scancode_mode rmsc S5 Disable PC scancode mode -exit_shadow_mode rshm ZU Disable shadow printing -exit_standout_mode rmso se End standout mode -exit_subscript_mode rsubm ZV Disable subscript printing -exit_superscript_mode rsupm ZW Disable superscript printing -exit_underline_mode rmul ue End underscore mode -exit_upward_mode rum ZX Enable downward (normal) - carriage motion -exit_xon_mode rmxon RX Turn off xon/xoff handshaking -fixed_pause pause PA Pause for 2-3 seconds -flash_hook hook fh Flash the switch hook -flash_screen flash vb Visible bell (may - not move cursor) -form_feed ff ff Hardcopy terminal page eject -from_status_line fsl fs Return from status line -get_mouse getm Gm Curses should get button events -goto_window wingo WG Go to window #1 -hangup hup HU Hang-up phone -init_1string is1 i1 Terminal or printer - initialization string -init_2string is2 is Terminal or printer - initialization string -init_3string is3 i3 Terminal or printer - initialization string -init_file if if Name of initialization file -init_prog iprog iP Path name of program - for initialization -initialize_color initc Ic Initialize the - definition of color -initialize_pair initp Ip Initialize color-pair -insert_character ich1 ic Insert character -insert_line il1 al Add new blank line -insert_padding ip ip Insert pad after - character inserted -.fi -.in -2 -.sp - -.SS "key_Strings" -The ``\fBkey_\fR'' strings are sent by specific keys. The ``\fBkey_\fR'' -descriptions include the macro, defined in \fB<curses.h>\fR, for the code -returned by the \fBcurses\fR routine \fBgetch\fR when the key is pressed (see -\fBcurs_getch\fR(3CURSES)). -.sp -.in +2 -.nf -________________________________________________________________ - Cap- Termcap -Variable name Code Description -________________________________________________________________ - -key_a1 ka1 K1 KEY_A1, upper left of keypad -key_a3 ka3 K3 KEY_A3, upper right of keypad -key_b2 kb2 K2 KEY_B2, center of keypad -key_backspace kbs kb KEY_BACKSPACE, sent by - backspace key -key_beg kbeg @1 KEY_BEG, sent by beg(inning) key -key_btab kcbt kB KEY_BTAB, sent by back-tab key -key_c1 kc1 K4 KEY_C1, lower left of keypad -key_c3 kc3 K5 KEY_C3, lower right of keypad -key_cancel kcan @2 KEY_CANCEL, sent by cancel key -key_catab ktbc ka KEY_CATAB, sent by - clear-all-tabs key -key_clear kclr kC KEY_CLEAR, sent by - clear-screen or erase key -key_close kclo @3 KEY_CLOSE, sent by close key -key_command kcmd @4 KEY_COMMAND, sent by - cmd (command) key -key_copy kcpy @5 KEY_COPY, sent by copy key -key_create kcrt @6 KEY_CREATE, sent by create key -key_ctab kctab kt KEY_CTAB, sent by clear-tab key -key_dc kdch1 kD KEY_DC, sent by delete-character - key -key_dl kdl1 kL KEY_DL, sent by delete-line key -key_down kcud1 kd KEY_DOWN, sent by terminal - down-arrow key -key_eic krmir kM KEY_EIC, sent by rmir or smir in - insert mode -key_end kend @7 KEY_END, sent by end key -key_enter kent @8 KEY_ENTER, sent by enter/send - key -key_eol kel kE KEY_EOL, sent by - clear-to-end-of-line key -key_eos ked kS KEY_EOS, sent by - clear-to-end-of-screen key -key_exit kext @9 KEY_EXIT, sent by exit key -key_f0 kf0 k0 KEY_F(0), sent by function key f0 -key_f1 kf1 k1 KEY_F(1), sent by function key f1 -key_f2 kf2 k2 KEY_F(2), sent by function key f2 -key_f3 kf3 k3 KEY_F(3), sent by function key f3 -key_fB kf4 k4 KEY_F(4), sent by function key fB -key_f5 kf5 k5 KEY_F(5), sent by function key f5 -key_f6 kf6 k6 KEY_F(6), sent by function key f6 -key_f7 kf7 k7 KEY_F(7), sent by function key f7 -key_f8 kf8 k8 KEY_F(8), sent by function key f8 -key_f9 kf9 k9 KEY_F(9), sent by function key f9 - -key_f10 kf10 k; KEY_F(10), sent by function key - f10 -key_f11 kf11 F1 KEY_F(11), sent by function key - f11 -key_f12 kf12 F2 KEY_F(12), sent by function key - f12 -key_f13 kf13 F3 KEY_F(13), sent by function key - f13 -key_f14 kf14 F4 KEY_F(14), sent by function key - f14 -key_f15 kf15 F5 KEY_F(15), sent by function key - f15 -key_f16 kf16 F6 KEY_F(16), sent by function key - f16 -key_f17 kf17 F7 KEY_F(17), sent by function key - f17 -key_f18 kf18 F8 KEY_F(18), sent by function key - f18 -key_f19 kf19 F9 KEY_F(19), sent by function key - f19 -key_f20 kf20 FA KEY_F(20), sent by function key - f20 -key_f21 kf21 FB KEY_F(21), sent by function key - f21 -key_f22 kf22 FC KEY_F(22), sent by function key - f22 -key_f23 kf23 FD KEY_F(23), sent by function key - f23 -key_f24 kf24 FE KEY_F(24), sent by function key - f24 -key_f25 kf25 FF KEY_F(25), sent by function key - f25 -key_f26 kf26 FG KEY_F(26), sent by function key - f26 -key_f27 kf27 FH KEY_F(27), sent by function key - f27 -key_f28 kf28 FI KEY_F(28), sent by function key - f28 -key_f29 kf29 FJ KEY_F(29), sent by function key - f29 -key_f30 kf30 FK KEY_F(30), sent by function key - f30 -key_f31 kf31 FL KEY_F(31), sent by function key - f31 -key_f32 kf32 FM KEY_F(32), sent by function key - f32 -key_f33 kf33 FN KEY_F(13), sent by function key - f13 -key_f34 kf34 FO KEY_F(34), sent by function key - f34 -key_f35 kf35 FP KEY_F(35), sent by function key - f35 -key_f36 kf36 FQ KEY_F(36), sent by function key - f36 -key_f37 kf37 FR KEY_F(37), sent by function key - f37 -key_f38 kf38 FS KEY_F(38), sent by function key - f38 -key_f39 kf39 FT KEY_F(39), sent by function key - f39 -key_fB0 kf40 FU KEY_F(40), sent by function key - fB0 -key_fB1 kf41 FV KEY_F(41), sent by function key - fB1 -key_fB2 kf42 FW KEY_F(42), sent by function key - fB2 -key_fB3 kf43 FX KEY_F(43), sent by function key - fB3 -key_fB4 kf44 FY KEY_F(44), sent by function key - fB4 -key_fB5 kf45 FZ KEY_F(45), sent by function key - fB5 -key_fB6 kf46 Fa KEY_F(46), sent by function key - fB6 -key_fB7 kf47 Fb KEY_F(47), sent by function key - fB7 -key_fB8 kf48 Fc KEY_F(48), sent by function key - fB8 -key_fB9 kf49 Fd KEY_F(49), sent by function key - fB9 -key_f50 kf50 Fe KEY_F(50), sent by function key - f50 -key_f51 kf51 Ff KEY_F(51), sent by function key - f51 -key_f52 kf52 Fg KEY_F(52), sent by function key - f52 -key_f53 kf53 Fh KEY_F(53), sent by function key - f53 -key_f54 kf54 Fi KEY_F(54), sent by function key - f54 -key_f55 kf55 Fj KEY_F(55), sent by function key - f55 -key_f56 kf56 Fk KEY_F(56), sent by function key - f56 -key_f57 kf57 Fl KEY_F(57), sent by function key - f57 -key_f58 kf58 Fm KEY_F(58), sent by function key - f58 -key_f59 kf59 Fn KEY_F(59), sent by function key - f59 -key_f60 kf60 Fo KEY_F(60), sent by function key - f60 -key_f61 kf61 Fp KEY_F(61), sent by function key - f61 -key_f62 kf62 Fq KEY_F(62), sent by function key - f62 -key_f63 kf63 Fr KEY_F(63), sent by function key - f63 -key_find kfnd @0 KEY_FIND, sent by find key -key_help khlp %1 KEY_HELP, sent by help key -key_home khome kh KEY_HOME, sent by home key -key_ic kich1 kI KEY_IC, sent by ins-char/enter - ins-mode key -key_il kil1 kA KEY_IL, sent by insert-line key -key_left kcub1 kl KEY_LEFT, sent by - terminal left-arrow key -key_ll kll kH KEY_LL, sent by home-down key -key_mark kmrk %2 KEY_MARK, sent by -key_message kmsg %3 KEY_MESSAGE, sent by message key -key_mouse kmous Km 0631, Mouse event has occurred -key_move kmov %4 KEY_MOVE, sent by move key -key_next knxt %5 KEY_NEXT, sent by next-object - key -key_npage knp kN KEY_NPAGE, sent by next-page - key -key_open kopn %6 KEY_OPEN, sent by open key -key_options kopt %7 KEY_OPTIONS, sent by options - key -key_ppage kpp kP KEY_PPAGE, sent by - previous-page key -key_previous kprv %8 KEY_PREVIOUS, sent by - previous-object key -key_print kprt %9 KEY_PRINT, sent by - print or copy key -key_redo krdo %0 KEY_REDO, sent by redo key -key_reference kref &1 KEY_REFERENCE, sent by - reference key -key_refresh krfr &2 KEY_REFRESH, sent by - refresh key -key_replace krpl &3 KEY_REPLACE, sent by - replace key -key_restart krst &4 KEY_RESTART, sent by - restart key -key_resume kres &5 KEY_RESUME, sent by resume key -key_right kcuf1 kr KEY_RIGHT, sent by terminal - right-arrow key -key_save ksav &6 KEY_SAVE, sent by save key -key_sbeg kBEG &9 KEY_SBEG, sent by - shifted beginning key -key_scancel kCAN &0 KEY_SCANCEL, sent by - shifted cancel key -key_scommand kCMD *1 KEY_SCOMMAND, sent by - shifted command key -key_scopy kCPY *2 KEY_SCOPY, sent by - shifted copy key -key_screate kCRT *3 KEY_SCREATE, sent by - shifted create key -key_sdc kDC *4 KEY_SDC, sent by - shifted delete-char key -key_sdl kDL *5 KEY_SDL, sent by - shifted delete-line key -key_select kslt *6 KEY_SELECT, sent by - select key -key_send kEND *7 KEY_SEND, sent by - shifted end key -key_seol kEOL *8 KEY_SEOL, sent by - shifted clear-line key -key_sexit kEXT *9 KEY_SEXIT, sent by - shifted exit key -key_sf kind kF KEY_SF, sent by - scroll-forward/down key -key_sfind kFND *0 KEY_SFIND, sent by - shifted find key -key_shelp kHLP #1 KEY_SHELP, sent by - shifted help key -key_shome kHOM #2 KEY_SHOME, sent by - shifted home key -key_sic kIC #3 KEY_SIC, sent by - shifted input key -key_sleft kLFT #4 KEY_SLEFT, sent by - shifted left-arrow key -key_smessage kMSG %a KEY_SMESSAGE, sent by - shifted message key -key_smove kMOV %b KEY_SMOVE, sent by - shifted move key -key_snext kNXT %c KEY_SNEXT, sent by - shifted next key -key_soptions kOPT %d KEY_SOPTIONS, sent by - shifted options key -key_sprevious kPRV %e KEY_SPREVIOUS, sent by - shifted prev key -key_sprint kPRT %f KEY_SPRINT, sent by - shifted print key -key_sr kri kR KEY_SR, sent by - scroll-backward/up key -key_sredo kRDO %g KEY_SREDO, sent by - shifted redo key -key_sreplace kRPL %h KEY_SREPLACE, sent by - shifted replace key -key_sright kRIT %i KEY_SRIGHT, sent by shifted - right-arrow key -key_srsume kRES %j KEY_SRSUME, sent by - shifted resume key -key_ssave kSAV !1 KEY_SSAVE, sent by - shifted save key -key_ssuspend kSPD !2 KEY_SSUSPEND, sent by - shifted suspend key -key_stab khts kT KEY_STAB, sent by - set-tab key -key_sundo kUND !3 KEY_SUNDO, sent by - shifted undo key -key_suspend kspd &7 KEY_SUSPEND, sent by - suspend key -key_undo kund &8 KEY_UNDO, sent by undo key -key_up kcuu1 ku KEY_UP, sent by - terminal up-arrow key -keypad_local rmkx ke Out of - ``keypad-transmit'' mode -keypad_xmit smkx ks Put terminal in - ``keypad-transmit'' mode -lab_f0 lf0 l0 Labels on function key - f0 if not f0 -lab_f1 lf1 l1 Labels on function key - f1 if not f1 -lab_f2 lf2 l2 Labels on function key - f2 if not f2 -lab_f3 lf3 l3 Labels on function key - f3 if not f3 -lab_fB lfB l4 Labels on function key - fB if not fB -lab_f5 lf5 l5 Labels on function key - f5 if not f5 -lab_f6 lf6 l6 Labels on function key - f6 if not f6 -lab_f7 lf7 l7 Labels on function key - f7 if not f7 -lab_f8 lf8 l8 Labels on function key - f8 if not f8 -lab_f9 lf9 l9 Labels on function key - f9 if not f9 -lab_f10 lf10 la Labels on function key - f10 if not f10 -label_format fln Lf Label format -label_off rmln LF Turn off soft labels -label_on smln LO Turn on soft labels -meta_off rmm mo Turn off "meta mode" -meta_on smm mm Turn on "meta mode" (8th bit) -micro_column_address mhpa ZY Like column_address - for micro adjustment -micro_down mcud1 ZZ Like cursor_down - for micro adjustment -micro_left mcub1 Za Like cursor_left - for micro adjustment -micro_right mcuf1 Zb Like cursor_right - for micro adjustment -micro_row_address mvpa Zc Like row_address - for micro adjustment -micro_up mcuu1 Zd Like cursor_up - for micro adjustment -mouse_info minfo Mi Mouse status information -newline nel nw Newline (behaves like - cr followed by lf) -order_of_pins porder Ze Matches software bits - to print-head pins -orig_colors oc oc Set all color(-pair)s - to the original ones -orig_pair op op Set default color-pair - to the original one -pad_char pad pc Pad character (rather than null) -parm_dch dch DC Delete #1 chars -parm_delete_line dl DL Delete #1 lines -parm_down_cursor cud DO Move down #1 lines -parm_down_micro mcud Zf Like parm_down_cursor - for micro adjust -parm_ich ich IC Insert #1 blank chars -parm_index indn SF Scroll forward #1 lines -parm_insert_line il AL Add #1 new blank lines -parm_left_cursor cub LE Move cursor left #1 spaces -parm_left_micro mcub Zg Like parm_left_cursor - for micro adjust -parm_right_cursor cuf RI Move right #1 spaces -parm_right_micro mcuf Zh Like parm_right_cursor - for micro adjust -parm_rindex rin SR Scroll backward #1 lines -parm_up_cursor cuu UP Move cursor up #1 lines -parm_up_micro mcuu Zi Like parm_up_cursor - for micro adjust -pc_term_options pctrm S6 PC terminal options -pkey_key pfkey pk Prog funct key #1 to - type string #2 -pkey_local pfloc pl Prog funct key #1 to - execute string #2 -pkey_plab pfxl xl Prog key #1 to xmit - string #2 and show string #3 -pkey_xmit pfx px Prog funct key #1 to - xmit string #2 -plab_norm pln pn Prog label #1 to show - string #2 -print_screen mc0 ps Print contents of the screen -prtr_non mc5p pO Turn on the printer for #1 bytes -prtr_off mc4 pf Turn off the printer -prtr_on mc5 po Turn on the printer -pulse pulse PU Select pulse dialing -quick_dial qdial QD Dial phone number #1, without - progress detection -remove_clock rmclk RC Remove time-of-day clock -repeat_char rep rp Repeat char #1 #2 times -req_for_input rfi RF Send next input char (for ptys) -req_mouse_pos reqmp RQ Request mouse position report -reset_1string rs1 r1 Reset terminal completely to - sane modes -reset_2string rs2 r2 Reset terminal completely to - sane modes -reset_3string rs3 r3 Reset terminal completely to - sane modes -reset_file rf rf Name of file containing - reset string -restore_cursor rc rc Restore cursor to - position of last sc -row_address vpa cv Vertical position absolute -save_cursor sc sc Save cursor position -scancode_escape scesc S7 Escape for scancode emulation -scroll_forward ind sf Scroll text up -scroll_reverse ri sr Scroll text down -select_char_set scs Zj Select character set -set0_des_seq s0ds s0 Shift into codeset 0 - (EUC set 0, ASCII) -set1_des_seq s1ds s1 Shift into codeset 1 -set2_des_seq s2ds s2 Shift into codeset 2 -set3_des_seq s3ds s3 Shift into codeset 3 - attributes #1-#6 -set_a_background setab AB Set background color - using ANSI escape -set_a_foreground setaf AF Set foreground color - using ANSI escape -set_attributes sgr sa Define the video - attributes #1-#9 -set_background setb Sb Set current background color -set_bottom_margin smgb Zk Set bottom margin at - current line -set_bottom_margin_parm smgbp Zl Set bottom margin at - line #1 or #2 - lines from bottom -set_clock sclk SC Set time-of-day clock -set_color_band setcolor YzChange to ribbon color #1 -set_color_pair scp sp Set current color-pair -set_foreground setf Sf Set current foreground color1 -set_left_margin smgl ML Set left margin at current line -set_left_margin_parm smglp Zm Set left (right) margin - at column #1 (#2) -set_lr_margin smglr ML Sets both left and right margins -set_page_length slines YZ Set page length to #1 lines - (use tparm) of an inch -set_right_margin smgr MR Set right margin at - current column -set_right_margin_parm smgrp Zn Set right margin at column #1 -set_tab hts st Set a tab in all rows, - current column -set_tb_margin smgtb MT Sets both top and bottom margins -set_top_margin smgt Zo Set top margin at current line -set_top_margin_parm smgtp Zp Set top (bottom) margin - at line #1 (#2) -set_window wind wi Current window is lines - #1-#2 cols #3-#4 -start_bit_image sbim Zq Start printing bit image graphics -start_char_set_def scsd Zr Start definition of a character - set -stop_bit_image rbim Zs End printing bit image graphics -stop_char_set_def rcsd Zt End definition of a character set -subscript_characters subcs Zu List of ``subscript-able'' - characters -superscript_characters supcs Zv List of ``superscript-able'' - characters -tab ht ta Tab to next 8-space hardware tab - stop -these_cause_cr docr Zw Printing any of these - chars causes cr -to_status_line tsl ts Go to status line, col #1 -tone tone TO Select touch tone dialing -user0 u0 u0 User string 0 -user1 u1 u1 User string 1 -user2 u2 u2 User string 2 -user3 u3 u3 User string 3 -user4 u4 u4 User string 4 -user5 u5 u5 User string 5 -user6 u6 u6 User string 6 -user7 u7 u7 User string 7 -user8 u8 u8 User string 8 -user9 u9 u9 User string 9 -underline_char uc uc Underscore one char - and move past it -up_half_line hu hu Half-line up (reverse - 1/2 linefeed) -wait_tone wait WA Wait for dial tone -xoff_character xoffc XF X-off character -xon_character xonc XN X-on character -zero_motion zerom Zx No motion for the - subsequent character -.fi -.in -2 -.sp - -.SS "Sample Entry" -The following entry, which describes the AT&T 610 terminal, is among the more -complex entries in the \fBterminfo\fR file as of this writing. -.sp -.in +2 -.nf -610|610bct|ATT610|att610|AT&T610;80column;98key keyboard - am, eslok, hs, mir, msgr, xenl, xon, - cols#80, it#8, lh#2, lines#24, lw#8, nlab#8, wsl#80, - acsc=``aaffggjjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~, - bel=^G, blink=\eE[5m, bold=\eE[1m, cbt=\eE[Z, - civis=\eE[?25l, clear=\eE[H\eE[J, cnorm=\eE[?25h\eE[?12l, - cr=\er, csr=\eE[%i%p1%d;%p2%dr, cub=\eE[%p1%dD, cub1=\eb, - cud=\eE[%p1%dB, cud1=\eE[B, cuf=\eE[%p1%dC, cuf1=\eE[C, - cup=\eE[%i%p1%d;%p2%dH, cuu=\eE[%p1%dA, cuu1=\eE[A, - cvvis=\eE[?12;25h, dch=\eE[%p1%dP, dch1=\eE[P, dim=\eE[2m, - dl=\eE[%p1%dM, dl1=\eE[M, ed=\eE[J, el=\eE[K, el1=\eE[1K, - flash=\eE[?5h$<200>\eE[?5l, fsl=\eE8, home=\eE[H, ht=\et, - ich=\eE[%p1%d@, il=\eE[%p1%dL, il1=\eE[L, ind=\eED, .ind=\eED$<9>, - invis=\eE[8m, - is1=\eE[8;0 | \eE[?3;4;5;13;15l\eE[13;20l\eE[?7h\eE[12h\eE(B\eE)0, - is2=\eE[0m^O, is3=\eE(B\eE)0, kLFT=\eE[\es@, kRIT=\eE[\esA, - kbs=^H, kcbt=\eE[Z, kclr=\eE[2J, kcub1=\eE[D, kcud1=\eE[B, - kcuf1=\eE[C, kcuu1=\eE[A, kf1=\eEOc, kf10=\eENp, - kf11=\eENq, kf12=\eENr, kf13=\eENs, kf14=\eENt, kf2=\eEOd, - kf3=\eEOe, kf4=\eEOf, kf5=\eEOg, kf6=\eEOh, kf7=\eEOi, - kf8=\eEOj, kf9=\eENo, khome=\eE[H, kind=\eE[S, kri=\eE[T, - ll=\eE[24H, mc4=\eE[?4i, mc5=\eE[?5i, nel=\eEE, - pfxl=\eE[%p1%d;%p2%l%02dq%?%p1%{9}%<%t\es\es\esF%p1%1d\es\es\es\es\es -\es\es\es\es\es\es%%p2%s, - pln=\eE[%p1%d;0;0;0q%p2%:-16.16s, rc=\eE8, rev=\eE[7m, - ri=\eEM, rmacs=^O, rmir=\eE[4l, rmln=\eE[2p, rmso=\eE[m, - rmul=\eE[m, rs2=\eEc\eE[?3l, sc=\eE7, - sgr=\eE[0%?%p6%t;1%%?%p5%t;2%%?%p2%t;4%%?%p4%t;5% -%?%p3%p1% | %t;7%%?%p7%t;8%m%?%p9%t^N%e^O%, - sgr0=\eE[m^O, smacs=^N, smir=\eE[4h, smln=\eE[p, - smso=\eE[7m, smul=\eE[4m, tsl=\eE7\eE[25;%i%p1%dx, -.fi -.in -2 - -.SS "Types of Capabilities in the Sample Entry" -The sample entry shows the formats for the three types of \fBterminfo\fR -capabilities listed: Boolean, numeric, and string. All capabilities specified -in the \fBterminfo\fR source file must be followed by commas, including the -last capability in the source file. In \fBterminfo\fR source files, -capabilities are referenced by their capability names (as shown in the previous -tables). -.sp -.LP -Boolean capabilities are specified simply by their comma separated cap names. -.sp -.LP -Numeric capabilities are followed by the character `#' and then a positive -integer value. Thus, in the sample, \fBcols\fR (which shows the number of -columns available on a device) is assigned the value \fB80\fR for the AT&T 610. -(Values for numeric capabilities may be specified in decimal, octal, or -hexadecimal, using normal C programming language conventions.) -.sp -.LP -Finally, string-valued capabilities such as \fBel\fR (clear to end of line -sequence) are listed by a two- to five-character capname, an `=', and a string -ended by the next occurrence of a comma. A delay in milliseconds may appear -anywhere in such a capability, preceded by \fB$\fR and enclosed in angle -brackets, as in \fBel=\eEK$<3>\fR. Padding characters are supplied by -\fBtput\fR. The delay can be any of the following: a number, a number followed -by an asterisk, such as \fB5*\fR, a number followed by a slash, such as -\fB5/\fR, or a number followed by both, such as \fB5*/\fR. A `\fB*\fR\fB\&'\fR -shows that the padding required is proportional to the number of lines affected -by the operation, and the amount given is the per-affected-unit padding -required. (In the case of insert characters, the factor is still the number of -lines affected. This is always 1 unless the device has \fBin\fR and the -software uses it.) When a `\fB*\fR\fB\&'\fR is specified, it is sometimes -useful to give a delay of the form \fB3.5\fR to specify a delay per unit to -tenths of milliseconds. (Only one decimal place is allowed.) -.sp -.LP -A `/' indicates that the padding is mandatory. If a device has \fBxon\fR -defined, the padding information is advisory and will only be used for cost -estimates or when the device is in raw mode. Mandatory padding will be -transmitted regardless of the setting of \fBxon\fR. If padding (whether -advisory or mandatory) is specified for \fBbel\fR or \fBflash\fR, however, it -will always be used, regardless of whether \fBxon\fR is specified. -.sp -.LP -\fBterminfo\fR offers notation for encoding special characters. Both \fB\eE\fR -and \fB\ee\fR map to an ESCAPE character, \fI^x\fR maps to a control \fIx\fR -for any appropriate \fIx\fR, and the sequences \fB\en, \el, \er, \et, \eb, -\ef\fR, and \fB\es\fR give a newline, linefeed, return, tab, backspace, -formfeed, and space, respectively. Other escapes include: \fB\e^\fR for caret -(^); \fB\e\e\fR for backslash (\e); \fB\e\fR, for comma (,); \fB\e:\fR for -colon (:); and \fB\e0\fR for null. (\fB\e0\fR will actually produce -\fB\e200\fR, which does not terminate a string but behaves as a null character -on most devices, providing CS7 is specified. (See \fBstty\fR(1)). Finally, -characters may be given as three octal digits after a backslash (for example, -\e123). -.sp -.LP -Sometimes individual capabilities must be commented out. To do this, put a -period before the capability name. For example, see the second \fBind\fR in the -example above. Note that capabilities are defined in a left-to-right order and, -therefore, a prior definition will override a later definition. -.SS "Preparing Descriptions" -The most effective way to prepare a device description is by imitating the -description of a similar device in \fBterminfo\fR and building up a description -gradually, using partial descriptions with \fBvi\fR to check that they are -correct. Be aware that a very unusual device may expose deficiencies in the -ability of the \fBterminfo\fR file to describe it or the inability of \fBvi\fR -to work with that device. To test a new device description, set the environment -variable \fBTERMINFO\fR to the pathname of a directory containing the compiled -description you are working on and programs will look there rather than in -\fB/usr/share/lib/terminfo\fR. To get the padding for insert-line correct (if -the device manufacturer did not document it) a severe test is to comment out -\fBxon\fR, edit a large file at 9600 baud with \fBvi\fR, delete 16 or so lines -from the middle of the screen, and then press the \fBu\fR key several times -quickly. If the display is corrupted, more padding is usually needed. A similar -test can be used for insert-character. -.SS "Section 1-1: Basic Capabilities" -The number of columns on each line for the device is given by the \fBcols\fR -numeric capability. If the device has a screen, then the number of lines on the -screen is given by the \fBlines\fR capability. If the device wraps around to -the beginning of the next line when it reaches the right margin, then it should -have the \fBam\fR capability. If the terminal can clear its screen, leaving the -cursor in the home position, then this is given by the \fBclear\fR string -capability. If the terminal overstrikes (rather than clearing a position when a -character is struck over) then it should have the \fBos\fR capability. If the -device is a printing terminal, with no soft copy unit, specify both \fBhc\fR -and \fBos\fR. If there is a way to move the cursor to the left edge of the -current row, specify this as \fBcr\fR. (Normally this will be carriage return, -control M.) If there is a way to produce an audible signal (such as a bell or a -beep), specify it as \fBbel\fR. If, like most devices, the device uses the -xon-xoff flow-control protocol, specify \fBxon\fR. -.sp -.LP -If there is a way to move the cursor one position to the left (such as -backspace), that capability should be given as \fBcub1\fR. Similarly, sequences -to move to the right, up, and down should be given as \fBcuf1\fR, \fBcuu1\fR, -and \fBcud1\fR, respectively. These local cursor motions must not alter the -text they pass over; for example, you would not normally use ``\fBcuf1\fR=\es'' -because the space would erase the character moved over. -.sp -.LP -A very important point here is that the local cursor motions encoded in -\fBterminfo\fR are undefined at the left and top edges of a screen terminal. -Programs should never attempt to backspace around the left edge, unless -\fBbw\fR is specified, and should never attempt to go up locally off the top. -To scroll text up, a program goes to the bottom left corner of the screen and -sends the \fBind\fR (index) string. -.sp -.LP -To scroll text down, a program goes to the top left corner of the screen and -sends the \fBri\fR (reverse index) string. The strings \fBind\fR and \fBri\fR -are undefined when not on their respective corners of the screen. -.sp -.LP -Parameterized versions of the scrolling sequences are \fBindn\fR and \fBrin\fR. -These versions have the same semantics as \fBind\fR and \fBri\fR, except that -they take one parameter and scroll the number of lines specified by that -parameter. They are also undefined except at the appropriate edge of the -screen. -.sp -.LP -The \fBam\fR capability tells whether the cursor sticks at the right edge of -the screen when text is output, but this does not necessarily apply to a -\fBcuf1\fR from the last column. Backward motion from the left edge of the -screen is possible only when \fBbw\fR is specified. In this case, \fBcub1\fR -will move to the right edge of the previous row. If \fBbw\fR is not given, the -effect is undefined. This is useful for drawing a box around the edge of the -screen, for example. If the device has switch selectable automatic margins, -\fBam\fR should be specified in the \fBterminfo\fR source file. In this case, -initialization strings should turn on this option, if possible. If the device -has a command that moves to the first column of the next line, that command can -be given as \fBnel\fR (newline). It does not matter if the command clears the -remainder of the current line, so if the device has no \fBcr\fR and \fBlf\fR it -may still be possible to craft a working \fBnel\fR out of one or both of them. -.sp -.LP -These capabilities suffice to describe hardcopy and screen terminals. Thus the -AT&T 5320 hardcopy terminal is described as follows: -.sp -.in +2 -.nf -5320|att5320|AT&T 5320 hardcopy terminal, - am, hc, os, - cols#132, - bel=^G, cr=\er, cub1=\eb, cnd1=\en, - dch1=\eE[P, dl1=\eE[M, - ind=\en, -.fi -.in -2 -.sp - -.sp -.LP -while the Lear Siegler ADM\(mi3 is described as -.sp -.in +2 -.nf -adm3 | lsi adm3, - am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, - cud1=^J, ind=^J, lines#24, -.fi -.in -2 -.sp - -.SS "Section 1-2: Parameterized Strings" -Cursor addressing and other strings requiring parameters are described by a -parameterized string capability, with \fBprintf\fR-like escapes -(\fB%\fR\fIx\fR) in it. For example, to address the cursor, the \fBcup\fR -capability is given, using two parameters: the row and column to address to. -(Rows and columns are numbered from zero and refer to the physical screen -visible to the user, not to any unseen memory.) If the terminal has memory -relative cursor addressing, that can be indicated by \fBmrcup\fR. -.sp -.LP -The parameter mechanism uses a stack and special \fB%\fR codes to manipulate -the stack in the manner of Reverse Polish Notation (postfix). Typically a -sequence will push one of the parameters onto the stack and then print it in -some format. Often more complex operations are necessary. Operations are in -postfix form with the operands in the usual order. That is, to subtract 5 from -the first parameter, one would use \fB%p1%{5}%\(mi\fR. -.sp -.LP -The \fB%\fR encodings have the following meanings: -.sp -.ne 2 -.na -\fB\fB%%\fR\fR -.ad -.sp .6 -.RS 4n -outputs `%' -.RE - -.sp -.ne 2 -.na -\fB\fB%[[:]\fR\fIflags\fR][\fIwidth\fR[\fI\&.precision\fR]][\fBdoxXs\fR]\fR -.ad -.sp .6 -.RS 4n -as in \fBprintf\fR, flags are \fB[\(mi+#]\fR and space -.RE - -.sp -.ne 2 -.na -\fB\fB%c\fR\fR -.ad -.sp .6 -.RS 4n -print pop gives %c -.RE - -.sp -.ne 2 -.na -\fB\fB%p[1-9]\fR\fR -.ad -.sp .6 -.RS 4n -push \fIi\fRth parm -.RE - -.sp -.ne 2 -.na -\fB\fB%P[a-z]\fR\fR -.ad -.sp .6 -.RS 4n -set dynamic variable [a-z] to pop -.RE - -.sp -.ne 2 -.na -\fB\fB%g[a-z]\fR\fR -.ad -.sp .6 -.RS 4n -get dynamic variable [a-z] and push it -.RE - -.sp -.ne 2 -.na -\fB\fB%P[A-Z]\fR\fR -.ad -.sp .6 -.RS 4n -set static variable [a-z] to pop -.RE - -.sp -.ne 2 -.na -\fB\fB%g[A-Z]\fR\fR -.ad -.sp .6 -.RS 4n -get static variable [a-z] and push it -.RE - -.sp -.ne 2 -.na -\fB\fB%'\fR\fIc\fR'\fR -.ad -.sp .6 -.RS 4n -push char constant \fIc\fR -.RE - -.sp -.ne 2 -.na -\fB\fB%{\fR\fInn\fR}\fR -.ad -.sp .6 -.RS 4n -push decimal constant \fInn\fR -.RE - -.sp -.ne 2 -.na -\fB\fB%l\fR\fR -.ad -.sp .6 -.RS 4n -push strlen(pop) -.RE - -.sp -.ne 2 -.na -\fB\fB%+ %\(mi %* %/ %m\fR\fR -.ad -.sp .6 -.RS 4n -arithmetic (\fB%m\fR is mod): push(pop integer2 op pop integer1) -.RE - -.sp -.ne 2 -.na -\fB\fB%& %| %^\fR\fR -.ad -.sp .6 -.RS 4n -bit operations: push(pop integer2 op pop integer1) -.RE - -.sp -.ne 2 -.na -\fB\fB%= %> %<\fR\fR -.ad -.sp .6 -.RS 4n -logical operations: push(pop integer2 op pop integer1) -.RE - -.sp -.ne 2 -.na -\fB\fB%A %O\fR\fR -.ad -.sp .6 -.RS 4n -logical operations: and, or -.RE - -.sp -.ne 2 -.na -\fB\fB%! %~\fR\fR -.ad -.sp .6 -.RS 4n -unary operations: push(op pop) -.RE - -.sp -.ne 2 -.na -\fB\fB%i\fR\fR -.ad -.sp .6 -.RS 4n -(for ANSI terminals) add 1 to first parm, if one parm present, or first two -parms, if more than one parm present -.RE - -.sp -.ne 2 -.na -\fB\fB%?\fR \fBexpr\fR %t \fIthenpart\fR %e \fIelsepart\fR %\fR -.ad -.sp .6 -.RS 4n -if-then-else, \fB%e\fR \fIelsepart\fR is optional; else-if's are possible ala -Algol 68: \fB%? c\fR(1) %t b(1) %e c(2) %t b(2) %e c(3) %t b(3) %e c(4) %t b(4) -%e b(5)% c(\fIi\fR) are conditions, b(\fIi\fR) are bodies. -.RE - -.sp -.LP -If the ``\fB\(mi\fR\&'' flag is used with ``\fB%\fR[doxXs]'', then a colon -(\fB:\fR) must be placed between the ``\fB%\fR'' and the ``\fB\(mi\fR\&'' to -differentiate the flag from the binary ``\fB%\(mi\fR'' operator, for example -``\fB%:\(mi16.16s\fR''. -.sp -.LP -Consider the Hewlett-Packard 2645, which, to get to row 3 and column 12, needs -to be sent \fB\eE&a12c03Y\fR padded for 6 milliseconds. Note that the order of -the rows and columns is inverted here, and that the row and column are -zero-padded as two digits. Thus its \fBcup\fR capability is: -\fBcup=\eE&a%p2%2.2dc%p1%2.2dY$<6>\fR -.sp -.LP -The Micro-Term ACT-IV needs the current row and column sent preceded by a -\fB^T\fR, with the row and column simply encoded in binary, -``\fBcup=^T%p1%c%p2%c\fR''. Devices that use ``\fB%c\fR'' need to be able to -backspace the cursor (\fBcub1\fR), and to move the cursor up one line on the -screen (\fBcuu1\fR). This is necessary because it is not always safe to -transmit \fB\en\fR, \fB^D\fR, and \fB\er\fR, as the system may change or -discard them. (The library routines dealing with \fBterminfo\fR set tty modes -so that tabs are never expanded, so \fB\et\fR is safe to send. This turns out -to be essential for the Ann Arbor 4080.) -.sp -.LP -A final example is the LSI ADM-3a, which uses row and column offset by a blank -character, thus ``\fBcup=\eE=%p1%'\es'%+%c%p2%'\es'%+%c\fR''. After sending -``\fB\eE=\fR\&'', this pushes the first parameter, pushes the ASCII value for a -space (32), adds them (pushing the sum on the stack in place of the two -previous values), and outputs that value as a character. Then the same is done -for the second parameter. More complex arithmetic is possible using the stack. -.SS "Section 1-3: Cursor Motions" -If the terminal has a fast way to home the cursor (to very upper left corner of -screen) then this can be given as \fBhome\fR; similarly a fast way of getting -to the lower left-hand corner can be given as \fBll\fR; this may involve going -up with \fBcuu1\fR from the home position, but a program should never do this -itself (unless \fBll\fR does) because it can make no assumption about the -effect of moving up from the home position. Note that the home position is the -same as addressing to (0,0): to the top left corner of the screen, not of -memory. (Thus, the \fB\eEH\fR sequence on Hewlett-Packard terminals cannot be -used for \fBhome\fR without losing some of the other features on the terminal.) -.sp -.LP -If the device has row or column absolute-cursor addressing, these can be given -as single parameter capabilities \fBhpa\fR (horizontal position absolute) and -\fBvpa\fR (vertical position absolute). Sometimes these are shorter than the -more general two-parameter sequence (as with the Hewlett-Packard 2645) and can -be used in preference to \fBcup\fR. If there are parameterized local motions -(for example, move \fIn\fR spaces to the right) these can be given as -\fBcud\fR, \fBcub\fR, \fBcuf\fR, and \fBcuu\fR with a single parameter -indicating how many spaces to move. These are primarily useful if the device -does not have \fBcup\fR, such as the Tektronix 4025. -.sp -.LP -If the device needs to be in a special mode when running a program that uses -these capabilities, the codes to enter and exit this mode can be given as -\fBsmcup\fR and \fBrmcup\fR. This arises, for example, from terminals, such as -the Concept, with more than one page of memory. If the device has only memory -relative cursor addressing and not screen relative cursor addressing, a one -screen-sized window must be fixed into the device for cursor addressing to work -properly. This is also used for the Tektronix 4025, where \fBsmcup\fR sets the -command character to be the one used by \fBterminfo\fR. If the \fBsmcup\fR -sequence will not restore the screen after an \fBrmcup\fR sequence is output -(to the state prior to outputting \fBrmcup\fR), specify \fBnrrmc\fR. -.SS "Section 1-4: Area Clears" -If the terminal can clear from the current position to the end of the line, -leaving the cursor where it is, this should be given as \fBel\fR. If the -terminal can clear from the beginning of the line to the current position -inclusive, leaving the cursor where it is, this should be given as \fBel1\fR. -If the terminal can clear from the current position to the end of the display, -then this should be given as \fBed\fR. \fBed\fR is only defined from the first -column of a line. (Thus, it can be simulated by a request to delete a large -number of lines, if a true \fBed\fR is not available.) -.SS "Section 1-5: Insert/Delete Line" -If the terminal can open a new blank line before the line where the cursor is, -this should be given as \fBil1\fR; this is done only from the first position of -a line. The cursor must then appear on the newly blank line. If the terminal -can delete the line which the cursor is on, then this should be given as -\fBdl1\fR; this is done only from the first position on the line to be deleted. -Versions of \fBil1\fR and \fBdl1\fR which take a single parameter and insert or -delete that many lines can be given as \fBil\fR and \fBdl\fR. -.sp -.LP -If the terminal has a settable destructive scrolling region (like the VT100) -the command to set this can be described with the \fBcsr\fR capability, which -takes two parameters: the top and bottom lines of the scrolling region. The -cursor position is, alas, undefined after using this command. It is possible to -get the effect of insert or delete line using this command \(em the \fBsc\fR -and \fBrc\fR (save and restore cursor) commands are also useful. Inserting -lines at the top or bottom of the screen can also be done using \fBri\fR or -\fBind\fR on many terminals without a true insert/delete line, and is often -faster even on terminals with those features. -.sp -.LP -To determine whether a terminal has destructive scrolling regions or -non-destructive scrolling regions, create a scrolling region in the middle of -the screen, place data on the bottom line of the scrolling region, move the -cursor to the top line of the scrolling region, and do a reverse index -(\fBri\fR) followed by a delete line (\fBdl1\fR) or index (\fBind\fR). If the -data that was originally on the bottom line of the scrolling region was -restored into the scrolling region by the \fBdl1\fR or \fBind\fR, then the -terminal has non-destructive scrolling regions. Otherwise, it has destructive -scrolling regions. Do not specify \fBcsr\fR if the terminal has non-destructive -scrolling regions, unless \fBind\fR, \fBri\fR, \fBindn\fR, \fBrin\fR, \fBdl\fR, -and \fBdl1\fR all simulate destructive scrolling. -.sp -.LP -If the terminal has the ability to define a window as part of memory, which all -commands affect, it should be given as the parameterized string \fBwind\fR. The -four parameters are the starting and ending lines in memory and the starting -and ending columns in memory, in that order. -.sp -.LP -If the terminal can retain display memory above, then the \fBda\fR capability -should be given; if display memory can be retained below, then \fBdb\fR should -be given. These indicate that deleting a line or scrolling a full screen may -bring non-blank lines up from below or that scrolling back with \fBri\fR may -bring down non-blank lines. -.SS "Section 1-6: Insert/Delete Character" -There are two basic kinds of intelligent terminals with respect to -insert/delete character operations which can be described using \fBterminfo.\fR -The most common insert/delete character operations affect only the characters -on the current line and shift characters off the end of the line rigidly. Other -terminals, such as the Concept 100 and the Perkin Elmer Owl, make a distinction -between typed and untyped blanks on the screen, shifting upon an insert or -delete only to an untyped blank on the screen which is either eliminated, or -expanded to two untyped blanks. You can determine the kind of terminal you have -by clearing the screen and then typing text separated by cursor motions. Type -``\fBabc def\fR'' using local cursor motions (not spaces) between the \fBabc\fR -and the \fBdef\fR. Then position the cursor before the \fBabc\fR and put the -terminal in insert mode. If typing characters causes the rest of the line to -shift rigidly and characters to fall off the end, then your terminal does not -distinguish between blanks and untyped positions. If the \fBabc\fR shifts over -to the \fBdef\fR which then move together around the end of the current line -and onto the next as you insert, you have the second type of terminal, and -should give the capability \fBin\fR, which stands for ``insert null.'' While -these are two logically separate attributes (one line versus multiline insert -mode, and special treatment of untyped spaces) we have seen no terminals whose -insert mode cannot be described with the single attribute. -.sp -.LP -\fBterminfo\fR can describe both terminals that have an insert mode and -terminals which send a simple sequence to open a blank position on the current -line. Give as \fBsmir\fR the sequence to get into insert mode. Give as -\fBrmir\fR the sequence to leave insert mode. Now give as \fBich1\fR any -sequence needed to be sent just before sending the character to be inserted. -Most terminals with a true insert mode will not give \fBich1\fR; terminals that -send a sequence to open a screen position should give it here. (If your -terminal has both, insert mode is usually preferable to \fBich1\fR. Do not give -both unless the terminal actually requires both to be used in combination.) If -post-insert padding is needed, give this as a number of milliseconds padding in -\fBip\fR (a string option). Any other sequence which may need to be sent after -an insert of a single character may also be given in \fBip\fR. If your terminal -needs both to be placed into an `insert mode' and a special code to precede -each inserted character, then both \fBsmir\fR/rmir and \fBich1\fR can be given, -and both will be used. The \fBich\fR capability, with one parameter, \fIn\fR, -will insert \fIn\fR blanks. -.sp -.LP -If padding is necessary between characters typed while not in insert mode, give -this as a number of milliseconds padding in \fBrmp\fR. -.sp -.LP -It is occasionally necessary to move around while in insert mode to delete -characters on the same line (for example, if there is a tab after the insertion -position). If your terminal allows motion while in insert mode you can give the -capability \fBmir\fR to speed up inserting in this case. Omitting \fBmir\fR -will affect only speed. Some terminals (notably Datamedia's) must not have -\fBmir\fR because of the way their insert mode works. -.sp -.LP -Finally, you can specify \fBdch1\fR to delete a single character, \fBdch\fR -with one parameter, \fIn\fR, to delete \fIn\fR characters, and delete mode by -giving \fBsmdc\fR and \fBrmdc\fR to enter and exit delete mode (any mode the -terminal needs to be placed in for \fBdch1\fR to work). -.sp -.LP -A command to erase \fIn\fR characters (equivalent to outputting \fIn\fR blanks -without moving the cursor) can be given as \fBech\fR with one parameter. -.SS "Section 1-7: Highlighting, Underlining, and Visible Bells" -Your device may have one or more kinds of display attributes that allow you to -highlight selected characters when they appear on the screen. The following -display modes (shown with the names by which they are set) may be available: a -blinking screen (\fBblink\fR), bold or extra-bright characters (\fBbold\fR), -dim or half-bright characters (\fBdim\fR), blanking or invisible text -(\fBinvis\fR), protected text (\fBprot\fR), a reverse-video screen (\fBrev\fR), -and an alternate character set (\fBsmacs\fR to enter this mode and \fBrmacs\fR -to exit it). (If a command is necessary before you can enter alternate -character set mode, give the sequence in \fBenacs\fR or "enable -alternate-character-set" mode.) Turning on any of these modes singly may or may -not turn off other modes. -.sp -.LP -\fBsgr0\fR should be used to turn off all video enhancement capabilities. It -should always be specified because it represents the only way to turn off some -capabilities, such as \fBdim\fR or \fBblink\fR. -.sp -.LP -You should choose one display method as \fIstandout mode\fR and use it to -highlight error messages and other kinds of text to which you want to draw -attention. Choose a form of display that provides strong contrast but that is -easy on the eyes. (We recommend reverse-video plus half-bright or reverse-video -alone.) The sequences to enter and exit standout mode are given as \fBsmso\fR -and \fBrmso\fR, respectively. If the code to change into or out of standout -mode leaves one or even two blank spaces on the screen, as the TVI 912 and -Teleray 1061 do, then \fBxmc\fR should be given to tell how many spaces are -left. -.sp -.LP -Sequences to begin underlining and end underlining can be specified as -\fBsmul\fR and \fBrmul ,\fR respectively. If the device has a sequence to -underline the current character and to move the cursor one space to the right -(such as the Micro-Term MIME), this sequence can be specified as \fBuc\fR. -.sp -.LP -Terminals with the ``magic cookie'' glitch (\fBxmc\fR\fB)\fR deposit special -``cookies'' when they receive mode-setting sequences, which affect the display -algorithm rather than having extra bits for each character. Some terminals, -such as the Hewlett-Packard 2621, automatically leave standout mode when they -move to a new line or the cursor is addressed. Programs using standout mode -should exit standout mode before moving the cursor or sending a newline, unless -the \fBmsgr\fR capability, asserting that it is safe to move in standout mode, -is present. -.sp -.LP -If the terminal has a way of flashing the screen to indicate an error quietly -(a bell replacement), then this can be given as \fBflash\fR; it must not move -the cursor. A good flash can be done by changing the screen into reverse video, -pad for 200 ms, then return the screen to normal video. -.sp -.LP -If the cursor needs to be made more visible than normal when it is not on the -bottom line (to make, for example, a non-blinking underline into an easier to -find block or blinking underline) give this sequence as \fBcvvis\fR. The -boolean \fBchts\fR should also be given. If there is a way to make the cursor -completely invisible, give that as \fBcivis\fR. The capability \fBcnorm\fR -should be given which undoes the effects of either of these modes. -.sp -.LP -If your terminal generates underlined characters by using the underline -character (with no special sequences needed) even though it does not otherwise -overstrike characters, then you should specify the capability \fBul\fR. For -devices on which a character overstriking another leaves both characters on the -screen, specify the capability \fBos\fR. If overstrikes are erasable with a -blank, then this should be indicated by specifying \fBeo\fR. -.sp -.LP -If there is a sequence to set arbitrary combinations of modes, this should be -given as \fBsgr\fR (set attributes), taking nine parameters. Each parameter is -either \fB0\fR or non-zero, as the corresponding attribute is on or off. The -nine parameters are, in order: standout, underline, reverse, blink, dim, bold, -blank, protect, alternate character set. Not all modes need to be supported by -\fBsgr\fR; only those for which corresponding separate attribute commands exist -should be supported. For example, let's assume that the terminal in question -needs the following escape sequences to turn on various modes. -.sp - -.sp -.TS -c c c -c c c . -tparm -parameter attribute escape sequence -_ - none \eE[0m -p1 standout \eE[0;4;7m -p2 underline \eE[0;3m -p3 reverse \eE[0;4m -p4 blink \eE[0;5m -p5 dim \eE[0;7m -p6 bold \eE[0;3;4m -p7 invis \eE[0;8m -p8 protect not available -p9 altcharset ^O (off) ^N (on) -.TE - -.sp -.LP -Note that each escape sequence requires a \fB0\fR to turn off other modes -before turning on its own mode. Also note that, as suggested above, -\fIstandout\fR is set up to be the combination of \fIreverse\fR and \fIdim\fR. -Also, because this terminal has no \fIbold\fR mode, \fIbold\fR is set up as the -combination of \fIreverse\fR and \fIunderline\fR. In addition, to allow -combinations, such as \fIunderline+blink\fR, the sequence to use would be -\fB\eE[0;3;5m\fR\&. The terminal doesn't have \fIprotect\fR mode, either, but -that cannot be simulated in any way, so \fBp8\fR is ignored. The -\fIaltcharset\fR mode is different in that it is either \fB^O\fR or \fB^N\fR, -depending on whether it is off or on. If all modes were to be turned on, the -sequence would be \fB\eE[0;3;4;5;7;8m^N\fR\&. -.sp -.LP -Now look at when different sequences are output. For example, \fB;3\fR is -output when either \fBp2\fR or \fBp6\fR is true, that is, if either -\fIunderline\fR or \fIbold\fR modes are turned on. Writing out the above -sequences, along with their dependencies, gives the following: -.sp - -.sp -.TS -c c c -l l l . -sequence when to output terminfo translation -_ -\eE[0 always \eE[0 -;3 if \fBp2\fR or \fBp6\fR %?%p2%p6%|%t;3% -;4 if \fBp1\fR or \fBp3\fR or \fBp6\fR %?%p1%p3%|%p6%|%t;4% -;5 if \fBp4\fR %?%p4%t;5% -;7 if \fBp1\fR or \fBp5\fR %?%p1%p5%|%t;7% -;8 if \fBp7\fR %?%p7%t;8% -m always m -^N or ^O if \fBp9 ^N\fR, else \fB^O\fR %?%p9%t^N%e^O% -.TE - -.sp -.LP -Putting this all together into the \fBsgr\fR sequence gives: -.sp -.LP -\fBsgr=\eE[0%?%p2%p6%|%t;3%%?%p1%p3%|%p6% |%t;4%%?%p5%t;5%%?%p1%p5% -|%t;7%%?%p7%t;8%m%?%p9%t^N%e^O%,\fR -.sp -.LP -Remember that \fBsgr\fR and \fBsgr0\fR must always be specified. -.SS "Section 1-8: Keypad" -If the device has a keypad that transmits sequences when the keys are pressed, -this information can also be specified. Note that it is not possible to handle -devices where the keypad only works in local (this applies, for example, to the -unshifted Hewlett-Packard 2621 keys). If the keypad can be set to transmit or -not transmit, specify these sequences as \fBsmkx\fR and \fBrmkx\fR. Otherwise -the keypad is assumed to always transmit. -.sp -.LP -The sequences sent by the left arrow, right arrow, up arrow, down arrow, and -home keys can be given as \fBkcub1, kcuf1, kcuu1, kcud1,\fRand \fBkhome\fR, -respectively. If there are function keys such as f0, f1, ..., f63, the -sequences they send can be specified as \fBkf0, kf1, ..., kf63\fR. If the first -11 keys have labels other than the default f0 through f10, the labels can be -given as \fBlf0, lf1, ..., lf10\fR. The codes transmitted by certain other -special keys can be given: \fBkll\fR (home down), \fBkbs\fR (backspace), -\fBktbc\fR (clear all tabs), \fBkctab\fR (clear the tab stop in this column), -\fBkclr\fR (clear screen or erase key), \fBkdch1\fR (delete character), -\fBkdl1\fR (delete line), \fBkrmir\fR (exit insert mode), \fBkel\fR (clear to -end of line), \fBked\fR (clear to end of screen), \fBkich1\fR (insert character -or enter insert mode), \fBkil1\fR (insert line), \fBknp\fR (next page), -\fBkpp\fR (previous page), \fBkind\fR (scroll forward/down), \fBkri\fR (scroll -backward/up), \fBkhts\fR (set a tab stop in this column). In addition, if the -keypad has a 3 by 3 array of keys including the four arrow keys, the other five -keys can be given as \fBka1\fR, \fBka3\fR, \fBkb2\fR, \fBkc1\fR, and \fBkc3\fR. -These keys are useful when the effects of a 3 by 3 directional pad are needed. -Further keys are defined above in the capabilities list. -.sp -.LP -Strings to program function keys can be specified as \fBpfkey\fR, \fBpfloc\fR, -and \fBpfx\fR. A string to program screen labels should be specified as -\fBpln\fR. Each of these strings takes two parameters: a function key -identifier and a string to program it with. \fBpfkey\fR causes pressing the -given key to be the same as the user typing the given string; \fBpfloc\fR -causes the string to be executed by the terminal in local mode; and \fBpfx\fR -causes the string to be transmitted to the computer. The capabilities -\fBnlab\fR, \fBlw\fR and \fBlh\fR define the number of programmable screen -labels and their width and height. If there are commands to turn the labels on -and off, give them in \fBsmln\fR and \fBrmln\fR. \fBsmln\fR is normally output -after one or more \fBpln\fR sequences to make sure that the change becomes -visible. -.SS "Section 1-9: Tabs and Initialization" -If the device has hardware tabs, the command to advance to the next tab stop -can be given as \fBht\fR (usually control I). A ``backtab'' command that moves -leftward to the next tab stop can be given as \fBcbt\fR. By convention, if tty -modes show that tabs are being expanded by the computer rather than being sent -to the device, programs should not use \fBht\fR or \fBcbt\fR (even if they are -present) because the user may not have the tab stops properly set. If the -device has hardware tabs that are initially set every \fIn\fR spaces when the -device is powered up, the numeric parameter \fBit\fR is given, showing the -number of spaces the tabs are set to. This is normally used by \fBtput\fR -\fBinit\fR (see \fBtput\fR(1)) to determine whether to set the mode for -hardware tab expansion and whether to set the tab stops. If the device has tab -stops that can be saved in nonvolatile memory, the \fBterminfo\fR description -can assume that they are properly set. If there are commands to set and clear -tab stops, they can be given as \fBtbc\fR (clear all tab stops) and \fBhts\fR -(set a tab stop in the current column of every row). -.sp -.LP -Other capabilities include: \fBis1\fR, \fBis2\fR, and \fBis3\fR, initialization -strings for the device; \fBiprog\fR, the path name of a program to be run to -initialize the device; and \fBif\fR, the name of a file containing long -initialization strings. These strings are expected to set the device into modes -consistent with the rest of the \fBterminfo\fR description. They must be sent -to the device each time the user logs in and be output in the following order: -run the program \fBiprog\fR; output \fBis1\fR; output \fBis2\fR; set the -margins using \fBmgc\fR, \fBsmgl\fR and \fBsmgr\fR; set the tabs using -\fBtbc\fR and \fBhts\fR; print the file \fBif\fR; and finally output \fBis3\fR. -This is usually done using the \fBinit\fR option of \fBtput\fR. -.sp -.LP -Most initialization is done with \fBis2\fR. Special device modes can be set up -without duplicating strings by putting the common sequences in \fBis2\fR and -special cases in \fBis1\fR and \fBis3\fR. Sequences that do a reset from a -totally unknown state can be given as \fBrs1\fR, \fBrs2\fR, \fBrf\fR, and -\fBrs3\fR, analogous to \fBis1\fR, \fBis2\fR, \fBis3\fR, and \fBif\fR. (The -method using files, \fBif\fR and \fBrf\fR, is used for a few terminals, from -\fB/usr/share/lib/tabset/*\fR; however, the recommended method is to use the -initialization and reset strings.) These strings are output by \fBtput\fR -reset, which is used when the terminal gets into a wedged state. Commands are -normally placed in \fBrs1\fR, \fBrs2\fR, \fBrs3\fR, and \fBrf\fR only if they -produce annoying effects on the screen and are not necessary when logging in. -For example, the command to set a terminal into 80-column mode would normally -be part of \fBis2\fR, but on some terminals it causes an annoying glitch on the -screen and is not normally needed because the terminal is usually already in -80-column mode. -.sp -.LP -If a more complex sequence is needed to set the tabs than can be described by -using \fBtbc\fR and \fBhts\fR, the sequence can be placed in \fBis2\fR or -\fBif\fR. -.sp -.LP -Any margin can be cleared with \fBmgc\fR. (For instructions on how to specify -commands to set and clear margins, see "Margins" below under "PRINTER -CAPABILITIES".) -.SS "Section 1-10: Delays" -Certain capabilities control padding in the \fBtty\fR driver. These are -primarily needed by hard-copy terminals, and are used by \fBtput\fR \fBinit\fR -to set tty modes appropriately. Delays embedded in the capabilities \fBcr\fR, -\fBind\fR, \fBcub1\fR, \fBff\fR, and \fBtab\fR can be used to set the -appropriate delay bits to be set in the tty driver. If \fBpb\fR (padding baud -rate) is given, these values can be ignored at baud rates below the value of -\fBpb\fR. -.SS "Section 1-11: Status Lines" -If the terminal has an extra ``status line'' that is not normally used by -software, this fact can be indicated. If the status line is viewed as an extra -line below the bottom line, into which one can cursor address normally (such as -the Heathkit h19's 25th line, or the 24th line of a VT100 which is set to a -23-line scrolling region), the capability \fBhs\fR should be given. Special -strings that go to a given column of the status line and return from the status -line can be given as \fBtsl\fR and \fBfsl\fR. (\fBfsl\fR must leave the cursor -position in the same place it was before \fBtsl\fR. If necessary, the \fBsc\fR -and \fBrc\fR strings can be included in \fBtsl\fR and \fBfsl\fR to get this -effect.) The capability \fBtsl\fR takes one parameter, which is the column -number of the status line the cursor is to be moved to. -.sp -.LP -If escape sequences and other special commands, such as tab, work while in the -status line, the flag \fBeslok\fR can be given. A string which turns off the -status line (or otherwise erases its contents) should be given as \fBdsl\fR. If -the terminal has commands to save and restore the position of the cursor, give -them as \fBsc\fR and \fBrc\fR. The status line is normally assumed to be the -same width as the rest of the screen, for example, \fBcols\fR. If the status -line is a different width (possibly because the terminal does not allow an -entire line to be loaded) the width, in columns, can be indicated with the -numeric parameter \fBwsl\fR. -.SS "Section 1-12: Line Graphics" -If the device has a line drawing alternate character set, the mapping of glyph -to character would be given in \fBacsc\fR. The definition of this string is -based on the alternate character set used in the DEC VT100 terminal, extended -slightly with some characters from the AT&T 4410v1 terminal. -.sp - -.sp -.TS -c c -l l . -Glyph Name vt100+ Character -_ -arrow pointing right + -arrow pointing left , -arrow pointing down \&. -solid square block 0 -lantern symbol I -arrow pointing up \(mi -diamond ` -checker board (stipple) a -degree symbol f -plus/minus g -board of squares h -lower right corner j -upper right corner k -upper left corner l -lower left corner m -plus n -scan line 1 o -horizontal line q -scan line 9 s -left tee t -right tee u -bottom tee v -top tee w -vertical line x -bullet ~ -.TE - -.sp -.LP -The best way to describe a new device's line graphics set is to add a third -column to the above table with the characters for the new device that produce -the appropriate glyph when the device is in the alternate character set mode. -For example, -.sp - -.sp -.TS -c c c -l l l . -Glyph Name vt100+ Char New tty Char -_ -upper left corner l R -lower left corner m F -upper right corner k T -lower right corner j G -horizontal line q , -vertical line x \&. -.TE - -.sp -.LP -Now write down the characters left to right, as in -``\fBacsc=lRmFkTjGq\e,x.\fR''. -.sp -.LP -In addition, \fBterminfo\fR allows you to define multiple character sets. See -Section 2-5 for details. -.SS "Section 1-13: Color Manipulation" -Let us define two methods of color manipulation: the Tektronix method and the -HP method. The Tektronix method uses a set of N predefined colors (usually 8) -from which a user can select "current" foreground and background colors. Thus a -terminal can support up to N colors mixed into N*N color-pairs to be displayed -on the screen at the same time. When using an HP method the user cannot define -the foreground independently of the background, or vice-versa. Instead, the -user must define an entire color-pair at once. Up to M color-pairs, made from -2*M different colors, can be defined this way. Most existing color terminals -belong to one of these two classes of terminals. -.sp -.LP -The numeric variables \fBcolors\fR and \fBpairs\fR define the number of colors -and color-pairs that can be displayed on the screen at the same time. If a -terminal can change the definition of a color (for example, the Tektronix 4100 -and 4200 series terminals), this should be specified with \fBccc\fR (can change -color). To change the definition of a color (Tektronix 4200 method), use -\fBinitc\fR (initialize color). It requires four arguments: color number -(ranging from 0 to \fBcolors\fR\(mi1) and three RGB (red, green, and blue) -values or three HLS colors (Hue, Lightness, Saturation). Ranges of RGB and HLS -values are terminal dependent. -.sp -.LP -Tektronix 4100 series terminals only use HLS color notation. For such terminals -(or dual-mode terminals to be operated in HLS mode) one must define a boolean -variable \fBhls\fR; that would instruct the \fBcurses init_color\fR routine to -convert its RGB arguments to HLS before sending them to the terminal. The last -three arguments to the \fBinitc\fR string would then be HLS values. -.sp -.LP -If a terminal can change the definitions of colors, but uses a color notation -different from RGB and HLS, a mapping to either RGB or HLS must be developed. -.sp -.LP -To set current foreground or background to a given color, use \fBsetaf\fR (set -ANSI foreground) and \fBsetab\fR (set ANSI background). They require one -parameter: the number of the color. To initialize a color-pair (HP method), -use \fBinitp\fR (initialize pair). It requires seven parameters: the number of -a color-pair (range=0 to \fBpairs\fR\(mi1), and six RGB values: three for the -foreground followed by three for the background. (Each of these groups of three -should be in the order RGB.) When \fBinitc\fR or \fBinitp\fR are used, RGB or -HLS arguments should be in the order "red, green, blue" or "hue, lightness, -saturation"), respectively. To make a color-pair current, use \fBscp\fR (set -color-pair). It takes one parameter, the number of a color-pair. -.sp -.LP -Some terminals (for example, most color terminal emulators for PCs) erase areas -of the screen with current background color. In such cases, \fBbce\fR -(background color erase) should be defined. The variable \fBop\fR (original -pair) contains a sequence for setting the foreground and the background colors -to what they were at the terminal start-up time. Similarly, \fBoc\fR (original -colors) contains a control sequence for setting all colors (for the Tektronix -method) or color-pairs (for the HP method) to the values they had at the -terminal start-up time. -.sp -.LP -Some color terminals substitute color for video attributes. Such video -attributes should not be combined with colors. Information about these video -attributes should be packed into the \fBncv\fR (no color video) variable. There -is a one-to-one correspondence between the nine least significant bits of that -variable and the video attributes. The following table depicts this -correspondence. -.sp - -.sp -.TS -c c c -l l l . -Attribute Bit Position Decimal Value -_ -A_STANDOUT 0 1 -A_UNDERLINE 1 2 -A_REVERSE 2 4 -A_BLINK 3 8 -A_DIM 4 16 -A_BOLD 5 32 -A_INVIS 6 64 -A_PROTECT 7 128 -A_ALTCHARSET 8 256 -.TE - -.sp -.LP -When a particular video attribute should not be used with colors, the -corresponding \fBncv\fR bit should be set to 1; otherwise it should be set to -zero. To determine the information to pack into the \fBncv\fR variable, you -must add together the decimal values corresponding to those attributes that -cannot coexist with colors. For example, if the terminal uses colors to -simulate reverse video (bit number 2 and decimal value 4) and bold (bit number -5 and decimal value 32), the resulting value for \fBncv\fR will be 36 (4 + 32). -.SS "Section 1-14: Miscellaneous" -If the terminal requires other than a null (zero) character as a pad, then this -can be given as \fBpad\fR. Only the first character of the \fBpad\fR string is -used. If the terminal does not have a pad character, specify \fBnpc\fR. -.sp -.LP -If the terminal can move up or down half a line, this can be indicated with -\fBhu\fR (half-line up) and \fBhd\fR (half-line down). This is primarily useful -for superscripts and subscripts on hardcopy terminals. If a hardcopy terminal -can eject to the next page (form feed), give this as \fBff\fR (usually control -L). -.sp -.LP -If there is a command to repeat a given character a given number of times (to -save time transmitting a large number of identical characters) this can be -indicated with the parameterized string \fBrep\fR. The first parameter is the -character to be repeated and the second is the number of times to repeat it. -Thus, \fBtparm(repeat_char, 'x', 10)\fR is the same as \fBxxxxxxxxxx.\fR -.sp -.LP -If the terminal has a settable command character, such as the Tektronix 4025, -this can be indicated with \fBcmdch\fR. A prototype command character is chosen -which is used in all capabilities. This character is given in the \fBcmdch\fR -capability to identify it. The following convention is supported on some -systems: If the environment variable \fBCC\fR exists, all occurrences of the -prototype character are replaced with the character in \fBCC\fR. -.sp -.LP -Terminal descriptions that do not represent a specific kind of known terminal, -such as \fBswitch\fR, \fIdialup\fR, \fBpatch\fR, and \fInetwork\fR, should -include the \fBgn\fR (generic) capability so that programs can complain that -they do not know how to talk to the terminal. (This capability does not apply -to \fIvirtual\fR terminal descriptions for which the escape sequences are -known.) If the terminal is one of those supported by the system virtual -terminal protocol, the terminal number can be given as \fBvt\fR. A -line-turn-around sequence to be transmitted before doing reads should be -specified in \fBrfi\fR. -.sp -.LP -If the device uses xon/xoff handshaking for flow control, give \fBxon\fR. -Padding information should still be included so that routines can make better -decisions about costs, but actual pad characters will not be transmitted. -Sequences to turn on and off xon/xoff handshaking may be given in \fBsmxon\fR -and \fBrmxon\fR. If the characters used for handshaking are not \fB^S\fR and -\fB^Q\fR, they may be specified with \fBxonc\fR and \fBxoffc\fR. -.sp -.LP -If the terminal has a ``meta key'' which acts as a shift key, setting the 8th -bit of any character transmitted, this fact can be indicated with \fBkm\fR. -Otherwise, software will assume that the 8th bit is parity and it will usually -be cleared. If strings exist to turn this ``meta mode'' on and off, they can be -given as \fBsmm\fR and \fBrmm\fR. -.sp -.LP -If the terminal has more lines of memory than will fit on the screen at once, -the number of lines of memory can be indicated with \fBlm\fR. A value of -\fBlm\fR#0 indicates that the number of lines is not fixed, but that there is -still more memory than fits on the screen. -.sp -.LP -Media copy strings which control an auxiliary printer connected to the terminal -can be given as \fBmc0\fR: print the contents of the screen, \fBmc4\fR: turn -off the printer, and \fBmc5\fR: turn on the printer. When the printer is on, -all text sent to the terminal will be sent to the printer. A variation, -\fBmc5p\fR, takes one parameter, and leaves the printer on for as many -characters as the value of the parameter, then turns the printer off. The -parameter should not exceed 255. If the text is not displayed on the terminal -screen when the printer is on, specify \fBmc5i\fR (silent printer). All text, -including \fBmc4\fR, is transparently passed to the printer while an \fBmc5p\fR -is in effect. -.SS "Section 1-15: Special Cases" -The working model used by \fBterminfo\fR fits most terminals reasonably well. -However, some terminals do not completely match that model, requiring special -support by \fBterminfo\fR. These are not meant to be construed as deficiencies -in the terminals; they are just differences between the working model and the -actual hardware. They may be unusual devices or, for some reason, do not have -all the features of the \fBterminfo\fR model implemented. -.sp -.LP -Terminals that cannot display tilde (~) characters, such as certain Hazeltine -terminals, should indicate \fBhz\fR. -.sp -.LP -Terminals that ignore a linefeed immediately after an \fBam\fR wrap, such as -the Concept 100, should indicate \fBxenl\fR. Those terminals whose cursor -remains on the right-most column until another character has been received, -rather than wrapping immediately upon receiving the right-most character, such -as the VT100, should also indicate \fBxenl\fR. -.sp -.LP -If \fBel\fR is required to get rid of standout (instead of writing normal text -on top of it), \fBxhp\fR should be given. -.sp -.LP -Those Teleray terminals whose tabs turn all characters moved over to blanks, -should indicate \fBxt\fR (destructive tabs). This capability is also taken to -mean that it is not possible to position the cursor on top of a ``magic -cookie.'' Therefore, to erase standout mode, it is necessary, instead, to use -delete and insert line. -.sp -.LP -Those Beehive Superbee terminals which do not transmit the escape or -control\(miC characters, should specify \fBxsb\fR, indicating that the f1 key -is to be used for escape and the f2 key for control C. -.SS "Section 1-16: Similar Terminals" -If there are two very similar terminals, one can be defined as being just like -the other with certain exceptions. The string capability \fBuse\fR can be given -with the name of the similar terminal. The capabilities given before \fBuse\fR -override those in the terminal type invoked by \fBuse\fR. A capability can be -canceled by placing \fIxx\fR\fB@\fR to the left of the capability definition, -where \fIxx\fR is the capability. For example, the entry -.sp -.in +2 -.nf -\fBatt4424-2|Teletype4424 in display function group ii, -rev@, sgr@, smul@, use=att4424,\fR -.fi -.in -2 -.sp - -.sp -.LP -defines an AT&T4424 terminal that does not have the \fBrev\fR, \fBsgr\fR, and -\fBsmul\fR capabilities, and hence cannot do highlighting. This is useful for -different modes for a terminal, or for different user preferences. More than -one \fBuse\fR capability may be given. -.SS "PART 2: PRINTER CAPABILITIES" -The \fBterminfo\fR database allows you to define capabilities of printers as -well as terminals. To find out what capabilities are available for printers as -well as for terminals, see the two lists under "DEVICE CAPABILITIES" that list -capabilities by variable and by capability name. -.SS "Section 2-1: Rounding Values" -Because parameterized string capabilities work only with integer values, we -recommend that \fBterminfo\fR designers create strings that expect numeric -values that have been rounded. Application designers should note this and -should always round values to the nearest integer before using them with a -parameterized string capability. -.SS "Section 2-2: Printer Resolution" -A printer's resolution is defined to be the smallest spacing of characters it -can achieve. In general printers have independent resolution horizontally and -vertically. Thus the vertical resolution of a printer can be determined by -measuring the smallest achievable distance between consecutive printing -baselines, while the horizontal resolution can be determined by measuring the -smallest achievable distance between the left-most edges of consecutive -printed, identical, characters. -.sp -.LP -All printers are assumed to be capable of printing with a uniform horizontal -and vertical resolution. The view of printing that \fBterminfo\fR currently -presents is one of printing inside a uniform matrix: All characters are printed -at fixed positions relative to each ``cell'' in the matrix; furthermore, each -cell has the same size given by the smallest horizontal and vertical step sizes -dictated by the resolution. (The cell size can be changed as will be seen -later.) -.sp -.LP -Many printers are capable of ``proportional printing,'' where the horizontal -spacing depends on the size of the character last printed. \fBterminfo\fR does -not make use of this capability, although it does provide enough capability -definitions to allow an application to simulate proportional printing. -.sp -.LP -A printer must not only be able to print characters as close together as the -horizontal and vertical resolutions suggest, but also of ``moving'' to a -position an integral multiple of the smallest distance away from a previous -position. Thus printed characters can be spaced apart a distance that is an -integral multiple of the smallest distance, up to the length or width of a -single page. -.sp -.LP -Some printers can have different resolutions depending on different ``modes.'' -In ``normal mode,'' the existing \fBterminfo\fR capabilities are assumed to -work on columns and lines, just like a video terminal. Thus the old \fBlines\fR -capability would give the length of a page in lines, and the \fBcols\fR -capability would give the width of a page in columns. In ``micro mode,'' many -\fBterminfo\fR capabilities work on increments of lines and columns. With some -printers the micro mode may be concomitant with normal mode, so that all the -capabilities work at the same time. -.SS "Section 2-3: Specifying Printer Resolution" -The printing resolution of a printer is given in several ways. Each specifies -the resolution as the number of smallest steps per distance: -.sp -.in +2 -.nf - Specification of Printer Resolution - Characteristic Number of Smallest Steps - - orhi Steps per inch horizontally - orvi Steps per inch vertically - orc Steps per column - orl Steps per line -.fi -.in -2 -.sp - -.sp -.LP -When printing in normal mode, each character printed causes movement to the -next column, except in special cases described later; the distance moved is the -same as the per-column resolution. Some printers cause an automatic movement to -the next line when a character is printed in the rightmost position; the -distance moved vertically is the same as the per-line resolution. When printing -in micro mode, these distances can be different, and may be zero for some -printers. -.sp -.in +2 -.nf - Specification of Printer Resolution - Automatic Motion after Printing - - Normal Mode: - - orc Steps moved horizontally - orl Steps moved vertically - - Micro Mode: - - mcs Steps moved horizontally - mls Steps moved vertically -.fi -.in -2 -.sp - -.sp -.LP -Some printers are capable of printing wide characters. The distance moved when -a wide character is printed in normal mode may be different from when a regular -width character is printed. The distance moved when a wide character is printed -in micro mode may also be different from when a regular character is printed in -micro mode, but the differences are assumed to be related: If the distance -moved for a regular character is the same whether in normal mode or micro mode -(\fBmcs\fR=orc), then the distance moved for a wide character is also the same -whether in normal mode or micro mode. This doesn't mean the normal character -distance is necessarily the same as the wide character distance, just that the -distances don't change with a change in normal to micro mode. However, if the -distance moved for a regular character is different in micro mode from the -distance moved in normal mode (\fBmcs\fR<\fBorc\fR), the micro mode distance is -assumed to be the same for a wide character printed in micro mode, as the table -below shows. -.sp -.in +2 -.nf - Specification of Printer Resolution - Automatic Motion after Printing Wide Character - - Normal Mode or Micro Mode (mcs = orc): - sp - widcs Steps moved horizontally - - Micro Mode (mcs < orc): - - mcs Steps moved horizontally -.fi -.in -2 -.sp - -.sp -.LP -There may be control sequences to change the number of columns per inch (the -character pitch) and to change the number of lines per inch (the line pitch). -If these are used, the resolution of the printer changes, but the type of -change depends on the printer: -.sp -.in +2 -.nf - Specification of Printer Resolution - Changing the Character/Line Pitches - - cpi Change character pitch - cpix If set, cpi changes orhi, otherwise changes - orc - lpi Change line pitch - lpix If set, lpi changes orvi, otherwise changes - orl - chr Change steps per column - cvr Change steps per line -.fi -.in -2 -.sp - -.sp -.LP -The \fBcpi\fR and \fBlpi\fR string capabilities are each used with a single -argument, the pitch in columns (or characters) and lines per inch, -respectively. The \fBchr\fR and \fBcvr\fR string capabilities are each used -with a single argument, the number of steps per column and line, respectively. -.sp -.LP -Using any of the control sequences in these strings will imply a change in some -of the values of \fBorc\fR, \fBorhi\fR, \fBorl\fR, and \fBorvi\fR. Also, the -distance moved when a wide character is printed, \fBwidcs\fR, changes in -relation to \fBorc\fR. The distance moved when a character is printed in micro -mode, \fBmcs\fR, changes similarly, with one exception: if the distance is 0 -or 1, then no change is assumed (see items marked with * in the following -table). -.sp -.LP -Programs that use \fBcpi\fR, \fBlpi\fR, \fBchr\fR, or \fBcvr\fR should -recalculate the printer resolution (and should recalculate other values\(em see -"Effect of Changing Printing Resolution" under "Dot-Mapped Graphics"). -.sp -.in +2 -.nf - Specification of Printer Resolution - Effects of Changing the Character/Line Pitches - - Before After - -Using cpi with cpix clear: - $bold orhi '$ orhi - $bold orc '$ $bold orc = bold orhi over V sub italic cpi$ - - Using cpi with cpix set: - $bold orhi '$ $bold orhi = bold orc cdot V sub italic cpi$ - $bold orc '$ $bold orc$ - - Using lpi with lpix clear: - $bold orvi '$ $bold orvi$ - $bold orl '$ $bold orl = bold orvi over V sub italic lpi$ - - Using lpi with lpix set: - $bold orvi '$ $bold orvi = bold orl cdot V sub italic lpi$ - $bold orl '$ $bold orl$ - - Using chr: - $bold orhi '$ $bold orhi$ - $bold orc '$ $V sub italic chr$ - - Using cvr: - $bold orvi '$ $bold orvi$ - $bold orl '$ $V sub italic cvr$ - - Using cpi or chr: - $bold widcs '$ $bold widcs = bold {widcs '} bold orc over { bold {orc '} }$ - $bold mcs '$ $bold mcs = bold {mcs '} bold orc over { bold {orc '} }$ -.fi -.in -2 -.sp - -.sp -.LP -$V sub italic cpi$, $V sub italic lpi$, $V sub italic chr$, and $V sub italic -cvr$ are the arguments used with \fBcpi\fR, \fBlpi\fR, \fBchr\fR, and -\fBcvr\fR, respectively. The prime marks (\|'\|) indicate the old values. -.SS "Section 2-4: Capabilities that Cause Movement" -In the following descriptions, ``movement'' refers to the motion of the -``current position.'' With video terminals this would be the cursor; with some -printers this is the carriage position. Other printers have different -equivalents. In general, the current position is where a character would be -displayed if printed. -.sp -.LP -\fBterminfo\fR has string capabilities for control sequences that cause -movement a number of full columns or lines. It also has equivalent string -capabilities for control sequences that cause movement a number of smallest -steps. -.sp -.in +2 -.nf -String Capabilities for Motion - - mcub1 Move 1 step left - mcuf1 Move 1 step right - mcuu1 Move 1 step up - mcud1 Move 1 step down - mcub Move N steps left - mcuf Move N steps right - mcuu Move N steps up - mcud Move N steps down - mhpa Move N steps from the left - mvpa Move N steps from the top -.fi -.in -2 -.sp - -.sp -.LP -The latter six strings are each used with a single argument, \fIN\fR. -.sp -.LP -Sometimes the motion is limited to less than the width or length of a page. -Also, some printers don't accept absolute motion to the left of the current -position. \fBterminfo\fR has capabilities for specifying these limits. -.sp -.in +2 -.nf -Limits to Motion - - mjump Limit on use of mcub1, mcuf1, mcuu1, mcud1 - maddr Limit on use of mhpa, mvpa - xhpa If set, hpa and mhpa can't move left - xvpa If set, vpa and mvpa can't move up -.fi -.in -2 -.sp - -.sp -.LP -If a printer needs to be in a ``micro mode'' for the motion capabilities -described above to work, there are string capabilities defined to contain the -control sequence to enter and exit this mode. A boolean is available for those -printers where using a carriage return causes an automatic return to normal -mode. -.sp -.in +2 -.nf - Entering/Exiting Micro Mode - - smicm Enter micro mode - rmicm Exit micro mode - crxm Using cr exits micro mode -.fi -.in -2 -.sp - -.sp -.LP -The movement made when a character is printed in the rightmost position varies -among printers. Some make no movement, some move to the beginning of the next -line, others move to the beginning of the same line. \fBterminfo\fR has boolean -capabilities for describing all three cases. -.sp -.in +2 -.nf - What Happens After Character - Printed in Rightmost Position - - sam Automatic move to beginning of same line -.fi -.in -2 -.sp - -.sp -.LP -Some printers can be put in a mode where the normal direction of motion is -reversed. This mode can be especially useful when there are no capabilities for -leftward or upward motion, because those capabilities can be built from the -motion reversal capability and the rightward or downward motion capabilities. -It is best to leave it up to an application to build the leftward or upward -capabilities, though, and not enter them in the \fBterminfo\fR database. This -allows several reverse motions to be strung together without intervening wasted -steps that leave and reenter reverse mode. -.sp -.in +2 -.nf -Entering/Exiting Reverse Modes - - slm Reverse sense of horizontal motions - rlm Restore sense of horizontal motions - sum Reverse sense of vertical motions - rum Restore sense of vertical motions - - While sense of horizontal motions reversed: - mcub1 Move 1 step right - mcuf1 Move 1 step left - mcub Move N steps right - mcuf Move N steps left - cub1 Move 1 column right - cuf1 Move 1 column left - cub Move N columns right - cuf Move N columns left - - While sense of vertical motions reversed: - mcuu1 Move 1 step down - mcud1 Move 1 step up - mcuu Move N steps down - mcud Move N steps up - cuu1 Move 1 line down - cud1 Move 1 line up - cuu Move N lines down - cud Move N lines up -.fi -.in -2 -.sp - -.sp -.LP -The reverse motion modes should not affect the \fBmvpa\fR and \fBmhpa\fR -absolute motion capabilities. The reverse vertical motion mode should, however, -also reverse the action of the line ``wrapping'' that occurs when a character -is printed in the right-most position. Thus printers that have the standard -\fBterminfo\fR capability \fBam\fR defined should experience motion to the -beginning of the previous line when a character is printed in the right-most -position under reverse vertical motion mode. -.sp -.LP -The action when any other motion capabilities are used in reverse motion modes -is not defined; thus, programs must exit reverse motion modes before using -other motion capabilities. -.sp -.LP -Two miscellaneous capabilities complete the list of new motion capabilities. -One of these is needed for printers that move the current position to the -beginning of a line when certain control characters, such as ``line-feed'' or -``form-feed,'' are used. The other is used for the capability of suspending the -motion that normally occurs after printing a character. -.sp -.in +2 -.nf -Miscellaneous Motion Strings - - docr List of control characters causing cr - zerom Prevent auto motion after printing next single character -.fi -.in -2 -.sp - -.SS "Margins" -\fBterminfo\fR provides two strings for setting margins on terminals: one for -the left and one for the right margin. Printers, however, have two additional -margins, for the top and bottom margins of each page. Furthermore, some -printers require not using motion strings to move the current position to a -margin and then fixing the margin there, but require the specification of where -a margin should be regardless of the current position. Therefore \fBterminfo\fR -offers six additional strings for defining margins with printers. -.sp -.in +2 -.nf -Setting Margins - - smgl Set left margin at current column - smgr Set right margin at current column - smgb Set bottom margin at current line - smgt Set top margin at current line - smgbp Set bottom margin at line N - smglp Set left margin at column N - smgrp Set right margin at column N - smgtp Set top margin at line N -.fi -.in -2 -.sp - -.sp -.LP -The last four strings are used with one or more arguments that give the -position of the margin or margins to set. If both of \fBsmglp\fR and -\fBsmgrp\fR are set, each is used with a single argument, \fIN,\fR that gives -the column number of the left and right margin, respectively. If both of -\fBsmgtp\fR and \fBsmgbp\fR are set, each is used to set the top and bottom -margin, respectively: \fBsmgtp\fR is used with a single argument, \fIN,\fR the -line number of the top margin; however, \fBsmgbp\fR is used with two arguments, -\fIN\fR and \fIM,\fR that give the line number of the bottom margin, the first -counting from the top of the page and the second counting from the bottom. This -accommodates the two styles of specifying the bottom margin in different -manufacturers' printers. When coding a \fBterminfo\fR entry for a printer that -has a settable bottom margin, only the first or second parameter should be -used, depending on the printer. When writing an application that uses -\fBsmgbp\fR to set the bottom margin, both arguments must be given. -.sp -.LP -If only one of \fBsmglp\fR and \fBsmgrp\fR is set, then it is used with two -arguments, the column number of the left and right margins, in that order. -Likewise, if only one of \fBsmgtp\fR and \fBsmgbp\fR is set, then it is used -with two arguments that give the top and bottom margins, in that order, -counting from the top of the page. Thus when coding a \fBterminfo\fR entry for -a printer that requires setting both left and right or top and bottom margins -simultaneously, only one of \fBsmglp\fR and \fBsmgrp\fR or \fBsmgtp\fR and -\fBsmgbp\fR should be defined; the other should be left blank. When writing an -application that uses these string capabilities, the pairs should be first -checked to see if each in the pair is set or only one is set, and should then -be used accordingly. -.sp -.LP -In counting lines or columns, line zero is the top line and column zero is the -left-most column. A zero value for the second argument with \fBsmgbp\fR means -the bottom line of the page. -.sp -.LP -All margins can be cleared with \fBmgc\fR. -.SS "Shadows, Italics, Wide Characters" -Five new sets of strings describe the capabilities printers have of enhancing -printed text. -.sp -.in +2 -.nf -Enhanced Printing - - sshm Enter shadow-printing mode - rshm Exit shadow-printing mode - sitm Enter italicizing mode - ritm Exit italicizing mode - swidm Enter wide character mode - rwidm Exit wide character mode - ssupm Enter superscript mode - rsupd - m Exit superscript mode - supcs List of characters available as superscripts - ssubm Enter subscript mode - rsubm Exit subscript mode - subcs List of characters available as subscripts -.fi -.in -2 -.sp - -.sp -.LP -If a printer requires the \fBsshm\fR control sequence before every character to -be shadow-printed, the \fBrshm\fR string is left blank. Thus programs that find -a control sequence in \fBsshm\fR but none in \fBrshm\fR should use the -\fBsshm\fR control sequence before every character to be shadow-printed; -otherwise, the \fBsshm\fR control sequence should be used once before the set -of characters to be shadow-printed, followed by \fBrshm\fR. The same is also -true of each of the \fBsitm\fR/\fBritm\fR, \fBswidm\fR/\fBrwidm\fR, -\fBssupm\fR/\fBrsupm\fR, and \fBssubm\fR/ \fBrsubm\fR pairs. -.sp -.LP -Note that \fBterminfo\fR also has a capability for printing emboldened text -(\fBbold\fR). While shadow printing and emboldened printing are similar in that -they ``darken'' the text, many printers produce these two types of print in -slightly different ways. Generally, emboldened printing is done by overstriking -the same character one or more times. Shadow printing likewise usually involves -overstriking, but with a slight movement up and/or to the side so that the -character is ``fatter.'' -.sp -.LP -It is assumed that enhanced printing modes are independent modes, so that it -would be possible, for instance, to shadow print italicized subscripts. -.sp -.LP -As mentioned earlier, the amount of motion automatically made after printing a -wide character should be given in \fBwidcs\fR. -.sp -.LP -If only a subset of the printable ASCII characters can be printed as -superscripts or subscripts, they should be listed in \fBsupcs\fR or \fBsubcs\fR -strings, respectively. If the \fBssupm\fR or \fBssubm\fR strings contain -control sequences, but the corresponding \fBsupcs\fR or \fBsubcs\fR strings are -empty, it is assumed that all printable ASCII characters are available as -superscripts or subscripts. -.sp -.LP -Automatic motion made after printing a superscript or subscript is assumed to -be the same as for regular characters. Thus, for example, printing any of the -following three examples will result in equivalent motion: -.sp -.LP -\fBBi B\fR(i) B^i -.sp -.LP -Note that the existing \fBmsgr\fR boolean capability describes whether motion -control sequences can be used while in ``standout mode.'' This capability is -extended to cover the enhanced printing modes added here. \fBmsgr\fR should be -set for those printers that accept any motion control sequences without -affecting shadow, italicized, widened, superscript, or subscript printing. -Conversely, if \fBmsgr\fR is not set, a program should end these modes before -attempting any motion. -.SS "Section 2-5: Alternate Character Sets" -In addition to allowing you to define line graphics (described in Section -1-12), \fBterminfo\fR lets you define alternate character sets. The following -capabilities cover printers and terminals with multiple selectable or definable -character sets. -.sp -.in +2 -.nf -Alternate Character Sets - - scs Select character set N - scsd Start definition of character set N, M characters - defc Define character A, B dots wide, descender D - rcsd End definition of character set N - csnm List of character set names - daisy Printer has manually changed print-wheels -.fi -.in -2 -.sp - -.sp -.LP -The \fBscs\fR, \fBrcsd\fR, and \fBcsnm\fR strings are used with a single -argument, \fIN\fR, a number from 0 to 63 that identifies the character set. The -\fBscsd\fR string is also used with the argument \fIN\fR and another, \fIM\fR, -that gives the number of characters in the set. The \fBdefc\fR string is used -with three arguments: \fIA\fR gives the ASCII code representation for the -character, \fIB\fR gives the width of the character in dots, and \fID\fR is -zero or one depending on whether the character is a ``descender'' or not. The -\fBdefc\fR string is also followed by a string of ``image-data'' bytes that -describe how the character looks (see below). -.sp -.LP -Character set 0 is the default character set present after the printer has been -initialized. Not every printer has 64 character sets, of course; using -\fBscs\fR with an argument that doesn't select an available character set -should cause a null result from \fBtparm\fR. -.sp -.LP -If a character set has to be defined before it can be used, the \fBscsd\fR -control sequence is to be used before defining the character set, and the -\fBrcsd\fR is to be used after. They should also cause a null result from -\fBtparm\fR when used with an argument \fIN\fR that doesn't apply. If a -character set still has to be selected after being defined, the \fBscs\fR -control sequence should follow the \fBrcsd\fR control sequence. By examining -the results of using each of the \fBscs\fR, \fBscsd\fR, and \fBrcsd\fR strings -with a character set number in a call to \fBtparm\fR, a program can determine -which of the three are needed. -.sp -.LP -Between use of the \fBscsd\fR and \fBrcsd\fR strings, the \fBdefc\fR string -should be used to define each character. To print any character on printers -covered by \fBterminfo\fR, the ASCII code is sent to the printer. This is true -for characters in an alternate set as well as ``normal'' characters. Thus the -definition of a character includes the ASCII code that represents it. In -addition, the width of the character in dots is given, along with an indication -of whether the character should descend below the print line (such as the lower -case letter ``g'' in most character sets). The width of the character in dots -also indicates the number of image-data bytes that will follow the \fBdefc\fR -string. These image-data bytes indicate where in a dot-matrix pattern ink -should be applied to ``draw'' the character; the number of these bytes and -their form are defined below under ``Dot-Mapped Graphics.'' -.sp -.LP -It's easiest for the creator of \fBterminfo\fR entries to refer to each -character set by number; however, these numbers will be meaningless to the -application developer. The \fBcsnm\fR string alleviates this problem by -providing names for each number. -.sp -.LP -When used with a character set number in a call to \fBtparm\fR, the \fBcsnm\fR -string will produce the equivalent name. These names should be used as a -reference only. No naming convention is implied, although anyone who creates a -\fBterminfo\fR entry for a printer should use names consistent with the names -found in user documents for the printer. Application developers should allow a -user to specify a character set by number (leaving it up to the user to examine -the \fBcsnm\fR string to determine the correct number), or by name, where the -application examines the \fBcsnm\fR string to determine the corresponding -character set number. -.sp -.LP -These capabilities are likely to be used only with dot-matrix printers. If they -are not available, the strings should not be defined. For printers that have -manually changed print-wheels or font cartridges, the boolean \fBdaisy\fR is -set. -.SS "Section 2-6: Dot-Matrix Graphics" -Dot-matrix printers typically have the capability of reproducing -``raster-graphics'' images. Three new numeric capabilities and three new string -capabilities can help a program draw raster-graphics images independent of the -type of dot-matrix printer or the number of pins or dots the printer can handle -at one time. -.sp -.in +2 -.nf -Dot-Matrix Graphics - - npins Number of pins, N, in print-head - spinv Spacing of pins vertically in pins per inch - spinh Spacing of dots horizontally in dots per inch - porder Matches software bits to print-head pins - sbim Start printing bit image graphics, B bits wide - rbim End printing bit image graphics -.fi -.in -2 -.sp - -.sp -.LP -The \fBsbim\fR string is used with a single argument, \fIB\fR, the width of the -image in dots. -.sp -.LP -The model of dot-matrix or raster-graphics that \fBterminfo\fR presents is -similar to the technique used for most dot-matrix printers: each pass of the -printer's print-head is assumed to produce a dot-matrix that is \fIN\fR dots -high and \fIB\fR dots wide. This is typically a wide, squat, rectangle of dots. -The height of this rectangle in dots will vary from one printer to the next; -this is given in the \fBnpins\fR numeric capability. The size of the rectangle -in fractions of an inch will also vary; it can be deduced from the \fBspinv\fR -and \fBspinh\fR numeric capabilities. With these three values an application -can divide a complete raster-graphics image into several horizontal strips, -perhaps interpolating to account for different dot spacing vertically and -horizontally. -.sp -.LP -The \fBsbim\fR and \fBrbim\fR strings are used to start and end a dot-matrix -image, respectively. The \fBsbim\fR string is used with a single argument that -gives the width of the dot-matrix in dots. A sequence of ``image-data bytes'' -are sent to the printer after the \fBsbim\fR string and before the \fBrbim\fR -string. The number of bytes is a integral multiple of the width of the -dot-matrix; the multiple and the form of each byte is determined by the -\fBporder\fR string as described below. -.sp -.LP -The \fBporder\fR string is a comma separated list of pin numbers optionally -followed by an numerical offset. The offset, if given, is separated from the -list with a semicolon. The position of each pin number in the list corresponds -to a bit in an 8-bit data byte. The pins are numbered consecutively from 1 to -\fBnpins\fR, with 1 being the top pin. Note that the term ``pin'' is used -loosely here; ``ink-jet'' dot-matrix printers don't have pins, but can be -considered to have an equivalent method of applying a single dot of ink to -paper. The bit positions in \fBporder\fR are in groups of 8, with the first -position in each group the most significant bit and the last position the least -significant bit. An application produces 8-bit bytes in the order of the groups -in \fBporder\fR. -.sp -.LP -An application computes the ``image-data bytes'' from the internal image, -mapping vertical dot positions in each print-head pass into 8-bit bytes, using -a 1 bit where ink should be applied and 0 where no ink should be applied. This -can be reversed (0 bit for ink, 1 bit for no ink) by giving a negative pin -number. If a position is skipped in \fBporder\fR, a 0 bit is used. If a -position has a lower case `x' instead of a pin number, a 1 bit is used in the -skipped position. For consistency, a lower case `o' can be used to represent a -0 filled, skipped bit. There must be a multiple of 8 bit positions used or -skipped in \fBporder\fR; if not, 0 bits are used to fill the last byte in the -least significant bits. The offset, if given, is added to each data byte; the -offset can be negative. -.sp -.LP -Some examples may help clarify the use of the \fBporder\fR string. The AT&T -470, AT&T 475 and C.Itoh 8510 printers provide eight pins for graphics. The -pins are identified top to bottom by the 8 bits in a byte, from least -significant to most. The \fBporder\fR strings for these printers would be -\fB8,7,6,5,4,3,2,1\fR. The AT&T 478 and AT&T 479 printers also provide eight -pins for graphics. However, the pins are identified in the reverse order. The -\fBporder\fR strings for these printers would be \fB1,2,3,4,5,6,7,8\fR. The -AT&T 5310, AT&T 5320, DEC LA100, and DEC LN03 printers provide six pins for -graphics. The pins are identified top to bottom by the decimal values 1, 2, 4, -8, 16 and 32. These correspond to the low six bits in an 8-bit byte, although -the decimal values are further offset by the value 63. The \fBporder\fR string -for these printers would be \fB,,6,5,4,3,2,1;63\fR, or alternately -\fBo,o,6,5,4,3,2,1;63\fR. -.SS "Section 2-7: Effect of Changing Printing Resolution" -If the control sequences to change the character pitch or the line pitch are -used, the pin or dot spacing may change: -.sp -.in +2 -.nf - Dot-Matrix Graphics - Changing the Character/Line Pitches - - cpi Change character pitch - cpix If set, cpi changes spinh - lpi Change line pitch - lpix If set, lpi changes spinv -.fi -.in -2 -.sp - -.sp -.LP -Programs that use \fBcpi\fR or \fBlpi\fR should recalculate the dot spacing: -.sp -.in +2 -.nf -Dot-Matrix Graphics - Effects of Changing the Character/Line Pitches - - Before After - -Using cpi with cpix clear: - $bold spinh '$ $bold spinh$ - -Using cpi with cpix set: - $bold spinh '$ $bold spinh = bold spinh ' cdot bold orhi over - { bold {orhi '} }$ - -Using lpi with lpix clear: - $bold spinv '$ $bold spinv$ - -Using lpi with lpix set: - $bold spinv '$ $bold spinv = bold {spinv '} cdot bold orhi over - { bold {orhi '}}$ - -Using chr: - $bold spinh '$ $bold spinh$ - -Using cvr: - $bold spinv '$ $bold spinv$ -.fi -.in -2 -.sp - -.sp -.LP -\fBorhi\fR' and \fBorhi\fR are the values of the horizontal resolution in steps -per inch, before using \fBcpi\fR and after using \fBcpi\fR, respectively. -Likewise, \fBorvi'\fR and \fBorvi\fR are the values of the vertical resolution -in steps per inch, before using \fBlpi\fR and after using \fBlpi\fR, -respectively. Thus, the changes in the dots per inch for dot-matrix graphics -follow the changes in steps per inch for printer resolution. -.SS "Section 2-8: Print Quality" -Many dot-matrix printers can alter the dot spacing of printed text to produce -near ``letter quality'' printing or ``draft quality'' printing. Usually it is -important to be able to choose one or the other because the rate of printing -generally falls off as the quality improves. There are three new strings used -to describe these capabilities. -.sp -.in +2 -.nf -Print Quality - - snlq Set near-letter quality print - snrmq Set normal quality print - sdrfq Set draft quality print -.fi -.in -2 -.sp - -.sp -.LP -The capabilities are listed in decreasing levels of quality. If a printer -doesn't have all three levels, one or two of the strings should be left blank -as appropriate. -.SS "Section 2-9: Printing Rate and Buffer Size" -Because there is no standard protocol that can be used to keep a program -synchronized with a printer, and because modern printers can buffer data before -printing it, a program generally cannot determine at any time what has been -printed. Two new numeric capabilities can help a program estimate what has been -printed. -.sp -.in +2 -.nf -Print Rate/Buffer Size - - cps Nominal print rate in characters per second - bufsz Buffer capacity in characters -.fi -.in -2 -.sp - -.sp -.LP -\fBcps\fR is the nominal or average rate at which the printer prints -characters; if this value is not given, the rate should be estimated at -one-tenth the prevailing baud rate. \fBbufsz\fR is the maximum number of -subsequent characters buffered before the guaranteed printing of an earlier -character, assuming proper flow control has been used. If this value is not -given it is assumed that the printer does not buffer characters, but prints -them as they are received. -.sp -.LP -As an example, if a printer has a 1000-character buffer, then sending the -letter ``a'' followed by 1000 additional characters is guaranteed to cause the -letter ``a'' to print. If the same printer prints at the rate of 100 characters -per second, then it should take 10 seconds to print all the characters in the -buffer, less if the buffer is not full. By keeping track of the characters sent -to a printer, and knowing the print rate and buffer size, a program can -synchronize itself with the printer. -.sp -.LP -Note that most printer manufacturers advertise the maximum print rate, not the -nominal print rate. A good way to get a value to put in for \fBcps\fR is to -generate a few pages of text, count the number of printable characters, and -then see how long it takes to print the text. -.sp -.LP -Applications that use these values should recognize the variability in the -print rate. Straight text, in short lines, with no embedded control sequences -will probably print at close to the advertised print rate and probably faster -than the rate in \fBcps\fR. Graphics data with a lot of control sequences, or -very long lines of text, will print at well below the advertised rate and below -the rate in \fBcps\fR. If the application is using \fBcps\fR to decide how long -it should take a printer to print a block of text, the application should pad -the estimate. If the application is using \fBcps\fR to decide how much text has -already been printed, it should shrink the estimate. The application will thus -err in favor of the user, who wants, above all, to see all the output in its -correct place. -.SH FILES -.ne 2 -.na -\fB\fB/usr/share/lib/terminfo/?/*\fR\fR -.ad -.sp .6 -.RS 4n -compiled terminal description database -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/share/lib/.COREterm/?/*\fR\fR -.ad -.sp .6 -.RS 4n -subset of compiled terminal description database -.RE - -.sp -.ne 2 -.na -\fB\fB/usr/share/lib/tabset/*\fR\fR -.ad -.sp .6 -.RS 4n -tab settings for some terminals, in a format appropriate to be output to the -terminal (escape sequences that set margins and tabs) -.RE - -.SH SEE ALSO -\fBls\fR(1), \fBpg\fR(1), \fBstty\fR(1), \fBtput\fR(1), \fBtty\fR(1), -\fBvi\fR(1), \fBinfocmp\fR(1M), \fBtic\fR(1M), \fBprintf\fR(3C), -\fBcurses\fR(3CURSES), \fBcurses\fR(3XCURSES) -.SH NOTES -The most effective way to prepare a terminal description is by imitating the -description of a similar terminal in \fBterminfo\fR and to build up a -description gradually, using partial descriptions with a screen oriented -editor, such as \fBvi\fR, to check that they are correct. To easily test a new -terminal description the environment variable \fBTERMINFO\fR can be set to the -pathname of a directory containing the compiled description, and programs will -look there rather than in \fB/usr/share/lib/terminfo\fR. diff --git a/usr/src/man/man4/timezone.4 b/usr/src/man/man4/timezone.4 deleted file mode 100644 index cfa7cf0ddc..0000000000 --- a/usr/src/man/man4/timezone.4 +++ /dev/null @@ -1,65 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved -.\" 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 TIMEZONE 4 "November 22, 2021" -.SH NAME -timezone \- default timezone data base -.SH SYNOPSIS -.nf -\fB/etc/timezone\fR -.fi - -.SH DESCRIPTION -The timezone file contains information regarding the default timezone for each -host in a domain. Alternatively, a single default line for the entire domain -may be specified. Each entry has the format: -.sp -.in +2 -.nf -\fITimezone-name official-host-or-domain-name\fR -.fi -.in -2 - -.sp -.LP -Items are separated by any number of blanks and/or TAB characters. A `#' -indicates the beginning of a comment; characters up to the end of the line are -not interpreted by routines which search the file. The timezone is a pathname -relative to the directory \fB/usr/share/lib/zoneinfo\fR. -.sp -.LP -This file is not actually referenced by any system software; it is merely used -as a source file to construct the \fBNIS\fR \fBtimezone.byname\fR map, which -was used by the installer in older releases of Solaris. -.sp -.LP -The \fBtimezone\fR file does not set the timezone environment variable -\fBTZ\fR. See \fBTIMEZONE\fR(4) for information to set the \fBTZ\fR environment -variable. -.SH EXAMPLES -\fBExample 1 \fRTypical timezone line -.sp -.LP -Here is a typical line from the \fB/etc/timezone\fR file: - -.sp -.in +2 -.nf -US/Eastern East.Example.COM #Host on East Coast -.fi -.in -2 -.sp - -.SH FILES -.ne 2 -.na -\fB\fB/etc/timezone\fR\fR -.ad -.RS 17n - -.RE - -.SH SEE ALSO -\fBTIMEZONE\fR(4) diff --git a/usr/src/man/man4/tnf_kernel_probes.4 b/usr/src/man/man4/tnf_kernel_probes.4 deleted file mode 100644 index 12ab068ccb..0000000000 --- a/usr/src/man/man4/tnf_kernel_probes.4 +++ /dev/null @@ -1,942 +0,0 @@ -'\" te -.\" Copyright 1999 Sun Microsystems, Inc. All Rights Reserved. -.\" 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 TNF_KERNEL_PROBES 4 "June 20, 2021" -.SH NAME -tnf_kernel_probes \- TNF kernel probes -.SH DESCRIPTION -The set of probes (trace instrumentation points) available in the standard -kernel. The probes log trace data to a kernel trace buffer in Trace Normal -Form (TNF). Kernel probes are controlled by \fBprex\fR(1). A snapshot of the -kernel trace buffer can be made using \fBtnfxtract\fR(1) and examined using -\fBtnfdump\fR(1). -.sp -.LP -Each probe has a \fIname\fR and is associated with a set of symbolic -\fIkeys\fR, or \fIcategories\fR. These are used to select and control probes -from \fBprex\fR(1). A probe that is enabled for tracing generates a \fBTNF\fR -record, called an \fIevent record\fR. An event record contains two common -members and may contain other probe-specific data members. -.SS "Common Members" -.in +2 -.nf -\fBtnf_probe_event\fR \fItag\fR -\fBtnf_time_delta\fR \fItime_delta\fR -.fi -.in -2 - -.sp -.ne 2 -.na -\fB\fItag\fR\fR -.ad -.RS 14n -Encodes \fBTNF\fR references to two other records: -.sp -.ne 2 -.na -\fB\fItag\fR\fR -.ad -.RS 12n -Describes the layout of the event record. -.RE - -.sp -.ne 2 -.na -\fB\fIschedule\fR\fR -.ad -.RS 12n -Identifies the writing thread and also contains a 64-bit base time in -nanoseconds. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fItime_delta\fR\fR -.ad -.RS 14n -A 32-bit time offset from the base time; the sum of the two times is the actual -time of the event. -.RE - -.SS "Threads" -.SS "\fBthread_create\fR" -.in +2 -.nf -\fBtnf_kthread_id\fR \fItid\fR -\fBtnf_pid\fR \fIpid\fR -\fBtnf_symbol\fR \fIstart_pc\fR -.fi -.in -2 - -.sp -.LP -Thread creation event. -.sp -.ne 2 -.na -\fB\fItid\fR\fR -.ad -.RS 12n -The thread identifier for the new thread. -.RE - -.sp -.ne 2 -.na -\fB\fIpid\fR\fR -.ad -.RS 12n -The process identifier for the new thread. -.RE - -.sp -.ne 2 -.na -\fB\fIstart_pc\fR\fR -.ad -.RS 12n -The kernel address of its start routine. -.RE - -.SS "\fBthread_state\fR" -.in +2 -.nf -\fBtnf_kthread_id\fR \fItid\fR -\fBtnf_microstate\fR \fIstate\fR -.fi -.in -2 - -.sp -.LP -Thread microstate transition events. -.sp -.ne 2 -.na -\fB\fItid\fR\fR -.ad -.RS 9n -Optional; if it is absent, the event is for the writing thread, otherwise the -event is for the specified thread. -.RE - -.sp -.ne 2 -.na -\fB\fIstate\fR\fR -.ad -.RS 9n -Indicates the thread state: -.RS +4 -.TP -.ie t \(bu -.el o -Running in user mode. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Running in system mode. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Asleep waiting for a user-mode lock. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Asleep on a kernel object. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Runnable (waiting for a cpu). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -Stopped. -.RE -The values of this member are defined in <\fBsys/msacct.h\fR>. Note that to -reduce trace output, transitions between the \fIsystem\fR and \fIuser\fR -microstates that are induced by system calls are not traced. This information -is implicit in the system call entry and exit events. -.RE - -.SS "thread_exit" -Thread termination event for writing thread. This probe has no data members -other than the common members. -.SS "Scheduling" -\fB\fR -.SS "thread_queue" -.in +2 -.nf -\fBtnf_kthread_id\fR \fItid\fR -\fBtnf_cpuid\fR \fIcpuid\fR -\fBtnf_long\fR \fIpriority\fR -\fBtnf_ulong\fR \fIqueue_length\fR -.fi -.in -2 - -.sp -.LP -Thread scheduling events. These are triggered when a runnable thread is placed -on a dispatch queue. -.sp -.ne 2 -.na -\fB\fIcpuid\fR\fR -.ad -.RS 16n -Specifies the cpu to which the queue is attached. -.RE - -.sp -.ne 2 -.na -\fB\fIpriority\fR\fR -.ad -.RS 16n -The (global) dispatch priority of the thread. -.RE - -.sp -.ne 2 -.na -\fB\fIqueue_length\fR\fR -.ad -.RS 16n -The current length of the cpu's dispatch queue. -.RE - -.SS "Blocking" -.SS "\fBthread_block\fR" -.in +2 -.nf -\fBtnf_opaque\fR \fIreason\fR -\fBtnf_symbols\fR \fIstack\fR -.fi -.in -2 - -.sp -.LP -Thread blockage event. This probe captures a partial stack backtrace when the -current thread blocks. -.sp -.ne 2 -.na -\fB\fIreason\fR\fR -.ad -.RS 11n -The address of the object on which the thread is blocking. -.RE - -.sp -.ne 2 -.na -\fB\fIsymbols\fR\fR -.ad -.RS 11n -References a \fBTNF\fR array of kernel addresses representing the PCs on the -stack at the time the thread blocks. -.RE - -.SS "System Calls" -.SS "\fBsyscall_start\fR" -.in +2 -.nf -\fBtnf_sysnum\fR \fIsysnum\fR -.fi -.in -2 - -.sp -.LP -System call entry event. -.sp -.ne 2 -.na -\fB\fIsysnum\fR\fR -.ad -.RS 10n -The system call number. The writing thread implicitly enters the \fIsystem\fR -microstate with this event. -.RE - -.SS "\fBsyscall_end\fR" -.in +2 -.nf -\fBtnf_long\fR \fIrval1\fR -\fBtnf_long\fR \fIrval2\fR -\fBtnf_long\fR \fIerrno\fR -.fi -.in -2 - -.sp -.LP -System call exit event. -.sp -.ne 2 -.na -\fB\fIrval1\fR and \fIrval2\fR\fR -.ad -.RS 19n -The two return values of the system call -.RE - -.sp -.ne 2 -.na -\fB\fIerrno\fR\fR -.ad -.RS 19n -The error return. -.RE - -.sp -.LP -The writing thread implicitly enters the \fIuser\fR microstate with this event. -.SS "Page Faults" -.SS "\fBaddress_fault\fR" -.in +2 -.nf -\fBtnf_opaque\fR \fIaddress\fR -\fBtnf_fault_type\fR \fIfault_type\fR -\fBtnf_seg_access\fR \fIaccess\fR -.fi -.in -2 - -.sp -.LP -Address-space fault event. -.sp -.ne 2 -.na -\fB\fIaddress\fR\fR -.ad -.RS 14n -Gives the faulting virtual address. -.RE - -.sp -.ne 2 -.na -\fB\fIfault_type\fR\fR -.ad -.RS 14n -Gives the fault type: invalid page, protection fault, software requested -locking or unlocking. -.RE - -.sp -.ne 2 -.na -\fB\fIaccess\fR\fR -.ad -.RS 14n -Gives the desired access protection: read, write, execute or create. The values -for these two members are defined in <\fBvm/seg_enum.h\fR>. -.RE - -.SS "\fBmajor_fault\fR" -.in +2 -.nf -\fBtnf_opaque\fR \fIvnode\fR -\fBtnf_offset\fR \fIoffset\fR -.fi -.in -2 - -.sp -.LP -Major page fault event. The faulting page is mapped to the file given by the -\fIvnode\fR member, at the given \fIoffset\fR into the file. (The faulting -virtual address is in the most recent \fBaddress_fault\fR event for the writing -thread.) -.SS "\fBanon_private\fR" -.in +2 -.nf -\fBtnf_opaque\fR \fIaddress\fR -.fi -.in -2 - -.sp -.LP -Copy-on-write page fault event. -.sp -.ne 2 -.na -\fB\fIaddress\fR\fR -.ad -.RS 11n -The virtual address at which the new page is mapped. -.RE - -.SS "\fBanon_zero\fR" -.in +2 -.nf -\fBtnf_opaque\fR \fIaddress\fR -.fi -.in -2 - -.sp -.LP -Zero-fill page fault event. -.sp -.ne 2 -.na -\fB\fIaddress\fR\fR -.ad -.RS 11n -The virtual address at which the new page is mapped. -.RE - -.SS "\fBpage_unmap\fR" -.in +2 -.nf -\fBtnf_opaque\fR \fIvnode\fR -\fBtnf_offset\fR \fIoffset\fR -.fi -.in -2 - -.sp -.LP -Page unmapping event. This probe marks the unmapping of a file system page -from the system. -.sp -.ne 2 -.na -\fB\fIvnode\fR and \fIoffset\fR\fR -.ad -.RS 20n -Identifies the file and offset of the page being unmapped. -.RE - -.SS "Pageins and Pageouts" -.SS "\fBpagein\fR" -.in +2 -.nf -\fBtnf_opaque\fR \fIvnode\fR -\fBtnf_offset\fR \fIoffset\fR -\fBtnf_size\fR \fIsize\fR -.fi -.in -2 - -.sp -.LP -Pagein start event. This event signals the initiation of pagein I/O. -.sp -.ne 2 -.na -\fB\fIvnode\fR and \fIoffset\fR\fR -.ad -.RS 18n -Identifies the file and offset to be paged in. -.RE - -.sp -.ne 2 -.na -\fB\fIsize\fR\fR -.ad -.RS 18n -Specifies the number of bytes to be paged in. -.RE - -.SS "\fBpageout\fR" -.in +2 -.nf -\fBtnf_opaque\fR \fIvnode\fR -\fBtnf_ulong\fR \fIpages_pageout\fR -\fBtnf_ulong\fR \fIpages_freed\fR -\fBtnf_ulong\fR \fIpages_reclaimed\fR -.fi -.in -2 - -.sp -.LP -Pageout completion event. This event signals the completion of pageout I/O. -.sp -.ne 2 -.na -\fB\fIvnode\fR\fR -.ad -.RS 19n -Identifies the file of the pageout request. -.RE - -.sp -.ne 2 -.na -\fB\fIpages_pageout\fR\fR -.ad -.RS 19n -The number of pages written out. -.RE - -.sp -.ne 2 -.na -\fB\fIpages_freed\fR\fR -.ad -.RS 19n -The number of pages freed after being written out. -.RE - -.sp -.ne 2 -.na -\fB\fIpages_reclaimed\fR\fR -.ad -.RS 19n -The number of pages reclaimed after being written out. -.RE - -.SS "Page Daemon (Page Stealer)" -.SS "\fBpageout_scan_start\fR" -.in +2 -.nf -\fBtnf_ulong\fR \fIpages_free\fR -\fBtnf_ulong\fR \fIpages_needed\fR -.fi -.in -2 - -.sp -.LP -Page daemon scan start event. This event signals the beginning of one -iteration of the page daemon. -.sp -.ne 2 -.na -\fB\fIpages_free\fR\fR -.ad -.RS 16n -The number of free pages in the system. -.RE - -.sp -.ne 2 -.na -\fB\fIpages_needed\fR\fR -.ad -.RS 16n -The number of pages desired free. -.RE - -.SS "\fBpageout_scan_end\fR" -.in +2 -.nf -\fBtnf_ulong\fR \fIpages_free\fR -\fBtnf_ulong\fR \fIpages_scanned\fR -.fi -.in -2 - -.sp -.LP -Page daemon scan end event. This event signals the end of one iteration of the -page daemon. -.sp -.ne 2 -.na -\fB\fIpages_free\fR\fR -.ad -.RS 17n -The number of free pages in the system. -.RE - -.sp -.ne 2 -.na -\fB\fIpages_scanned\fR\fR -.ad -.RS 17n -The number of pages examined by the page daemon. (Potentially more pages will -be freed when any queued pageout requests complete.) -.RE - -.SS "Swapper" -.SS "\fBswapout_process\fR" -.in +2 -.nf -\fBtnf_pid\fR \fIpid\fR -\fBtnf_ulong\fR \fIpage_count\fR -.fi -.in -2 - -.sp -.LP -Address space swapout event. This event marks the swapping out of a process -address space. -.sp -.ne 2 -.na -\fB\fIpid\fR\fR -.ad -.RS 14n -Identifies the process. -.RE - -.sp -.ne 2 -.na -\fB\fIpage_count\fR\fR -.ad -.RS 14n -Reports the number of pages either freed or queued for pageout. -.RE - -.SS "\fBswapout_lwp\fR" -.in +2 -.nf -\fBtnf_pid\fR \fIpid\fR -\fBtnf_lwpid\fR \fIlwpid\fR -\fBtnf_kthread_id\fR \fItid\fR -\fBtnf_ulong\fR \fIpage_count\fR -.fi -.in -2 - -.sp -.LP -Light-weight process swapout event. This event marks the swapping out of an -\fBLWP\fR and its stack. -.sp -.ne 2 -.na -\fB\fIpid\fR\fR -.ad -.RS 14n -The \fBLWP's\fR process identifier -.RE - -.sp -.ne 2 -.na -\fB\fIlwpid\fR\fR -.ad -.RS 14n -The \fBLWP\fR identifier -.RE - -.sp -.ne 2 -.na -\fB\fItid\fR \fImember\fR\fR -.ad -.RS 14n -The \fBLWP's\fR kernel thread identifier. -.RE - -.sp -.ne 2 -.na -\fB\fIpage_count\fR\fR -.ad -.RS 14n -The number of pages swapped out. -.RE - -.SS "\fBswapin_lwp\fR" -.in +2 -.nf -\fBtnf_pid\fR \fIpid\fR -\fBtnf_lwpid\fR \fIlwpid\fR -\fBtnf_kthread_id\fR \fItid\fR -\fBtnf_ulong\fR \fIpage_count\fR -.fi -.in -2 - -.sp -.LP -Light-weight process swapin event. This event marks the swapping in of an -\fBLWP\fR and its stack. -.sp -.ne 2 -.na -\fB\fIpid\fR\fR -.ad -.RS 14n -The \fBLWP's\fR process identifier. -.RE - -.sp -.ne 2 -.na -\fB\fIlwpid\fR\fR -.ad -.RS 14n -The \fBLWP\fR identifier. -.RE - -.sp -.ne 2 -.na -\fB\fItid\fR\fR -.ad -.RS 14n -The \fBLWP's\fR kernel thread identifier. -.RE - -.sp -.ne 2 -.na -\fB\fIpage_count\fR\fR -.ad -.RS 14n -The number of pages swapped in. -.RE - -.SS "Local I/O" -.SS "\fBstrategy\fR" -.in +2 -.nf -\fBtnf_device\fR \fIdevice\fR -\fBtnf_diskaddr\fR \fIblock\fR -\fBtnf_size\fR \fIsize\fR -\fBtnf_opaque\fR \fIbuf\fR -\fBtnf_bioflags\fR \fI flags\fR -.fi -.in -2 - -.sp -.LP -Block I/O strategy event. This event marks a call to the \fBstrategy\fR(9E) -function of a block device driver. -.sp -.ne 2 -.na -\fB\fIdevice\fR\fR -.ad -.RS 10n -Contains the major and minor numbers of the device. -.RE - -.sp -.ne 2 -.na -\fB\fIblock\fR\fR -.ad -.RS 10n -The logical block number to be accessed on the device. -.RE - -.sp -.ne 2 -.na -\fB\fIsize\fR\fR -.ad -.RS 10n -The size of the I/O request. -.RE - -.sp -.ne 2 -.na -\fB\fIbuf\fR\fR -.ad -.RS 10n -The kernel address of the \fBbuf\fR(9S) structure associated with the transfer. -.RE - -.sp -.ne 2 -.na -\fB\fIflags\fR\fR -.ad -.RS 10n -The \fBbuf\fR(9S) flags associated with the transfer. -.RE - -.SS "\fBbiodone\fR" -.in +2 -.nf -\fBtnf_device\fR \fIdevice\fR -\fBtnf_diskaddr\fR \fIblock\fR -\fBtnf_opaque\fR \fIbuf\fR -.fi -.in -2 - -.sp -.LP -Buffered I/O completion event. This event marks calls to the \fBbiodone\fR(9F) -function. -.sp -.ne 2 -.na -\fB\fIdevice\fR\fR -.ad -.RS 10n -Contains the major and minor numbers of the device. -.RE - -.sp -.ne 2 -.na -\fB\fIblock\fR\fR -.ad -.RS 10n -The logical block number accessed on the device. -.RE - -.sp -.ne 2 -.na -\fB\fIbuf\fR\fR -.ad -.RS 10n -The kernel address of the \fBbuf\fR(9S) structure associated with the transfer. -.RE - -.SS "\fBphysio_start\fR" -.in +2 -.nf -\fBtnf_device\fR \fIdevice\fR -\fBtnf_offset\fR \fIoffset\fR -\fBtnf_size\fR \fIsize\fR -\fBtnf_bioflags\fR \fIrw\fR -.fi -.in -2 - -.sp -.LP -Raw I/O start event. This event marks entry into the \fBphysio\fR(9F) -function which performs unbuffered I/O. -.sp -.ne 2 -.na -\fB\fIdevice\fR\fR -.ad -.RS 10n -Contains the major and minor numbers of the device of the transfer. -.RE - -.sp -.ne 2 -.na -\fB\fIoffset\fR\fR -.ad -.RS 10n -The logical offset on the device for the transfer. -.RE - -.sp -.ne 2 -.na -\fB\fIsize\fR\fR -.ad -.RS 10n -The number of bytes to be transferred. -.RE - -.sp -.ne 2 -.na -\fB\fIrw\fR\fR -.ad -.RS 10n -The direction of the transfer: read or write (see \fBbuf\fR(9S)). -.RE - -.SS "\fBphysio_end\fR" -.in +2 -.nf -\fBtnf_device\fR \fIdevice\fR -.fi -.in -2 - -.sp -.LP -Raw I/O end event. This event marks exit from the \fBphysio\fR(9F) function. -.sp -.ne 2 -.na -\fB\fIdevice\fR\fR -.ad -.RS 10n -The major and minor numbers of the device of the transfer. -.RE - -.SH USAGE -Use the \fBprex\fR utility to control kernel probes. The standard \fBprex\fR -commands to list and manipulate probes are available to you, along with -commands to set up and manage kernel tracing. -.sp -.LP -Kernel probes write trace records into a kernel trace buffer. You must copy the -buffer into a TNF file for post-processing; use the \fBtnfxtract\fR utility for -this. -.sp -.LP -You use the \fBtnfdump\fR utility to examine a kernel trace file. This is -exactly the same as examining a user-level trace file. -.sp -.LP -The steps you typically follow to take a kernel trace are: -.RS +4 -.TP -1. -Become superuser (\fBsu\fR). -.RE -.RS +4 -.TP -2. -Allocate a kernel trace buffer of the desired size (\fBprex\fR). -.RE -.RS +4 -.TP -3. -Select the probes you want to trace and enable (\fBprex\fR). -.RE -.RS +4 -.TP -4. -Turn kernel tracing on (\fBprex\fR). -.RE -.RS +4 -.TP -5. -Run your application. -.RE -.RS +4 -.TP -6. -Turn kernel tracing off (\fBprex\fR). -.RE -.RS +4 -.TP -7. -Extract the kernel trace buffer (\fBtnfxtract\fR). -.RE -.RS +4 -.TP -8. -Disable all probes (\fBprex\fR). -.RE -.RS +4 -.TP -9. -Deallocate the kernel trace buffer (\fBprex\fR). -.RE -.RS +4 -.TP -10. -Examine the trace file (\fBtnfdump\fR). -.RE -.sp -.LP -A convenient way to follow these steps is to use two shell windows; run an -interactive \fBprex\fR session in one, and run your application and -\fBtnfxtract\fR in the other. -.SH SEE ALSO -\fBprex\fR(1), \fBtnfdump\fR(1), \fBtnfxtract\fR(1), \fBlibtnfctl\fR(3TNF), -\fBTNF_PROBE\fR(3TNF), \fBtracing\fR(3TNF), \fBstrategy\fR(9E), -\fBbiodone\fR(9F), \fBphysio\fR(9F), \fBbuf\fR(9S) diff --git a/usr/src/man/man4/ts_dptbl.4 b/usr/src/man/man4/ts_dptbl.4 deleted file mode 100644 index 9dbcc11d15..0000000000 --- a/usr/src/man/man4/ts_dptbl.4 +++ /dev/null @@ -1,452 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T, Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved -.\" 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 TS_DPTBL 4 "Oct 15, 2002" -.SH NAME -ts_dptbl \- time-sharing dispatcher parameter table -.SH DESCRIPTION -The process scheduler (or dispatcher) is the portion of the kernel that -controls allocation of the \fBCPU\fR to processes. The scheduler supports the -notion of scheduling classes where each class defines a scheduling policy, used -to schedule processes within that class. Associated with each scheduling class -is a set of priority queues on which ready to run processes are linked. These -priority queues are mapped by the system configuration into a set of global -scheduling priorities which are available to processes within the class. (The -dispatcher always selects for execution the process with the highest global -scheduling priority in the system.) The priority queues associated with a given -class are viewed by that class as a contiguous set of priority levels numbered -from 0 (lowest priority) to \fIn\fR (highest priority\(ema -configuration-dependent value). The set of global scheduling priorities that -the queues for a given class are mapped into might not start at zero and might -not be contiguous (depending on the configuration). -.sp -.LP -Processes in the time-sharing class which are running in user mode (or in -kernel mode before going to sleep) are scheduled according to the parameters in -a time-sharing dispatcher parameter table (\fBts_dptbl\fR). Processes in the -inter-active scheduling class are also scheduled according to the parameters in -the time-sharing dispatcher parameter table. (Time-sharing processes and -inter-active processes running in kernel mode after sleeping are run within a -special range of priorities reserved for such processes and are not affected by -the parameters in the \fBts_dptbl\fR until they return to user mode.) The -\fBts_dptbl\fR consists of an array (\fBconfig_ts_dptbl[]\fR) of parameter -structures (\fBstruct tsdpent_t\fR), one for each of the \fIn\fR priority -levels used by time-sharing processes and inter-active processes in user mode. -The structures are accessed via a pointer, (\fBts_dptbl\fR), to the array. The -properties of a given priority level \fIi\fR are specified by the \fIi\fRth -parameter structure in this array (\fBts_dptbl[\fR \fIi\fR\fB]\fR ). -.sp -.LP -A parameter structure consists of the following members. These are also -described in the \fB/usr/include/sys/ts.h\fR header. -.sp -.ne 2 -.na -\fB\fBts_globpri\fR\fR -.ad -.RS 14n -The global scheduling priority associated with this priority level. The mapping -between time-sharing priority levels and global scheduling priorities is -determined at boot time by the system configuration. \fBts_globpri\fR is the -only member of the \fBts_dptbl\fR which cannot be changed with -\fBdispadmin\fR(1M). -.RE - -.sp -.ne 2 -.na -\fB\fBts_quantum\fR\fR -.ad -.RS 14n -The length of the time quantum allocated to processes at this level in ticks -(\fBhz\fR). -.sp -In the default high resolution clock mode (\fBhires_tick\fR set to \fB1\fR), -the value of \fBhz\fR is set to \fB1000\fR. If this value is overridden to -\fB0\fR then \fBhz\fR will instead be \fB100\fR; the number of ticks per -quantum must then be decreased to maintain the same length of quantum in -absolute time. -.RE - -.sp -.ne 2 -.na -\fB\fBts_tqexp\fR\fR -.ad -.RS 14n -Priority level of the new queue on which to place a process running at the -current level if it exceeds its time quantum. Normally this field links to a -lower priority time-sharing level that has a larger quantum. -.RE - -.sp -.ne 2 -.na -\fB\fBts_slpret\fR\fR -.ad -.RS 14n -Priority level of the new queue on which to place a process, that was -previously in user mode at this level, when it returns to user mode after -sleeping. Normally this field links to a higher priority level that has a -smaller quantum. -.RE - -.sp -.ne 2 -.na -\fB\fBts_maxwait\fR\fR -.ad -.RS 14n -A per process counter, \fBts_dispwait\fR is initialized to zero each time a -time-sharing or inter-active process is placed back on the dispatcher queue -after its time quantum has expired or when it is awakened (\fBts_dispwait\fR is -not reset to zero when a process is preempted by a higher priority process). -This counter is incremented once per second for each process on a dispatcher or -sleep queue. If a process' \fBts_dispwait\fR value exceeds the \fBts_maxwait\fR -value for its level, the process' priority is changed to that indicated by -\fBts_lwait\fR. The purpose of this field is to prevent starvation. -.RE - -.sp -.ne 2 -.na -\fB\fBts_lwait\fR\fR -.ad -.RS 14n -Move a process to this new priority level if \fBts_dispwait\fR is greater than -\fBts_maxwait\fR. -.RE - -.sp -.LP -An administrator can affect the behavior of the time-sharing portion of the -scheduler by reconfiguring the \fBts_dptbl\fR. Since processes in the -time-sharing and inter-active scheduling classes share the same dispatch -parameter table (\fBts_dptbl\fR), changes to this table will affect both -scheduling classes. There are two methods available for doing this: reconfigure -with a loadable module at boot-time or by using \fBdispadmin\fR(1M) at -run-time. -.SS "ts_dptbl Loadable Module" -The \fBts_dptbl\fR can be reconfigured with a loadable module which contains a -new time sharing dispatch table. The module containing the dispatch table is -separate from the TS loadable module which contains the rest of the -time-sharing and inter-active software. This is the only method that can be -used to change the number of time-sharing priority levels or the set of global -scheduling priorities used by the time-sharing and inter-active classes. The -relevant procedure and source code is described in the \fBREPLACING THE -TS_DPTBL LOADABLE MODULE\fR section. -.SS "dispadmin Configuration File" -With the exception of \fBts_globpri\fR all of the members of the \fBts_dptbl\fR -can be examined and modified on a running system using the \fBdispadmin\fR(1M) -command. Invoking \fBdispadmin\fR for the time-sharing or inter-active class -allows the administrator to retrieve the current \fBts_dptbl\fR configuration -from the kernel's in-core table, or overwrite the in-core table with values -from a configuration file. The configuration file used for input to -\fBdispadmin\fR must conform to the specific format described below. -.sp -.LP -Blank lines are ignored and any part of a line to the right of a \fI#\fR symbol -is treated as a comment. The first non-blank, non-comment line must indicate -the resolution to be used for interpreting the \fBts_quantum\fR time quantum -values. The resolution is specified as -.sp -.in +2 -.nf -\fBRES=\fR\fIres\fR -.fi -.in -2 - -.sp -.LP -where \fIres\fR is a positive integer between 1 and 1,000,000,000 inclusive and -the resolution used is the reciprocal of \fIres\fR in seconds (for example, -\fBRES=1000\fR specifies millisecond resolution). Although very fine -(nanosecond) resolution may be specified, the time quantum lengths are rounded -up to the next integral multiple of the system clock's resolution. -.sp -.LP -The remaining lines in the file are used to specify the parameter values for -each of the time-sharing priority levels. The first line specifies the -parameters for time-sharing level 0, the second line specifies the parameters -for time-sharing level 1, etc. There must be exactly one line for each -configured time-sharing priority level. -.SH EXAMPLES -\fBExample 1 \fRA Sample From a Configuration File -.sp -.LP -The following excerpt from a \fBdispadmin\fR configuration file illustrates the -format. Note that for each line specifying a set of parameters there is a -comment indicating the corresponding priority level. These level numbers -indicate priority within the time-sharing and interactive classes, and the -mapping between these time-sharing priorities and the corresponding global -scheduling priorities is determined by the configuration specified in the -\fBts\fR master file. The level numbers are strictly for the convenience of the -administrator reading the file and, as with any comment, they are ignored by -\fBdispadmin\fR. \fBdispadmin\fR assumes that the lines in the file are ordered -by consecutive, increasing priority level (from 0 to the maximum configured -time-sharing priority). The level numbers in the comments should normally agree -with this ordering; if for some reason they don't, however, \fBdispadmin\fR is -unaffected. - -.sp -.in +2 -.nf -# Time-Sharing Dispatcher Configuration File RES=1000 - - -# ts_quantum ts_tqexp ts_slpret ts_maxwait ts_lwait PRIORITY -# LEVEL -500 0 10 5 10 # 0 -500 0 11 5 11 # 1 -500 1 12 5 12 # 2 -500 1 13 5 13 # 3 -500 2 14 5 14 # 4 -500 2 15 5 15 # 5 -450 3 16 5 16 # 6 -450 3 17 5 17 # 7 -\&. . . . . . . -\&. . . . . . . -\&. . . . . . . -50 48 59 5 59 # 58 -50 49 59 5 59 # 59 -.fi -.in -2 - -.LP -\fBExample 2 \fRReplacing The ts_dptbl Loadable Module -.sp -.LP -In order to change the size of the time sharing dispatch table, the loadable -module which contains the dispatch table information will have to be built. It -is recommended that you save the existing module before using the following -procedure. - -.RS +4 -.TP -1. -Place the dispatch table code shown below in a file called \fBts_dptbl.c\fR -An example of this file follows. -.RE -.RS +4 -.TP -2. -Compile the code using the given compilation and link lines supplied. -.sp -.in +2 -.nf -cc -c -0 -D_KERNEL -ts_dptbl.c -ld -r -o TS_DPTBL ts_dptbl.o -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -3. -Copy the current dispatch table in \fB/kernel/sched\fR to -\fBTS_DPTBL.bak\fR. -.RE -.RS +4 -.TP -4. -Replace the current \fBTS_DPTBL\fR in \fB/kernel/sched\fR. -.RE -.RS +4 -.TP -5. -You will have to make changes in the \fB/etc/system\fR file to reflect the -changes to the sizes of the tables. See \fBsystem\fR(4). The two variables -affected are \fBts_maxupri\fR and \fBts_maxkmdpri\fR. The syntax for setting -these is as follows: -.sp -.in +2 -.nf -set TS:ts_maxupri=(value for max time-sharing user priority) -set TS:ts_maxkmdpri=(number of kernel mode priorities - 1) -.fi -.in -2 -.sp - -.RE -.RS +4 -.TP -6. -Reboot the system to use the new dispatch table. -.RE -.sp -.LP -Great care should be used in replacing the dispatch table using this method. If -you do not get it right, panics may result, thus making the system unusable. - -.sp -.LP -The following is an example of a \fBts_dptbl.c\fR file used for building the -new \fBts_dptbl\fR. - -.sp -.in +2 -.nf -/* BEGIN ts_dptbl.c */ -#include <sys/proc.h> -#include <sys/priocntl.h> -#include <sys/class.h> -#include <sys/disp.h> -#include <sys/ts.h> -#include <sys/rtpriocntl.h> -/* - * This is the loadable module wrapper. - */ -#include <sys/modctl.h> -extern struct mod_ops mod_miscops; -/* - * Module linkage information for the kernel. - */ -static struct modlmisc modlmisc = { - &mod_miscops, "Time sharing dispatch table" -}; -static struct modlinkage modlinkage = { - MODREV_1, &modlmisc, 0 -}; -_init() -{ - return (mod_install(&modlinkage)); -} -_info(modinfop) - struct modinfo *modinfop; -{ - return (mod_info(&modlinkage, modinfop)); -} -/* - * array of global priorities used by ts procs sleeping or - * running in kernel mode after sleep. Must have at least - * 40 values. - */ -pri_t config_ts_kmdpris[] = { - 60,61,62,63,64,65,66,67,68,69, - 70,71,72,73,74,75,76,77,78,79, - 80,81,82,83,84,85,86,87,88,89, - 90,91,92,93,94,95,96,97,98,99, -}; -tsdpent_t config_ts_dptbl[] = { - -/* glbpri qntm tqexp slprt mxwt lwt */ - - 0, 100, 0, 10, 5, 10, - 1, 100, 0, 11, 5, 11, - 2, 100, 1, 12, 5, 12, - 3, 100, 1, 13, 5, 13, - 4, 100, 2, 14, 5, 14 - 5, 100, 2, 15, 5, 15, - 6, 100, 3, 16, 5, 16, - 7, 100, 3, 17, 5, 17, - 8, 100, 4, 18, 5, 18, - 9, 100, 4, 19, 5, 19, - 10, 80, 5, 20, 5, 20, - 11, 80, 5, 21, 5, 21, - 12, 80, 6, 22, 5, 22, - 13, 80, 6, 23, 5, 23, - 14, 80, 7, 24, 5, 24, - 15, 80, 7, 25, 5, 25, - 16, 80, 8, 26, 5, 26, - 17, 80, 8, 27, 5, 27, - 18, 80, 9, 28, 5, 28, - 19, 80, 9, 29, 5, 29, - 20, 60, 10, 30, 5, 30, - 21, 60, 11, 31, 5, 31, - 22, 60, 12, 32, 5, 33, - 24, 60, 14, 34, 5, 34, - 25, 60, 15, 35, 5, 35, - 26, 60, 16, 36, 5, 36, - 27, 60, 17, 37, 5, 37, - 28, 60, 18, 38, 5, 38, - 29, 60, 19, 39, 5, 39, - 30, 40, 20, 40, 5, 40, - 31, 40, 21, 41, 5, 41, - 32, 40, 22, 42, 5, 42, - 33, 40, 23, 43, 5, 43, - 34, 40, 24, 44, 5, 44, - 35, 40, 25, 45, 5, 45, - 36, 40, 26, 46, 5, 46, - 37, 40, 27, 47, 5, 47, - 38, 40, 28, 48, 5, 48, - 39, 40, 29, 49, 5, 49, - 40, 20, 30, 50, 5, 50, - 41, 20, 31, 50, 5, 50, - 42, 20, 32, 51, 5, 51, - 43, 20, 33, 51, 5, 51, - 44, 20, 34, 52, 5, 52, - 45, 20, 35, 52, 5, 52, - 46, 20, 36, 53, 5, 53, - 47, 20 37, 53, 5, 53, - 48, 20, 38, 54, 5, 54, - 49, 20, 39, 54, 5, 54, - 50, 10, 40, 55, 5, 55, - 51, 10, 41, 55, 5, 55, - 52, 10, 42, 56, 5, 56, - 53, 10, 43, 56, 5, 56, - 54, 10, 44, 57, 5, 57, - 55, 10, 45, 57, 5, 57, - 56, 10, 46, 58, 5, 58, - 57, 10, 47, 58, 5, 58, - 58, 10, 48, 59, 5, 59, - 59, 10, 49, 59, 5, 59, - -}; - -short config_ts_maxumdpri = sizeof (config_ts_dptbl)/16 - 1; -/* - * Return the address of config_ts_dptbl - */ -tsdpent_t * -ts_getdptbl() -{ - return (config_ts_dptbl); -} - -/* - * Return the address of config_ts_kmdpris - */ - int * - ts_getkmdpris() -{ - return (config_ts_kmdpris); -} - -/* - * Return the address of ts_maxumdpri - */ -short -ts_getmaxumdpri() -{ - return (config_ts_maxumdpri); -} - -/* END ts_dptbl.c */ -.fi -.in -2 - -.SH SEE ALSO -\fBpriocntl\fR(1), \fBdispadmin\fR(1M), \fBpriocntl\fR(2), \fBsystem\fR(4) -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.sp -.LP -\fIProgramming Interfaces Guide\fR -.SH NOTES -\fBdispadmin\fR does some limited sanity checking on the values supplied in the -configuration file. The sanity checking is intended to ensure that the new -\fBts_dptbl\fR values do not cause the system to panic. The sanity checking -does not attempt to analyze the effect that the new values will have on the -performance of the system. Unusual \fBts_dptbl\fR configurations may have a -dramatic negative impact on the performance of the system. -.sp -.LP -No sanity checking is done on the \fBts_dptbl\fR values specified in the -\fBTS_DPTBL\fR loadable module. Specifying an inconsistent or nonsensical -\fBts_dptbl\fR configuration through the \fBTS_DPTBL\fR loadable module could -cause serious performance problems and/or cause the system to panic. diff --git a/usr/src/man/man4/ttydefs.4 b/usr/src/man/man4/ttydefs.4 deleted file mode 100644 index 4529e2f8f9..0000000000 --- a/usr/src/man/man4/ttydefs.4 +++ /dev/null @@ -1,85 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved -.\" 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 TTYDEFS 4 "Jan 27, 1994" -.SH NAME -ttydefs \- file contains terminal line settings information for ttymon -.SH DESCRIPTION -.sp -.LP -\fB/etc/ttydefs\fR is an administrative file that contains records divided into -fields by colons (":"). This information used by \fBttymon\fR to set up the -speed and terminal settings for a TTY port. -.sp -.LP -The \fBttydefs\fR file contains the following fields: -.sp -.ne 2 -.na -\fB\fIttylabel\fR\fR -.ad -.RS 17n -The string \fBttymon\fR tries to match against the TTY port's \fIttylabel\fR -field in the port monitor administrative file. It often describes the speed at -which the terminal is supposed to run, for example, \fB1200\fR. -.RE - -.sp -.ne 2 -.na -\fB\fIinitial-flags\fR\fR -.ad -.RS 17n -Contains the initial \fBtermio\fR(7I) settings to which the terminal is to be -set. For example, the system administrator will be able to specify what the -default erase and kill characters will be. \fIinitial-flags\fR must be -specified in the syntax recognized by the \fBstty\fR command. -.RE - -.sp -.ne 2 -.na -\fB\fIfinal-flags\fR\fR -.ad -.RS 17n -\fIfinal-flags\fR must be specified in the same format as \fIinitial-flags\fR. -\fBttymon\fR sets these final settings after a connection request has been made -and immediately prior to invoking a port's service. -.RE - -.sp -.ne 2 -.na -\fB\fIautobaud\fR\fR -.ad -.RS 17n -If the autobaud field contains the character 'A,' autobaud will be enabled. -Otherwise, autobaud will be disabled. \fBttymon\fR determines what line speed -to set the TTY port to by analyzing the carriage returns entered. If autobaud -has been disabled, the hunt sequence is used for baud rate determination. -.RE - -.sp -.ne 2 -.na -\fB\fInextlabel\fR\fR -.ad -.RS 17n -If the user indicates that the current terminal setting is not appropriate by -sending a BREAK, \fBttymon\fR searchs for a \fBttydefs\fR entry whose -\fIttylabel\fR field matches the \fInextlabel\fR field. If a match is found, -\fBttymon\fR uses that field as its \fIttylabel\fR field. A series of speeds is -often linked together in this way into a closed set called a hunt sequence. For -example, \fB4800\fR may be linked to \fB1200\fR, which in turn is linked to -\fB2400\fR, which is finally linked to \fB4800\fR. -.RE - -.SH SEE ALSO -.sp -.LP -\fBsttydefs\fR(1M), \fBttymon\fR(1M), \fBtermio\fR(7I) -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR diff --git a/usr/src/man/man4/ttysrch.4 b/usr/src/man/man4/ttysrch.4 deleted file mode 100644 index 65043b9a2a..0000000000 --- a/usr/src/man/man4/ttysrch.4 +++ /dev/null @@ -1,95 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T -.\" 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 TTYSRCH 4 "Feb 23, 1994" -.SH NAME -ttysrch \- directory search list for ttyname -.SH DESCRIPTION -.sp -.LP -\fBttysrch\fR is an optional file that is used by the \fBttyname\fR library -routine. This file contains the names of directories in \fB/dev\fR that contain -terminal and terminal-related device files. The purpose of this file is to -improve the performance of \fBttyname\fR by indicating which subdirectories in -\fB/dev\fR contain terminal-related device files and should be searched first. -These subdirectory names must appear on separate lines and must begin with -\fB/dev\fR. Those path names that do not begin with \fB/dev\fR will be ignored -and a warning will be sent to the console. Blank lines (lines containing only -white space) and lines beginning with the comment character "#" will be -ignored. For each file listed (except for the special entry \fB/dev\fR), -\fBttyname\fR will recursively search through subdirectories looking for a -match. If \fB/dev\fR appears in the \fBttysrch\fR file, the \fB/dev\fR -directory itself will be searched but there will not be a recursive search -through its subdirectories. -.sp -.LP -When \fBttyname\fR searches through the device files, it tries to find a file -whose major/minor device number, file system identifier, and inode number match -that of the file descriptor it was given as an argument. If a match is not -found, it will settle for a match of just major/minor device and file system -identifier, if one can be found. However, if the file descriptor is associated -with a cloned device, this algorithm does not work efficiently because the -inode number of the device file associated with a clonable device will never -match the inode number of the file descriptor that was returned by the open of -that clonable device. To help with these situations, entries can be put into -the \fB/etc/ttysrch\fR file to improve performance when cloned devices are used -as terminals on a system (for example, for remote login). However, this is -only useful if the minor devices related to a cloned device are put into a -subdirectory. (It is important to note that device files need not exist for -cloned devices and if that is the case, \fBttyname\fR will eventually fail.) An -optional second field is used in the \fB/etc/ttysrch\fR file to indicate the -matching criteria. This field is separated by white space (any combination of -blanks or tabs). The letter \fBM\fR means major/minor device number, \fBF\fR -means file system identifier, and \fBI\fR means inode number. If this field is -not specified for an entry, the default is \fBMFI\fR which means try to match -on all three. For cloned devices the field should be \fBMF\fR, which indicates -that it is not necessary to match on the inode number. -.sp -.LP -Without the \fB/etc/ttysrch\fR file, \fBttyname\fR will search the \fB/dev\fR -directory by first looking in the directories \fB/dev/term\fR, \fB/dev/pts\fR, -and \fB/dev/xt\fR. If a system has terminal devices installed in directories -other than these, it may help performance if the \fBttysrch\fR file is created -and contains that list of directories. -.SH EXAMPLES -.LP -\fBExample 1 \fRA sample display of \fB/etc/ttysrch\fR command. -.sp -.LP -A sample \fB/etc/ttysrch\fR file follows: - -.sp -.in +2 -.nf -/dev/term MFI -/dev/pts MFI -/dev/xt MFI -/dev/slan MF -.fi -.in -2 -.sp - -.sp -.LP -This file tells \fBttyname\fR that it should first search through those -directories listed and that when searching through the \fB/dev/slan\fR -directory, if a file is encountered whose major/minor devices and file system -identifier match that of the file descriptor argument to \fBttyname\fR, this -device name should be considered a match. - -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/ttysrch\fR\fR -.ad -.RS 16n - -.RE - -.SH SEE ALSO -.sp -.LP -\fBttyname\fR(3C) diff --git a/usr/src/man/man4/ufsdump.4 b/usr/src/man/man4/ufsdump.4 deleted file mode 100644 index 49d27c5fef..0000000000 --- a/usr/src/man/man4/ufsdump.4 +++ /dev/null @@ -1,740 +0,0 @@ -'\" te -.\" Copyright (c) 1980 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.TH UFSDUMP 4 "June 19, 2021" -.SH NAME -ufsdump, dumpdates \- incremental dump format -.SH SYNOPSIS -.nf -\fB#include <protocols/dumprestore.h>\fR -.fi - -.LP -.nf -\fB/etc/dumpdates\fR -.fi - -.SH DESCRIPTION -Tapes used by \fBufsdump\fR(1M) and \fBufsrestore\fR(1M) contain: -.RS +4 -.TP -.ie t \(bu -.el o -a header record -.RE -.RS +4 -.TP -.ie t \(bu -.el o -two groups of bit map records -.RE -.RS +4 -.TP -.ie t \(bu -.el o -a group of records describing directories -.RE -.RS +4 -.TP -.ie t \(bu -.el o -a group of records describing files -.RE -.sp -.LP -The format of the header record and the format of the first record of each -description in the \fB<protocols/dumprestore.h>\fR include file are: -.sp -.in +2 -.nf -#define TP_BSIZE_MAX 65536 -#define TP_BSIZE_MIN 1024 -#define ESIZE_SHIFT_MAX 6 - -#ifdef SUPPORTS_MTB_TAPE_FORMAT -#define TP_BUFSIZE TP_BSIZE_MAX -#else -#define TP_BSIZE 1024 -#define TP_BUFSIZE TP_BSIZE -#endif /* SUPPORTS_MTB_TAPE_FORMAT */ - -#define NTREC 10 -#define HIGHDENSITYTREC 32 -#define CARTRIDGETREC 63 -#define TP_NINDIR (TP_BSIZE_MIN/2) -#define TP_NINOS (TP_NINDIR / sizeof (long)) -#define LBLSIZE 16 -#define NAMELEN 64 - -#define OFS_MAGIC (int)60011 -#define NFS_MAGIC (int)60012 -#define MTB_MAGIC (int)60013 -#define CHECKSUM (int)84446 -.fi -.in -2 - -.sp -.in +2 -.nf -union u_data { - char s_addrs[TP_NINDIR]; - int32_t s_inos[TP_NINOS]; -}; - -union u_shadow { - struct s_nonsh { - int32_t c_level; - char c_filesys[NAMELEN]; - char c_dev[NAMELEN]; - char c_host[NAMELEN]; - } c_nonsh; - char c_shadow[1]; -}; - -union u_spcl { - char dummy[TP_BUFSIZE]; - struct s_spcl { - int32_t c_type; - time32_t c_date; - time32_t c_ddate; - int32_t c_volume; - daddr32_t c_tapea; - ino32_t c_inumber; - int32_t c_magic; - int32_t c_checksum; - struct dinode c_dinode; - int32_t c_count; - union u_data c_data; - char c_label[LBLSIZE]; - union u_shadow c_shadow; - int32_t c_flags; - int32_t c_firstrec; -#ifdef SUPPORTS_MTB_TAPE_FORMAT - int32_t c_tpbsize; - int32_t c_spare[31]; -#else - int32_t c_spare[32]; -#endif /* SUPPORTS_MTB_TAPE_FORMAT */ -} s_spcl; -} u_spcl; -.fi -.in -2 - -.sp -.in +2 -.nf -int32_t c_type; -time32_t c_date; -time32_t c_ddate; -int32_t c_volume; -daddr32_t c_tapea; -ino32_t c_inumber; -int32_t c_magic; -int32_t c_checksum; -struct dinode c_dinode; -int32_t c_count; -union u_data c_data; -char c_label[LBLSIZE]; -union u_shadow c_shadow; -int32_t c_flags; -int32_t c_firstrec; -#ifdef SUPPORTS_MTB_TAPE_FORMAT -int32_t c_tpbsize; -int32_t c_spare[31]; -#else -int32_t c_spare[32]; -#endif /* - SUPPORTS_MTB_TAPE_FORMAT */ -.fi -.in -2 - -.sp -.in +2 -.nf - } s_spcl; -} u_spcl; -#define spcl u_spcl.s_spcl -#define c_addr c_data.s_addrs -#define c_inos c_data.s_inos -#define c_level c_shadow.c_nonsh.c_level -#define c_filesys c_shadow.c_nonsh.c_filesys -#define c_dev c_shadow.c_nonsh.c_dev -#define c_host c_shadow.c_nonsh.c_host -.fi -.in -2 - -.sp -.in +2 -.nf -#define TS_TAPE 1 -#define TS_INODE 2 -#define TS_ADDR 4 -#define TS_BITS 3 -#define TS_CLRI 6 -#define TS_END 5 -#define TS_EOM 7 - -#define DR_NEWHEADER 1 -#define DR_INODEINFO 2 -#define DR_REDUMP 4 -#define DR_TRUEINC 8 -#define DR_HASMETA 16 -.fi -.in -2 - -.sp -.LP -This header describes three formats for the \fBufsdump\fR/\fBufsrestore\fR -interface: -.RS +4 -.TP -.ie t \(bu -.el o -An old format, non-MTB, that supports dump sizes of less than 2 terabytes. This -format is represented by \fBNFS_MAGIC\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A new format, MTB, that supports dump sizes of greater than 2 terabytes using a -variable block size and 2 new constants: \fBTP_BSIZE_MIN\fR and -\fBTP_BSIZE_MAX\fR. This format is represented by \fBMTB_MAGIC\fR. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -A much older format that might be found on existing backup tapes. The -\fBufsrestore\fR command can restore tapes of this format, but no longer -generates tapes of this format. Backups in this format have the \fBOFS_MAGIC\fR -magic number in their tape headers. -.RE -.sp -.LP -The constants are described as follows: -.sp -.ne 2 -.na -\fB\fBTP_BSIZE\fR\fR -.ad -.RS 20n -Size of file blocks on the dump tapes for the old format. Note that -\fBTP_BSIZE\fR must be a multiple of \fBDEV_BSIZE\fR This is applicable for -dumps of type \fBNFS_MAGIC\fR or \fBOFS_MAGIC\fR, but is not applicable for -dumps of type \fBMTB_MAGIC\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBTP_BSIZE_MIN\fR\fR -.ad -.RS 20n -Minimum size of file blocks on the dump tapes for the new MTB format -(\fBMTB_MAGIC\fR) only. -.RE - -.sp -.ne 2 -.na -\fB\fBTP_BSIZE_MAX\fR\fR -.ad -.RS 20n -Maximum size of file blocks on the dump tapes for the new MTB format -(\fBMTB_MAGIC\fR) only. -.RE - -.sp -.ne 2 -.na -\fB\fBNTREC\fR\fR -.ad -.RS 20n -Number of \fBTP_BSIZE\fR blocks that are written in each tape record. -.RE - -.sp -.ne 2 -.na -\fB\fBHIGHDENSITYNTREC\fR\fR -.ad -.RS 20n -Number of \fBTP_BSIZE\fR blocks that are written in each tape record on 6250 -BPI or higher density tapes. -.RE - -.sp -.ne 2 -.na -\fB\fBCARTRIDGETREC\fR\fR -.ad -.RS 20n -Number of \fBTP_BSIZE\fR blocks that are written in each tape record on -cartridge tapes. -.RE - -.sp -.ne 2 -.na -\fB\fBTP_NINDIR\fR\fR -.ad -.RS 20n -Number of indirect pointers in a \fBTS_INODE\fR or \fBTS_ADDR\fR record. It -must be a power of 2. -.RE - -.sp -.ne 2 -.na -\fB\fBTP_NINOS\fR\fR -.ad -.RS 20n -The maximum number of volumes on a tape. -.RE - -.sp -.ne 2 -.na -\fB\fBLBLSIZE\fR\fR -.ad -.RS 20n -The maximum size of a volume label. -.RE - -.sp -.ne 2 -.na -\fB\fBNAMELEN\fR\fR -.ad -.RS 20n -The maximum size of a host's name. -.RE - -.sp -.ne 2 -.na -\fB\fBOFS_MAGIC\fR\fR -.ad -.RS 20n -Magic number that is used for the very old format. -.RE - -.sp -.ne 2 -.na -\fB\fBNFS_MAGIC\fR\fR -.ad -.RS 20n -Magic number that is used for the non-MTB format. -.RE - -.sp -.ne 2 -.na -\fB\fBMTB_MAGIC\fR\fR -.ad -.RS 20n -Magic number that is used for the MTB format. -.RE - -.sp -.ne 2 -.na -\fB\fBCHECKSUM\fR\fR -.ad -.RS 20n -Header records checksum to this value. -.RE - -.sp -.LP -The \fBTS_\fR entries are used in the \fBc_type\fR field to indicate what sort -of header this is. The types and their meanings are as follows: -.sp -.ne 2 -.na -\fB\fBTS_TAPE\fR\fR -.ad -.RS 12n -Tape volume label. -.RE - -.sp -.ne 2 -.na -\fB\fBTS_INODE\fR\fR -.ad -.RS 12n -A file or directory follows. The \fBc_dinode\fR field is a copy of the disk -inode and contains bits telling what sort of file this is. -.RE - -.sp -.ne 2 -.na -\fB\fBTS_ADDR\fR\fR -.ad -.RS 12n -A subrecord of a file description. See \fBs_addrs\fR below. -.RE - -.sp -.ne 2 -.na -\fB\fBTS_BITS\fR\fR -.ad -.RS 12n -A bit map follows. This bit map has a one bit for each inode that was dumped. -.RE - -.sp -.ne 2 -.na -\fB\fBTS_CLRI\fR\fR -.ad -.RS 12n -A bit map follows. This bit map contains a zero bit for all inodes that were -empty on the file system when dumped. -.RE - -.sp -.ne 2 -.na -\fB\fBTS_END\fR\fR -.ad -.RS 12n -End of tape record. -.RE - -.sp -.ne 2 -.na -\fB\fBTS_EOM\fR\fR -.ad -.RS 12n -diskette \fBEOM\fRindicates that the restore is compatible with old dump -.RE - -.sp -.LP -The flags are described as follows: -.sp -.ne 2 -.na -\fB\fBDR_NEWHEADER\fR\fR -.ad -.RS 17n -New format tape header. -.RE - -.sp -.ne 2 -.na -\fB\fBDR_INFODEINFO\fR\fR -.ad -.RS 17n -Header contains starting inode info. -.RE - -.sp -.ne 2 -.na -\fB\fBDR_REDUMP\fR\fR -.ad -.RS 17n -Dump contains recopies of active files. -.RE - -.sp -.ne 2 -.na -\fB\fBDR_TRUEINC\fR\fR -.ad -.RS 17n -Dump is a "true incremental". -.RE - -.sp -.ne 2 -.na -\fB\fBDR_HASMETA\fR\fR -.ad -.RS 17n -The metadata in this header. -.RE - -.sp -.ne 2 -.na -\fB\fBDUMPOUTFMT\fR\fR -.ad -.RS 17n -Name, incon, and ctime (date) for printf. -.RE - -.sp -.ne 2 -.na -\fB\fBDUMPINFMT\fR\fR -.ad -.RS 17n -Inverse for scanf. -.RE - -.sp -.LP -The fields of the header structure are as follows: -.sp -.ne 2 -.na -\fB\fBs_addrs\fR\fR -.ad -.RS 17n -An array of bytes describing the blocks of the dumped file. A byte is zero if -the block associated with that byte was not present on the file system; -otherwise, the byte is non-zero. If the block was not present on the file -lsystem, no block was dumped; the block will be stored as a hole in the file. -If there is not sufficient space in this record to describe all the blocks in -a file, \fBTS_ADDR\fR records will be scattered through the file, each one -picking up where the last left off -.RE - -.sp -.ne 2 -.na -\fB\fBs_inos\fR\fR -.ad -.RS 17n -The starting inodes on tape. -.RE - -.sp -.ne 2 -.na -\fB\fBc_type\fR\fR -.ad -.RS 17n -The type of the record. -.RE - -.sp -.ne 2 -.na -\fB\fBc_date\fR\fR -.ad -.RS 17n -The date of the previous dump. -.RE - -.sp -.ne 2 -.na -\fB\fBc_ddate\fR\fR -.ad -.RS 17n -The date of this dump. -.RE - -.sp -.ne 2 -.na -\fB\fBc_volume\fR\fR -.ad -.RS 17n -The current volume number of the dump. -.RE - -.sp -.ne 2 -.na -\fB\fBc_tapea\fR\fR -.ad -.RS 17n -The logical block of this record. -.RE - -.sp -.ne 2 -.na -\fB\fBc_inumber\fR\fR -.ad -.RS 17n -The number of the inode being dumped if this is of type \fBTS_INODE\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBc_magic\fR\fR -.ad -.RS 17n -This contains the value \fBMAGIC\fR above, truncated as needed. -.RE - -.sp -.ne 2 -.na -\fB\fBc_checksum\fR\fR -.ad -.RS 17n -This contains whatever value is needed to make the record sum to -\fBCHECKSUM\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBc_dinode\fR\fR -.ad -.RS 17n -This is a copy of the inode as it appears on the file system. -.RE - -.sp -.ne 2 -.na -\fB\fBc_count\fR\fR -.ad -.RS 17n -The count of bytes in \fBs_addrs\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBu_data c_data\fR\fR -.ad -.RS 17n -The union of either \fBu_data c_data\fR The union of either \fBs_addrs\fR or -\fBs_inos\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBc_label\fR\fR -.ad -.RS 17n -Label for this dump. -.RE - -.sp -.ne 2 -.na -\fB\fBc_level\fR\fR -.ad -.RS 17n -Level of this dump. -.RE - -.sp -.ne 2 -.na -\fB\fBc_filesys\fR\fR -.ad -.RS 17n -Name of dumped file system. -.RE - -.sp -.ne 2 -.na -\fB\fBc_dev\fR\fR -.ad -.RS 17n -Name of dumped service. -.RE - -.sp -.ne 2 -.na -\fB\fBc_host\fR\fR -.ad -.RS 17n -Name of dumped host. -.RE - -.sp -.ne 2 -.na -\fB\fBc_flags\fR\fR -.ad -.RS 17n -Additional information. -.RE - -.sp -.ne 2 -.na -\fB\fBc_firstrec\fR\fR -.ad -.RS 17n -First record on volume. -.RE - -.sp -.ne 2 -.na -\fB\fBc_spare\fR\fR -.ad -.RS 17n -Reserved for future uses. -.RE - -.sp -.ne 2 -.na -\fB\fBc_tpbsize\fR\fR -.ad -.RS 17n -Tape block size for MTB format only. -.RE - -.sp -.LP -Each volume except the last ends with a tapemark (read as an end of file). The -last volume ends with a \fBTS_END\fR record and then the tapemark. -.sp -.LP -The dump history is kept in the file \fB/etc/dumpdates\fR. It is an \fBASCII\fR -file with three fields separated by white space: -.RS +4 -.TP -.ie t \(bu -.el o -The name of the device on which the dumped file system resides. -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The level number of the dump tape; see \fBufsdump\fR(1M). -.RE -.RS +4 -.TP -.ie t \(bu -.el o -The date of the incremental dump in the format generated by \fBctime\fR(3C). -.RE -.sp -.LP -\fBDUMPOUTFMT\fR is the format to use when using \fBprintf\fR(3C) to write an -entry to \fB/etc/dumpdates\fR; \fBDUMPINFMT\fR is the format to use when using -\fBscanf\fR(3C) to read an entry from \fB/etc/dumpdates\fR. -.SH ATTRIBUTES -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Stability Level Unstable -.TE - -.SH SEE ALSO -\fBufsdump\fR(1M), \fBufsrestore\fR(1M), \fBctime\fR(3C), \fBprintf\fR(3C), -\fBscanf\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), diff --git a/usr/src/man/man4/updaters.4 b/usr/src/man/man4/updaters.4 deleted file mode 100644 index 1efaf5c3fa..0000000000 --- a/usr/src/man/man4/updaters.4 +++ /dev/null @@ -1,114 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. All Rights Reserved -.\" 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 UPDATERS 4 "Oct 24, 1996" -.SH NAME -updaters \- configuration file for NIS updating -.SH SYNOPSIS -.LP -.nf -\fB/var/yp/updaters\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The file \fB/var/yp/updaters\fR is a makefile (see \fBmake\fR(1S)) which is -used for updating the Network Information Service (NIS) databases. Databases -can only be updated in a secure network, that is, one that has a -\fBpublickey\fR(4) database. Each entry in the file is a make target for a -particular \fBNIS\fR database. For example, if there is an \fBNIS\fR database -named \fBpasswd.byname\fR that can be updated, there should be a \fBmake\fR -target named \fBpasswd.byname\fR in the \fBupdaters\fR file with the command to -update the file. -.sp -.LP -The information necessary to make the update is passed to the update command -through standard input. The information passed is described below (all items -are followed by a \fBNEWLINE\fR except for 4 and 6): -.sp -.ne 2 -.na -\fB\fB1.\fR\fR -.ad -.RS 6n -Network name of client wishing to make the update (a string). -.RE - -.sp -.ne 2 -.na -\fB\fB2.\fR\fR -.ad -.RS 6n -Kind of update (an integer). -.RE - -.sp -.ne 2 -.na -\fB\fB3.\fR\fR -.ad -.RS 6n -Number of bytes in key (an integer). -.RE - -.sp -.ne 2 -.na -\fB\fB4.\fR\fR -.ad -.RS 6n -Actual bytes of key. -.RE - -.sp -.ne 2 -.na -\fB\fB5.\fR\fR -.ad -.RS 6n -Number of bytes in data (an integer). -.RE - -.sp -.ne 2 -.na -\fB\fB6.\fR\fR -.ad -.RS 6n -Actual bytes of data. -.RE - -.sp -.LP -After receiving this information through standard input, the command to update -the particular database determines whether the user is allowed to make the -change. If not, it exits with the status \fBYPERR_ACCESS.\fR If the user is -allowed to make the change, the command makes the change and exits with a -status of zero. If there are any errors that may prevent the \fBupdaters\fR -from making the change, it should exit with the status that matches a valid -\fBNIS\fR error code described in \fB<rpcsvc/ypclnt.h>\fR\&. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/var/yp/updaters\fR\fR -.ad -.RS 20n -The makefile used for updating the \fBNIS\fR databases. -.RE - -.SH SEE ALSO -.sp -.LP -\fBmake\fR(1S), \fBrpc.ypupdated\fR(1M), \fBpublickey\fR(4) -.SH NOTES -.sp -.LP -The Network Information Service (NIS) was formerly known as Sun Yellow Pages -(YP). The functionality of the two remains the same; only the name has -changed. The name Yellow Pages is a registered trademark in the United Kingdom -of British Telecommunications plc, and may not be used without permission. diff --git a/usr/src/man/man4/user_attr.4 b/usr/src/man/man4/user_attr.4 deleted file mode 100644 index ab19073461..0000000000 --- a/usr/src/man/man4/user_attr.4 +++ /dev/null @@ -1,351 +0,0 @@ -'\" te -.\" Copyright 2020 OmniOS Community Edition (OmniOSce) Association. -.\" Copyright (C) 2008 Sun Microsystems, Inc. All Rights Reserved -.\" 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 USER_ATTR 4 "Oct 1, 2020" -.SH NAME -user_attr \- extended user attributes database -.SH SYNOPSIS -.nf -\fB/etc/user_attr\fR -.fi - -.SH DESCRIPTION -\fB/etc/user_attr\fR is a local source of extended attributes associated with -users and roles. \fBuser_attr\fR can be used with other user attribute sources, -including the LDAP people container and the \fBuser_attr\fR \fBNIS\fR map. -Programs use the \fBgetuserattr\fR(3SECDB) -routines to gain access to this information. -.sp -.LP -The search order for multiple \fBuser_attr\fR sources is specified in the -\fB/etc/nsswitch.conf\fR file, as described in the \fBnsswitch.conf\fR(4) man -page. The search order follows that for \fBpasswd\fR(4). -.sp -.LP -Each entry in the \fBuser_attr\fR databases consists of a single line with five -fields separated by colons (\fB:\fR). Line continuations using the backslash -(\fB\e\fR) character are permitted. Each entry has the form: -.sp -.in +2 -.nf -\fIuser\fR:\fIqualifier\fR:\fIres1\fR:\fIres2\fR:\fIattr\fR -.fi -.in -2 - -.sp -.ne 2 -.na -\fB\fIuser\fR\fR -.ad -.sp .6 -.RS 4n -The name of the user as specified in the \fBpasswd\fR(4) database. -.RE - -.sp -.ne 2 -.na -\fB\fIqualifier\fR\fR -.ad -.sp .6 -.RS 4n -Reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIres1\fR\fR -.ad -.sp .6 -.RS 4n -Reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIres2\fR\fR -.ad -.sp .6 -.RS 4n -Reserved for future use. -.RE - -.sp -.ne 2 -.na -\fB\fIattr\fR\fR -.ad -.sp .6 -.RS 4n -An optional list of semicolon-separated (\fB;\fR) key-value pairs that describe -the security attributes to apply to the object upon execution. Zero or more -keys may be specified. The following keys are currently interpreted by the -system: -.sp -.ne 2 -.na -\fBauths\fR -.ad -.sp .6 -.RS 4n -Specifies a comma-separated list of authorization names chosen from those names -defined in the \fBauth_attr\fR(4) database. Authorization names may be -specified using the asterisk (\fB*\fR) character as a wildcard. For example, -\fBsolaris.printer.*\fR means all of Sun's printer authorizations. -.RE - -.sp -.ne 2 -.na -\fBprofiles\fR -.ad -.sp .6 -.RS 4n -Contains an ordered, comma-separated list of profile names chosen from -\fBprof_attr\fR(4). Profiles are enforced by the profile shells, \fBpfcsh\fR, -\fBpfksh\fR, and \fBpfsh\fR. See \fBpfsh\fR(1). A default profile is assigned -in \fB/etc/security/policy.conf\fR (see \fBpolicy.conf\fR(4)). If no profiles -are assigned, the profile shells do not allow the user to execute any commands. -.RE - -.sp -.ne 2 -.na -\fBroleauth\fR -.ad -.sp .6 -.RS 4n -Specifies whether a user assuming a role is required to use the role password -or their own password. -If the \fBroleauth\fR key value is not specified, the role password is required -for users assuming the role. -.RE - -.sp -.ne 2 -.na -\fBroles\fR -.ad -.sp .6 -.RS 4n -Can be assigned a comma-separated list of role names from the set of user -accounts in this database whose \fBtype\fR field indicates the account is a -role. If the \fBroles\fR key value is not specified, the user is not permitted -to assume any role. -.RE - -.sp -.ne 2 -.na -\fBtype\fR -.ad -.sp .6 -.RS 4n -Can be assigned one of these strings: \fBnormal\fR, indicating that this -account is for a normal user, one who logs in; or \fBrole\fR, indicating that -this account is for a role. Roles can only be assumed by a normal user after -the user has logged in. -.RE - -.sp -.ne 2 -.na -\fBproject\fR -.ad -.sp .6 -.RS 4n -Can be assigned a name of one project from the \fBproject\fR(4) database to be -used as a default project to place the user in at login time. For more -information, see \fBgetdefaultproj\fR(3PROJECT). -.RE - -.sp -.ne 2 -.na -\fBdefaultpriv\fR -.ad -.sp .6 -.RS 4n -The default set of privileges assigned to a user's inheritable set upon login. -See "Privileges Keywords," below. -.RE - -.sp -.ne 2 -.na -\fBlimitpriv\fR -.ad -.sp .6 -.RS 4n -The maximum set of privileges a user or any process started by the user, -whether through \fBsu\fR(1M) or any other means, can obtain. The system -administrator must take extreme care when removing privileges from the limit -set. Removing any basic privilege has the ability of crippling all -applications; removing any other privilege can cause many or all applications -requiring privileges to malfunction. See "Privileges Keywords," below. -.RE - -.sp -.ne 2 -.na -\fBlock_after_retries\fR -.ad -.sp .6 -.RS 4n -Specifies whether an account is locked after the count of failed logins for a -user equals or exceeds the allowed number of retries as defined by -\fBRETRIES\fR in \fB/etc/default/login\fR. Possible values are \fByes\fR or -\fBno\fR. The default is \fBno\fR. Account locking is applicable only to local -accounts. -.RE - -The following keys are available only if the system is configured with the -Trusted Extensions feature: -.sp -.ne 2 -.na -\fBclearance\fR -.ad -.sp .6 -.RS 4n -Contains the maximum label at which the user can operate. If unspecified, in -the Defense Intelligence Agency (\fBDIA\fR) encodings scheme, the default is -specified in \fBlabel_encodings\fR(4) (see \fBlabel_encodings\fR(4) and -\fBlabels\fR(5) in the \fISolaris Trusted Extensions Reference Manual\fR). -.RE - -.sp -.ne 2 -.na -\fBmin_label\fR -.ad -.sp .6 -.RS 4n -Contains the minimum label at which the user can log in. If unspecified, in the -\fBDIA\fR encodings scheme, the default is specified in -\fBlabel_encodings\fR(4) (see \fBlabel_encodings\fR(4) and \fBlabels\fR(5) in -the \fISolaris Trusted Extensions Reference Manual\fR). -.RE - -.RE - -.sp -.LP -Except for the \fBtype\fR key, the \fB\fIkey\fR=\fIvalue\fR\fR fields in -\fB/etc/user_attr\fR can be added using \fBroleadd\fR(1M) and -\fBuseradd\fR(1M). You can use \fBrolemod\fR(1M) and \fBusermod\fR(1M) to -modify \fB\fIkey\fR=\fIvalue\fR\fR fields in \fB/etc/user_attr\fR. Modification -of the \fBtype\fR key is restricted as described in \fBrolemod\fR and -\fBusermod\fR. -.SS "Privileges Keywords" -The \fBdefaultpriv\fR and \fBlimitpriv\fR are the privileges-related keywords -and are described above. -.sp -.LP -See \fBprivileges\fR(5) for a description of privileges. The command -\fBppriv\fR \fB-l\fR (see \fBppriv\fR(1)) produces a list of all supported -privileges. Note that you specify privileges as they are displayed by -\fBppriv\fR. In \fBprivileges\fR(5), privileges are listed in the form -\fBPRIV_\fR\fI<privilege_name>\fR\&. For example, the privilege -\fBfile_chown\fR, as you would specify it in \fBuser_attr\fR, is listed in -\fBprivileges\fR(5) as \fBPRIV_FILE_CHOWN\fR. -.sp -.LP -See \fBusermod\fR(1M) for examples of commands that -modify privileges and their subsequent effect on \fBuser_attr\fR. -.SH EXAMPLES -\fBExample 1 \fRAssigning a Profile to Root -.sp -.LP -The following example entry assigns to root the \fBAll\fR profile, which allows -root to use all commands in the system, and also assigns two authorizations: - -.sp -.in +2 -.nf -root::::auths=solaris.*,solaris.grant;profiles=All;type=normal -.fi -.in -2 - -.sp -.LP -The \fBsolaris.*\fR wildcard authorization shown above gives root all the -\fBsolaris\fR authorizations; and the \fBsolaris.grant\fR authorization gives -root the right to grant to others any \fBsolaris\fR authorizations that root -has. The combination of authorizations enables root to grant to others all the -\fBsolaris\fR authorizations. See \fBauth_attr\fR(4) for more about -authorizations. - -.SH FILES -.ne 2 -.na -\fB/etc/nsswitch.conf\fR -.ad -.sp .6 -.RS 4n -See \fBnsswitch.conf\fR(4). -.RE - -.sp -.ne 2 -.na -\fB/etc/user_attr\fR -.ad -.sp .6 -.RS 4n -Described here. -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Availibility SUNWcsr -_ -Interface Stability See below -.TE - -.sp -.LP -The command-line syntax is Committed. The output is Uncommitted. -.SH SEE ALSO -\fBauths\fR(1), \fBpfcsh\fR(1), \fBpfksh\fR(1), \fBpfsh\fR(1), \fBppriv\fR(1), -\fBprofiles\fR(1), \fBroles\fR(1), \fBroleadd\fR(1M), \fBrolemod\fR(1M), -\fBuseradd\fR(1M), \fBusermod\fR(1M), \fBgetdefaultproj\fR(3PROJECT), -\fBgetuserattr\fR(3SECDB), \fBauth_attr\fR(4), \fBexec_attr\fR(4), -\fBnsswitch.conf\fR(4), \fBpasswd\fR(4), \fBpolicy.conf\fR(4), -\fBprof_attr\fR(4), \fBproject\fR(4), \fBattributes\fR(5), \fBprivileges\fR(5) -.sp -.LP -\fISystem Administration Guide: Security Services\fR -.SH NOTES -The root user is usually defined in local databases for a number of reasons, -including the fact that root needs to be able to log in and do system -maintenance in single-user mode, before the network name service databases are -available. For this reason, an entry should exist for root in the local -\fBuser_attr\fR file, and the precedence shown in the example -\fBnsswitch.conf\fR(4) file entry under EXAMPLES is highly recommended. -.sp -.LP -Because the list of legal keys is likely to expand, any code that parses this -database must be written to ignore unknown key-value pairs without error. When -any new keywords are created, the names should be prefixed with a unique -string, such as the company's stock symbol, to avoid potential naming -conflicts. -.sp -.LP -In the \fBattr\fR field, escape the following symbols with a backslash -(\fB\e\fR) if you use them in any value: colon (\fB:\fR), semicolon (\fB;\fR), -carriage return (\fB\en\fR), equals (\fB=\fR), or backslash (\fB\e\fR). diff --git a/usr/src/man/man4/utmp.4 b/usr/src/man/man4/utmp.4 deleted file mode 100644 index 4b65cb10bf..0000000000 --- a/usr/src/man/man4/utmp.4 +++ /dev/null @@ -1,34 +0,0 @@ -'\" te -.\" Copyright 1989 AT&T Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved -.\" 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 UTMP 4 "Feb 22, 1999" -.SH NAME -utmp, wtmp \- utmp and wtmp database entry formats -.SH SYNOPSIS -.LP -.nf -\fB#include <utmp.h>\fR -\fB/var/adm/utmp\fR -\fB/var/adm/wtmp\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fButmp\fR and \fBwtmp\fR database files are obsolete and are no longer -present on the system. They have been superseded by the extended database -contained in the \fButmpx\fR and \fBwtmpx\fR database files. See -\fButmpx\fR(4). -.sp -.LP -It is possible for \fB/var/adm/utmp\fR to reappear on the system. This would -most likely occur if a third party application that still uses \fButmp\fR -recreates the file if it finds it missing. This file should not be allowed to -remain on the system. The user should investigate to determine which -application is recreating this file. -.SH SEE ALSO -.sp -.LP -\fButmpx\fR(4) diff --git a/usr/src/man/man4/utmpx.4 b/usr/src/man/man4/utmpx.4 deleted file mode 100644 index 7bcd3c6ad9..0000000000 --- a/usr/src/man/man4/utmpx.4 +++ /dev/null @@ -1,54 +0,0 @@ -'\" te -.\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright 1989 AT&T -.\" 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 UTMPX 4 "April 9, 2016" -.SH NAME -utmpx, wtmpx \- utmpx and wtmpx database entry formats -.SH SYNOPSIS -.LP -.nf -\fB#include <utmpx.h>\fR -\fB/var/adm/utmpx\fR -\fB/var/adm/wtmpx\fR -.fi - -.SH DESCRIPTION -.LP -The \fButmpx\fR and \fBwtmpx\fR files are extended database files that have -superseded the obsolete \fButmp\fR and \fBwtmp\fR database files. -.sp -.LP -The \fButmpx\fR database contains user access and accounting information for -commands such as \fBwho\fR(1), \fBwrite\fR(1), and \fBlogin\fR(1). The -\fBwtmpx\fR database contains the history of user access and accounting -information for the \fButmpx\fR database. -.SH USAGE -.LP -Applications should not access these databases directly, but should use the -functions described on the \fBgetutxent\fR(3C) manual page to interact with the -\fButmpx\fR and \fBwtmpx\fR databases to ensure that they are maintained -consistently. -.SH FILES -.ne 2 -.na -\fB\fB/var/adm/utmpx\fR\fR -.ad -.RS 18n -user access and administration information -.RE - -.sp -.ne 2 -.na -\fB\fB/var/adm/wtmpx\fR\fR -.ad -.RS 18n -history of user access and administrative information -.RE - -.SH SEE ALSO -.LP -\fBgetutxent\fR(3C), \fBwait\fR(3C), \fBwait.h\fR(3HEAD) diff --git a/usr/src/man/man4/vfstab.4 b/usr/src/man/man4/vfstab.4 deleted file mode 100644 index 5b6a815784..0000000000 --- a/usr/src/man/man4/vfstab.4 +++ /dev/null @@ -1,196 +0,0 @@ -'\" -.\" Copyright (c) 2001 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" Copyright 2015 Nexenta Systems, Inc. All rights reserved. -.\" Copyright 2022 Oxide Computer Company -.\" -.\" 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] -.\" -.Dd January 16, 2022 -.Dt VFSTAB 4 -.Os -.Sh NAME -.Nm vfstab -.Nd table of file system defaults -.Sh DESCRIPTION -The file -.Pa /etc/vfstab -describes defaults for each file system. -The information is stored in a table with the following column headings: -.Bd -literal -device device mount FS fsck mount mount -to mount to fsck point type pass at boot options -.Ed -.Pp -The fields in the table are space-separated and show the resource name -.Pq Fa device to mount , -the raw device to -.Sy fsck -.Pq Em device to fsck , -the default mount directory -.Pq Em mount point , -the name of the file system type -.Pq Em FS type , -the number used by -.Xr fsck 1M -to decide whether to check the file system automatically -.Pq Em fsck pass , -whether the file system should be mounted automatically by -.Xr mountall 1M -.Pq Em mount at boot , -and the file system mount options -.Pq Em mount options . -See respective mount file system man page below in -.Sx SEE ALSO -for -.Em mount options. -A -.Sq - -is used to indicate no entry in a field. -This may be used when a field does not apply to the resource being mounted. -.Pp -The -.Xr getvfsent 3C -family of routines is used to read -.Pa /etc/vfstab . -There are currently no library routines to automate the writing of -.Pa /etc/vfstab . -.Pp -.Pa /etc/vfstab -can be used to specify swap areas. -An entry so specified, -.Pq which can be a file or a device , -will automatically be added as a swap area by the -.Pa /sbin/swapadd -script when the system boots. -To specify a swap area, the -.Em device-to-mount -field contains the name of the swap file or device, the -.Em FS-type -is -.Dq swap , -.Em mount-at-boot -is -.Dq no -and all other fields have no entry. -.Sh EXAMPLES -The following are -.Pa /etc/vfstab -entries for various file system types supported in illumos. -.Pp -.Sy Example 1 -NFS and UFS Mounts -.Pp -The following entry invokes NFS to automatically mount the directory -.Pa /usr/local -of the server -.Sy example1 -on the client's -.Pa /usr/local -directory with read-only permission: -.Bd -literal -offset indent -example1:/usr/local - /usr/local nfs - yes ro -.Ed -.Pp -The following example assumes a small departmental mail setup, in which clients -mount -.Pa /var/mail -from a server -.Sy mailsvr . -The following entry would be listed in each client's -.Pa /etc/vfstab: -.Bd -literal -offset indent -mailsvr:/var/mail - /var/mail nfs - yes intr,bg -.Ed -.Pp -The following is an example for a UFS file system in which logging is enabled: -.Bd -literal -offset indent -/dev/dsk/c2t10d0s0 /dev/rdsk/c2t10d0s0 /export/local ufs 3 yes logging -.Ed -.Pp -See -.Xr mount_nfs 1M -for a description of NFS mount options and -.Xr mount_ufs 1M -for a description of UFS options. -.Pp -.Sy Example 2 -pcfs Mounts -.Pp -The following example mounts a pcfs file system on a fixed hard disk on an x86 -machine: -.Bd -literal -offset indent -/dev/dsk/c1t2d0p0:c - /win98 pcfs - yes - -.Ed -.Pp -The example below mounts a Jaz drive on a SPARC machine. -Normally, the volume management software handles mounting of removable media, -obviating a -.Nm -entry. -Specifying a device that supports removable media in -.Pa /etc/vfstab -with set the mount-at-boot field to -.Dq no -.Pq as shown below -disables the automatic handling of that device. -Such an entry presumes you are not running volume management software. -.Bd -literal -offset indent -/dev/dsk/c1t2d0s2:c - /jaz pcfs - no - -.Ed -.Pp -For removable media on a SPARC machine, the convention for the slice portion of -the disk identifier is to specify -.Sy s2 , -which stands for the entire medium. -.Pp -For pcfs file systems on x86 machines, note that the disk identifier uses -a -.Sy p -.Pq Sy p0 -and a logical drive -.Po -.Sy c , -in the -.Pa /win98 -example above -.Pc -for a pcfs logical drive. -See -.Xr mount_pcfs 1M -for syntax for pcfs logical drives and for pcfs-specific mount options. -.Pp -.Sy Example 3 -loopback File System Mount -.Pp -The following is an example of mounting a loopback -.Pq lofs -file system: -.Bd -literal -/export/test - /opt/test lofs - yes - -.Ed -See -.Xr lofs 7FS -for an overview of the loopback file system. -.Sh SEE ALSO -.Xr fsck 1M , -.Xr mount 1M , -.Xr mount_hsfs 1M , -.Xr mount_nfs 1M , -.Xr mount_tmpfs 1M , -.Xr mount_ufs 1M , -.Xr swap 1M , -.Xr getvfsent 3C diff --git a/usr/src/man/man4/warn.conf.4 b/usr/src/man/man4/warn.conf.4 deleted file mode 100644 index 62f5b7bab0..0000000000 --- a/usr/src/man/man4/warn.conf.4 +++ /dev/null @@ -1,233 +0,0 @@ -'\" te -.\" Copyright 1987, 1989 by the Student Information Processing Board of the Massachusetts Institute of Technology. For copying and distribution information, please see the file kerberosv5/mit-sipb-copyright.h. -.\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved -.\" 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 WARN.CONF 4 "November 22, 2021" -.SH NAME -warn.conf \- Kerberos warning configuration file -.SH SYNOPSIS -.nf -/etc/krb5/warn.conf -.fi - -.SH DESCRIPTION -The \fBwarn.conf\fR file contains configuration information specifying how -users will be warned by the \fBktkt_warnd\fR daemon about ticket expiration. In -addition, this file can be used to auto-renew the user's Ticket-Granting Ticket -(TGT) instead of warning the user. Credential expiration warnings and -auto-renew results are sent, by means of syslog, to \fBauth.notice\fR. -.sp -.LP -Each Kerberos client host must have a \fBwarn.conf\fR file in order for users -on that host to get Kerberos warnings from the client. Entries in the -\fBwarn.conf\fR file must have the following format: -.sp -.in +2 -.nf -\fIprincipal\fR [renew[:\fIopt1\fR,...\fIoptN\fR]] syslog|terminal \fItime\fR -.fi -.in -2 - -.sp -.LP -or: -.sp -.in +2 -.nf -\fIprincipal\fR [renew[:\fIopt1\fR,...\fIoptN\fR]] mail \fItime\fR [\fIemail address\fR] -.fi -.in -2 - -.sp -.ne 2 -.na -\fB\fIprincipal\fR\fR -.ad -.RS 17n -Specifies the principal name to be warned. The asterisk (\fB*\fR) wildcard can -be used to specify groups of principals. -.RE - -.sp -.ne 2 -.na -\fB\fBrenew\fR\fR -.ad -.RS 17n -Automatically renew the credentials (TGT) until renewable lifetime expires. -This is equivalent to the user running \fBkinit\fR \fB-R\fR. -.sp -The renew options include: -.sp -.ne 2 -.na -\fB\fBlog-success\fR\fR -.ad -.RS 15n -Log the result of the renew attempt on success using the specified method -(\fBsyslog\fR|\fBterminal\fR|\fBmail\fR). -.RE - -.sp -.ne 2 -.na -\fB\fBlog-failure\fR\fR -.ad -.RS 15n -Log the result of the renew attempt on failure using the specified method -(\fBsyslog\fR|\fBterminal\fR|\fBmail\fR). Some renew failure conditions are: -TGT renewable lifetime has expired, the KDCs are unavailable, or the cred cache -file has been removed. -.RE - -.sp -.ne 2 -.na -\fB\fBlog\fR\fR -.ad -.RS 15n -Same as specifying both \fBlog-success\fR and \fBlog-failure\fR. -.RE - -.LP -Note - -.sp -.RS 2 -If no log options are given, no logging is done. -.RE -.RE - -.sp -.ne 2 -.na -\fB\fBsyslog\fR\fR -.ad -.RS 17n -Sends the warnings to the system's syslog. Depending on the -\fB/etc/syslog.conf\fR file, syslog entries are written to the -\fB/var/adm/messages\fR file and/or displayed on the terminal. -.RE - -.sp -.ne 2 -.na -\fB\fBterminal\fR\fR -.ad -.RS 17n -Sends the warnings to display on the terminal. -.RE - -.sp -.ne 2 -.na -\fB\fBmail\fR\fR -.ad -.RS 17n -Sends the warnings as email to the address specified by \fIemail_address\fR. -.RE - -.sp -.ne 2 -.na -\fB\fItime\fR\fR -.ad -.RS 17n -Specifies how much time before the \fBTGT\fR expires when a warning should be -sent. The default time value is seconds, but you can specify \fBh\fR (hours) -and \fBm\fR (minutes) after the number to specify other time values. -.RE - -.sp -.ne 2 -.na -\fB\fIemail_address\fR\fR -.ad -.RS 17n -Specifies the email address at which to send the warnings. This field must be -specified only with the \fBmail\fR field. -.RE - -.SH EXAMPLES -\fBExample 1 \fRSpecifying Warnings -.sp -.LP -The following \fBwarn.conf\fR entry - -.sp -.in +2 -.nf -\fB* syslog 5m\fR -.fi -.in -2 -.sp - -.sp -.LP -specifies that warnings will be sent to the syslog five minutes before the -expiration of the \fBTGT\fR for all principals. The form of the message is: - -.sp -.in +2 -.nf -jdb@EXAMPLE.COM: your kerberos credentials expire in 5 minutes -.fi -.in -2 -.sp - -.LP -\fBExample 2 \fRSpecifying Renewal -.sp -.LP -The following \fBwarn.conf\fR entry: - -.sp -.in +2 -.nf -* renew:log terminal 30m -.fi -.in -2 - -.sp -.LP -\&...specifies that renew results will be sent to the user's terminal 30 -minutes before the expiration of the TGT for all principals. The form of the -message (on renew success) is: - -.sp -.in +2 -.nf -myname@EXAMPLE.COM: your kerberos credentials have been renewed -.fi -.in -2 - -.SH FILES -.ne 2 -.na -\fB\fB/usr/lib/krb5/ktkt_warnd\fR\fR -.ad -.RS 28n -Kerberos warning daemon -.RE - -.SH ATTRIBUTES -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -\fBkinit\fR(1), \fBkdestroy\fR(1), \fBktkt_warnd\fR(1M), \fBsyslog.conf\fR(4), -\fButmpx\fR(4), \fBattributes\fR(5), \fBkerberos\fR(5), \fBpam_krb5\fR(5) -.SH NOTES -The auto-renew of the TGT is attempted only if the user is logged-in, as -determined by examining \fButmpx\fR(4). diff --git a/usr/src/man/man4/ypfiles.4 b/usr/src/man/man4/ypfiles.4 deleted file mode 100644 index 8c23bc14e2..0000000000 --- a/usr/src/man/man4/ypfiles.4 +++ /dev/null @@ -1,154 +0,0 @@ -'\" te -.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 1989 AT&T -.\" 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 YPFILES 4 "Feb 25, 2017" -.SH NAME -ypfiles \- Network Information Service Version 2, formerly known as YP -.SH DESCRIPTION -.LP -The NIS network information service uses a distributed, replicated database of -\fBdbm\fR files , in ASCII form, that are contained in the \fB/var/yp\fR -directory hierarchy on each NIS server. -.sp -.LP -A \fBdbm\fR database served by the NIS server is called a NIS \fImap\fR. A NIS -\fIdomain\fR is a subdirectory of \fB/var/yp\fR that contains a set of NIS maps -on each NIS server. -.sp -.LP -Standard nicknames are defined in the file \fB/var/yp/nicknames\fR. These names -can be used in place of the full map name in the \fBypmatch\fR and \fBypcat\fR -commands. Use the command \fBypwhich\fR \fB-x\fR to display the current set of -nicknames. Use the command \fBypwhich\fR \fB-m\fR to display all the available -maps. Each line of the nickname file contains two fields separated by white -space. The first field is the nickname, and the second field is the name of the -map that it expands to. The nickname cannot contain a ".". -.SS "NIS to LDAP (N2L)" -.LP -If the \fB/var/yp/NISLDAPmapping\fR configuration file is present, the NIS -server operates in NIS to LDAP (N2L) mode. In this mode, NIS maps are stored in -a new set of DBM files, prepended by the \fBLDAP_\fR prefix, at -\fB/var/yp/\fIdomainname\fR\fR. These files are used as a cache backed by -information from an LDAP server. Additional DBM files are created in the same -directory to hold the cache's TTL values. -.sp -.LP -N2L mode enables NIS clients to be supported in an LDAP environment. -.sp -.LP -In N2L mode, the old style DBM files, NIS source files, and the -\fBypmake\fR(1M) utility have to role. They are retained to enable easy -conversion back to the traditional mode, if required. -.SS "Converting from N2L to Traditional NIS" -.LP -When NIS is operating in N2L mode, it uses a new set of NIS maps with an -\fBLDAP_\fR prefix, based on the contents of the LDAP DIT. The NIS source files -are unused and become out of date. If you wish to convert back to the -traditional NIS mode, the N2L configuration file should be deleted. The system -will then return to using the standard map files. Optionally, the N2L mode map -files, \fB/var/yp/*/LDAP_*\fR can also be deleted. -.sp -.LP -If you want to run the system in traditional mode with information based on the -DIT, then the NIS source files must be regenerated based on the N2L maps. To -regenerate the NIS source files based on the N2L maps, run \fBypmap2src\fR(1M). -.SH FILES -.ne 2 -.na -\fB\fB/var/yp\fR\fR -.ad -.sp .6 -.RS 4n -Directory containing NIS configuration files. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/yp/binding\fR\fR -.ad -.sp .6 -.RS 4n -Stores the information required to bind the NIS client to the NIS server. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/yp/binding/\fIypdomain\fR/ypservers\fR\fR -.ad -.sp .6 -.RS 4n -Contains the servers to which the NIS client is allowed to bind. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/yp/Makefile\fR\fR -.ad -.sp .6 -.RS 4n -Builds the NIS \fBndbm\fR databases. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/yp/nicknames\fR\fR -.ad -.sp .6 -.RS 4n -Nicknames file. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/yp/securenets\fR\fR -.ad -.sp .6 -.RS 4n -Defines the hosts and networks that are granted access to information in the -served domain. This file is read at startup time by \fBypserv\fR and -\fBypxfrd\fR. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/yp/\fIypdomain\fR\fR\fR -.ad -.sp .6 -.RS 4n -Directory containing \fBndbm\fR databases. -.RE - -.sp -.ne 2 -.na -\fB\fB/var/yp/NISLDAPmapping\fR\fR -.ad -.sp .6 -.RS 4n -NIS to LDAP configuration file -.RE - -.sp -.ne 2 -.na -\fB\fB/var/yp/*/LDAP_*\fR\fR -.ad -.sp .6 -.RS 4n -NIS to LDAP mode map files -.RE - -.SH SEE ALSO -.LP -\fBldap\fR(1), \fBmakedbm\fR(1M), \fBypbind\fR(1M), \fBypinit\fR(1M), -\fBypmake\fR(1M), \fBypmap2src\fR(1M), \fBypserv\fR(1M), \fBypxfrd\fR(1M), -\fBndbm\fR(3C), \fBypclnt\fR(3NSL) diff --git a/usr/src/man/man4/yppasswdd.4 b/usr/src/man/man4/yppasswdd.4 deleted file mode 100644 index 837c6402af..0000000000 --- a/usr/src/man/man4/yppasswdd.4 +++ /dev/null @@ -1,61 +0,0 @@ -'\" te -.\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved -.\" 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 YPPASSWDD 4 "Nov 8, 2001" -.SH NAME -yppasswdd \- configuration file for rpc.yppasswdd (NIS password daemon) -.SH SYNOPSIS -.LP -.nf -\fB/etc/default/yppasswdd\fR -.fi - -.SH DESCRIPTION -.sp -.LP -The \fByppasswdd\fR file contains a parameter that modifies the behavior of the -\fBrpc.yppasswdd\fR(1M) daemon. -.sp -.LP -The \fByppasswdd\fR file contains a single parameter: -.sp -.in +2 -.nf -#check_restricted_shell_name=1 -.fi -.in -2 -.sp - -.sp -.LP -By default in the current release, this line in \fByppasswdd\fR is commented -out. If you uncomment the line, when a user attempts to change his default -shell using \fB`passwd -r nis -e`\fR (see \fBpasswd\fR(1)), the -\fBrpc.yppasswdd\fR daemon checks whether the name of the user's current shell -begins with an 'r'. \fBrpc.yppasswdd\fR considers any shell whose name begins -with an 'r' (for example, \fBrcsh\fR) to be a restricted shell. If a user's -shell does begin with 'r', his attempt to change from the default shell will -fail. -.sp -.LP -If the line in the \fByppasswdd\fR file is commented out (the default), the -\fBrpc.yppasswdd\fR daemon does not perform the restricted shell check. -.sp -.LP -The \fByppasswdd\fR file is editable only by root or a member of the sys group. -.SH FILES -.sp -.ne 2 -.na -\fB\fB/etc/default/yppasswdd\fR\fR -.ad -.RS 26n -configuration file for \fBrpc.yppasswdd\fR daemon -.RE - -.SH SEE ALSO -.sp -.LP -\fBrpc.yppasswdd\fR(1M) diff --git a/usr/src/man/man4/ypserv.4 b/usr/src/man/man4/ypserv.4 deleted file mode 100644 index 4cec3b4dd8..0000000000 --- a/usr/src/man/man4/ypserv.4 +++ /dev/null @@ -1,714 +0,0 @@ -'\" te -.\" Copyright (C) 2003, Sun Microsystems, Inc. -.\" All Rights Reserved -.\" 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 YPSERV 4 "Feb 25, 2017" -.SH NAME -ypserv \- configuration file for NIS to LDAP transition daemons -.SH SYNOPSIS -.LP -.nf -\fB/etc/default/ypserv\fR -.fi - -.SH DESCRIPTION -.LP -The \fBypserv\fR file specifies configuration information for the -\fBypserv\fR(1M) daemon. Configuration information can come from LDAP or be -specified in the \fBypserv\fR file. -.sp -.LP -You can create a simple \fBypserv\fR file by running \fBinityp2l\fR(1M). The -\fBypserv\fR file can then be customized as required. -.sp -.LP -A related \fBNISLDAPmapping\fR file contains mapping information that converts -NIS entries into LDAP entries. See the \fBNISLDAPmapping\fR(4) man page for an -overview of the setup that is needed to map NIS data to or from LDAP. -.SH EXTENDED DESCRIPTION -.LP -The \fBypserv\fR(1M) server recognizes the attributes that follow. Values -specified for these attributes in the \fBypserv\fR file, including any empty -values, override values that are obtained from LDAP. However, the -\fBnisLDAPconfig*\fR values are read from the \fBypserv\fR file only -.SS "Attributes" -.LP -The following are attributes that are used for initial configuration. -.sp -.ne 2 -.na -\fB\fBnisLDAPconfigDN\fR\fR -.ad -.sp .6 -.RS 4n -The \fBDN\fR for configuration information. If \fBnisLDAPconfigDN\fR is empty, -all other \fBnisLDAPConfig*\fR values are ignored. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPconfigPreferredServerList\fR\fR -.ad -.sp .6 -.RS 4n -The list of servers to use for the configuration phase. There is no default -value. The following is an example of a value for -\fBnisLDAPconfigPreferredServerList\fR: -.sp -.in +2 -.nf -nisLDAPconfigPreferredServerList=127.0.0.1:389 -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPconfigAuthenticationMethod\fR\fR -.ad -.sp .6 -.RS 4n -The authentication method used to obtain the configuration information. The -recognized values for \fBnisLDAPconfigAuthenticationMethod\fR are: -.sp -.ne 2 -.na -\fB\fBnone\fR\fR -.ad -.RS 19n -No authentication attempted -.RE - -.sp -.ne 2 -.na -\fB\fBsimple\fR\fR -.ad -.RS 19n -Password of proxy user sent in the clear to the LDAP server -.RE - -.sp -.ne 2 -.na -\fB\fBsasl/cram-md5\fR\fR -.ad -.RS 19n -Use \fBSASL/CRAM-MD5\fR authentication. This authentication method may not be -supported by all LDAP servers. A password must be supplied. -.RE - -.sp -.ne 2 -.na -\fB\fBsasl/digest-md5\fR\fR -.ad -.RS 19n -Use SASL/DIGEST-MD5 authentication. The \fBSASL/CRAM-MD5\fRauthentication -method may not be supported by all LDAP servers. A password must be supplied. -.RE - -\fBnisLDAPconfigAuthenticationMethod\fR has no default value. The following is -an example of a value for \fBnisLDAPconfigAuthenticationMethod\fR: -.sp -.in +2 -.nf -nisLDAPconfigAuthenticationMethod=simple -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPconfigTLS\fR\fR -.ad -.sp .6 -.RS 4n -The transport layer security used for the connection to the server. The -recognized values are: -.sp -.ne 2 -.na -\fB\fBnone\fR\fR -.ad -.RS 8n -No encryption of transport layer data. The default value is \fBnone\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBssl\fR\fR -.ad -.RS 8n -\fBSSL\fR encryption of transport layer data. A certificate is required. -.RE - -Export and import control restrictions might limit the availability of -transport layer security. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPconfigTLSCertificateDBPath\fR\fR -.ad -.sp .6 -.RS 4n -The name of the directory that contains the certificate database. The default -path is \fB/var/yp\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPconfigProxyUser\fR\fR -.ad -.sp .6 -.RS 4n -The proxy user used to obtain configuration information. -\fBnisLDAPconfigProxyUser\fR has no default value. If the value ends with a -comma, the value of the \fBnisLDAPconfigDN\fR attribute is appended. For -example: -.sp -.in +2 -.nf -nisLDAPconfigProxyUser=cn=nisAdmin,ou=People, -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPconfigProxyPassword\fR\fR -.ad -.sp .6 -.RS 4n -The password that should be supplied to LDAP for the proxy user when the -authentication method requires one. To avoid exposing this password publicly on -the machine, the password should only appear in the configuration file, and the -file should have an appropriate owner, group, and file mode. -\fBnisLDAPconfigProxyPassword\fR has no default value. -.RE - -.sp -.LP -The following are attributes used for data retrieval. The object class name -used for these attributes is \fBnisLDAPconfig\fR. -.sp -.ne 2 -.na -\fB\fBpreferredServerList\fR\fR -.ad -.sp .6 -.RS 4n -The list of servers to use to read or to write mapped NIS data from or to LDAP. -\fBpreferredServerList\fR has no default value. For example: -.sp -.in +2 -.nf -preferredServerList=127.0.0.1:389 -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBauthenticationMethod\fR\fR -.ad -.sp .6 -.RS 4n -The authentication method to use to read or to write mapped NIS data from or to -LDAP. For recognized values, see the \fBLDAPconfigAuthenticationMethod -attribute\fR. \fBauthenticationMethod\fR has no default value. For example: -.sp -.in +2 -.nf -authenticationMethod=simple -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPTLS\fR\fR -.ad -.sp .6 -.RS 4n -The transport layer security to use to read or to write NIS data from or to -LDAP. For recognized values, see the \fBnisLDAPconfigTLS\fR attribute. The -default value is none. Export and import control restrictions might limit the -availability of transport layer security. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPTLSCertificateDBPath\fR\fR -.ad -.sp .6 -.RS 4n -The name of the directory that contains the certificate \fBDB\fR. For -recognized and default values for \fBnisLDAPTLSCertificateDBPath\fR, see the -\fBnisLDAPconfigTLSCertificateDBPath\fR attribute. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPproxyUser\fR\fR -.ad -.sp .6 -.RS 4n -Proxy user used by \fBypserv\fR(1M), \fBypxfrd\fR(1M) and \fByppasswdd\fR(1M) -to read or to write from or to LDAP. Assumed to have the appropriate permission -to read and modify LDAP data. There is no default value. If the value ends in a -comma, the value of the context for the current domain, as defined by a -\fBnisLDAPdomainContext\fR attribute, is appended. See \fBNISLDAPmapping\fR(4). -For example: -.sp -.in +2 -.nf -nisLDAPproxyUser=cn=nisAdmin,ou=People, -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPproxyPassword\fR\fR -.ad -.sp .6 -.RS 4n -The password that should be supplied to LDAP for the proxy user when the -authentication method so requires. To avoid exposing this password publicly on -the machine, the password should only appear in the configuration file, and the -file must have an appropriate owner, group, and file mode. -\fBnisLDAPproxyPassword\fR has no default value. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPsearchTimeout\fR\fR -.ad -.sp .6 -.RS 4n -Establishes the timeout for the LDAP search operation. The default value for -\fBnisLDAPsearchTimeout\fR is 180 seconds. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPbindTimeout\fR\fR -.ad -.br -.na -\fB\fBnisLDAPmodifyTimeout\fR\fR -.ad -.br -.na -\fB\fBnisLDAPaddTimeout\fR\fR -.ad -.br -.na -\fB\fBnisLDAPdeleteTimeout\fR\fR -.ad -.sp .6 -.RS 4n -Establish timeouts for LDAP bind, modify, add, and delete operations, -respectively. The default value is 15 seconds for each attribute. Decimal -values are allowed. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPsearchTimeLimit\fR\fR -.ad -.sp .6 -.RS 4n -Establish a value for the \fBLDAP_OPT_TIMELIMIT\fR option, which suggests a -time limit for the search operation on the LDAP server. The server may impose -its own constraints on possible values. See your LDAP server documentation. The -default is the \fBnisLDAPsearchTimeout\fR value. Only integer values are -allowed. -.sp -Since the \fBnisLDAPsearchTimeout\fR limits the amount of time the client -\fBypserv\fR will wait for completion of a search operation, do not set the -value of \fBnisLDAPsearchTimeLimit\fR larger than the value of -\fBnisLDAPsearchTimeout\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPsearchSizeLimit\fR\fR -.ad -.sp .6 -.RS 4n -Establish a value for the \fBLDAP_OPT_SIZELIMIT\fR option, which suggests a -size limit, in bytes, for the search results on the LDAP server. The server may -impose its own constraints on possible values. See your LDAP server -documentation. The default value for \fBnisLDAPsearchSizeLimit\fR is zero, -which means the size limit is unlimited. Only integer values are allowed. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPfollowReferral\fR\fR -.ad -.sp .6 -.RS 4n -Determines if the \fBypserv\fR should follow referrals or not. Recognized -values for \fBnisLDAPfollowReferral\fR are \fByes\fR and \fBno\fR. The default -value for \fBnisLDAPfollowReferral\fR is \fBno\fR. -.RE - -.sp -.LP -The following attributes specify the action to be taken when some event occurs. -The values are all of the form \fBevent=action\fR. The default action is the -first one listed for each event. -.sp -.ne 2 -.na -\fB\fBnisLDAPretrieveErrorAction\fR\fR -.ad -.sp .6 -.RS 4n -If an error occurs while trying to retrieve an entry from LDAP, one of the -following actions can be selected: -.sp -.ne 2 -.na -\fB\fBuse_cached\fR\fR -.ad -.RS 14n -Retry the retrieval the number of time specified by -\fBnisLDAPretrieveErrorAttempts\fR, with the \fBnisLDAPretrieveErrorTimeout\fR -value controlling the wait between each attempt. -.sp -If all attempts fail, then a warning is logged and the value currently in the -cache is returned to the client. -.RE - -.sp -.ne 2 -.na -\fB\fBfail\fR\fR -.ad -.RS 14n -Proceed as for \fBuse_cached\fR, but if all attempts fail, a \fBYPERR_YPERR\fR -error is returned to the client. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPretrieveErrorAttempts\fR\fR -.ad -.sp .6 -.RS 4n -The number of times a failed retrieval should be retried. The default value for -\fBnisLDAPretrieveErrorAttempts\fR is unlimited. While retries are made the -\fBypserv\fR daemon will be prevented from servicing further -requests .\fBnisLDAPretrieveErrorAttempts\fR values other than \fB1\fR should be used -with caution. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPretrieveErrorTimeout\fR\fR -.ad -.sp .6 -.RS 4n -The timeout in seconds between each new attempt to retrieve LDAP data. The -default value for \fBnisLDAPretrieveErrorTimeout\fR is 15 seconds. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPstoreErrorAction\fR\fR -.ad -.sp .6 -.RS 4n -An error occurred while trying to store data to the LDAP repository. -.sp -.ne 2 -.na -\fB\fBretry\fR\fR -.ad -.RS 9n -Retry operation \fBnisLDAPstoreErrorAttempts\fR times with -\fBnisLDAPstoreErrorTimeout\fR seconds between each attempt. While retries are -made, the NIS daemon will be prevented from servicing further requests. Use -with caution. -.RE - -.sp -.ne 2 -.na -\fB\fBfail\fR\fR -.ad -.RS 9n -Return \fBYPERR_YPERR\fR error to the client. -.RE - -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPstoreErrorAttempts\fR\fR -.ad -.sp .6 -.RS 4n -The number of times a failed attempt to store should be retried. The default -value for \fBnisLDAPstoreErrorAttempts\fR is unlimited. The value for -\fBnisLDAPstoreErrorAttempts\fR is ignored unless -\fBnisLDAPstoreErrorAction=retry\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBnisLDAPstoreErrortimeout\fR\fR -.ad -.sp .6 -.RS 4n -The timeout, in seconds, between each new attempt to store LDAP data. The -default value for \fBnisLDAPstoreErrortimeout\fR is 15 seconds. The -\fBnisLDAPstoreErrortimeout\fR value is ignored unless -\fBnisLDAPstoreErrorAction=retry\fR. -.RE - -.SS "Storing Configuration Attributes in LDAP" -.LP -Most attributes described on this man page, as well as those described on -\fBNISLDAPmapping\fR(4), can be stored in LDAP. In order to do so, you will -need to add the following definitions to your LDAP server, which are described -here in \fBLDIF\fR format suitable for use by \fBldapadd\fR(1). The attribute -and objectclass OIDs are examples only. -.sp -.in +2 -.nf -dn: cn=schema -changetype: modify -add: attributetypes -attributetypes: ( 1.3.6.1.4.1.11.1.3.1.1.2 NAME 'preferredServerList' \e - DESC 'Preferred LDAP server host addresses used by DUA' \e - EQUALITY caseIgnoreMatch \ - SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 SINGLE-VALUE ) -attributetypes: ( 1.3.6.1.4.1.11.1.3.1.1.6 NAME 'authenticationMethod' \e - DESC 'Authentication method used to contact the DSA' \e - EQUALITY caseIgnoreMatch \ - SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 SINGLE-VALUE ) - -dn: cn=schema - changetype: modify - add: attributetypes - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.0 \e - NAME 'nisLDAPTLS' \e - DESC 'Transport Layer Security' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.1 \e - NAME 'nisLDAPTLSCertificateDBPath' \e - DESC 'Certificate file' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.2 \e - NAME 'nisLDAPproxyUser' \e - DESC 'Proxy user for data store/retrieval' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.3 \e - NAME 'nisLDAPproxyPassword' \e - DESC 'Password/key/shared secret for proxy user' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.6 \e - NAME 'nisLDAPretrieveErrorAction' \e - DESC 'Action following an LDAP search error' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.7 \e - NAME 'nisLDAPretrieveErrorAttempts' \e - DESC 'Number of times to retry an LDAP search' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.8 \e - NAME 'nisLDAPretrieveErrorTimeout' \e - DESC 'Timeout between each search attempt' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.9 \e - NAME 'nisLDAPstoreErrorAction' \e - DESC 'Action following an LDAP store error' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.10 \e - NAME 'nisLDAPstoreErrorAttempts' \e - DESC 'Number of times to retry an LDAP store' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.11 \e - NAME 'nisLDAPstoreErrorTimeout' \e - DESC 'Timeout between each store attempt' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.12 \e - NAME 'nisLDAPdomainContext' \e - DESC 'Context for a single domain' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.13 \e - NAME 'nisLDAPyppasswddDomains' \e - DESC 'List of domains for which password changes are made' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 SINGLE-VALUE ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.14 \e - NAME 'nisLDAPdatabaseIdMapping' \e - DESC 'Defines a database id for a NIS object' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.15 \e - NAME 'nisLDAPentryTtl' \e - DESC 'TTL for cached objects derived from LDAP' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.16 \e - NAME 'nisLDAPobjectDN' \e - DESC 'Location in LDAP tree where NIS data is stored' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.17 ) \e - NAME 'nisLDAPnameFields' \e - DESC 'Rules for breaking NIS entries into fields' \\e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.18 ) \e - NAME 'nisLDAPsplitFields' \e - DESC 'Rules for breaking fields into sub fields' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.19 \e - NAME 'nisLDAPattributeFromField' \e - DESC 'Rules for mapping fields to LDAP attributes' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.20 \e - NAME 'nisLDAPfieldFromAttribute' \e - DESC 'Rules for mapping fields to LDAP attributes' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.21 \e - NAME 'nisLDAPrepeatedFieldSeparators' \e - DESC 'Rules for mapping fields to LDAP attributes' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.22 \e - NAME 'nisLDAPcommentChar' \e - DESC 'Rules for mapping fields to LDAP attributes' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - - attributetypes: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.23 \e - NAME 'nisLDAPmapFlags' \e - DESC 'Rules for mapping fields to LDAP attributes' \e - SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 ) - - dn: cn=schema - changetype: modify - add: objectclasses - objectclasses: ( 1.3.6.1.4.1.42.2.27.5.42.43.1.0 NAME 'nisLDAPconfig' \e - DESC 'NIS/LDAP mapping configuration' \e - SUP top STRUCTURAL \e - MAY ( cn $ preferredServerList $ - authenticationMethod $ nisLDAPTLS $ - nisLDAPTLSCertificateDBPath $ - nisLDAPproxyUser $ nisLDAPproxyPassword $ - nisLDAPretrieveErrorAction $ - nisLDAPretrieveErrorAttempts $ - nisLDAPretrieveErrorTimeout $ - nisLDAPstoreErrorAction $ - nisLDAPstoreErrorAttempts $ - nisLDAPstoreErrorTimeout $ - nisLDAPdomainContext $ - nisLDAPyppasswddDomains $ - nisLDAPdatabaseIdMapping $ - nisLDAPentryTtl $ - nisLDAPobjectDN $ - nisLDAPnameFields $ - nisLDAPsplitFields $ - nisLDAPattributeFromField $ - nisLDAPfieldFromAttribute $ - nisLDAPrepeatedFieldSeparators $ - nisLDAPcommentChar $ - nisLDAPmapFlags ) ) -.fi -.in -2 - -.sp -.LP -Create a file containing the following LDIF data. Substitute your actual -\fBnisLDAPconfigDN\fR for \fBconfigDN\fR: -.sp -.in +2 -.nf -dn: configDN -objectClass: top -objectClass: nisLDAPconfig -.fi -.in -2 - -.sp -.LP -Use this file as input to the \fBldapadd\fR(1) command in order to create the -NIS to LDAP configuration entry. Initially, the entry is empty. You can use the -\fBldapmodify\fR(1) command to add configuration attributes. -.SH EXAMPLES -.LP -\fBExample 1 \fRCreating a NIS to LDAP Configuration Entry -.sp -.LP -To set the server list to port 389 on 127.0.0.1, create the following file and -use it as input to \fBldapmodify\fR(1): - -.sp -.in +2 -.nf -dn: configDN -preferredServerList: 127.0.0.1:389 -.fi -.in -2 - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Obsolete -.TE - -.SH SEE ALSO -.LP -\fBldapadd\fR(1), \fBldapmodify\fR(1), \fBinityp2l\fR(1M), \fByppasswdd\fR(1M), -\fBypserv\fR(1M), \fBypxfrd\fR(1M), \fBNISLDAPmapping\fR(4), -\fBattributes\fR(5) -.sp -.LP -\fISystem Administration Guide: Naming and Directory Services (DNS, NIS, and -LDAP)\fR diff --git a/usr/src/man/man4/zoneinfo.4 b/usr/src/man/man4/zoneinfo.4 deleted file mode 100644 index 1685518408..0000000000 --- a/usr/src/man/man4/zoneinfo.4 +++ /dev/null @@ -1,13 +0,0 @@ -'\" te -.\" Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved -.\" 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 ZONEINFO 4 "Jun 21, 1999" -.SH NAME -zoneinfo \- timezone information -.SH DESCRIPTION -.sp -.LP -For notes regarding the zoneinfo timezones, see -\fB/usr/share/lib/zoneinfo/src/README\fR. |