Index: head/lib/libpam/modules/pam_deny/pam_deny.8 =================================================================== --- head/lib/libpam/modules/pam_deny/pam_deny.8 (revision 79657) +++ head/lib/libpam/modules/pam_deny/pam_deny.8 (revision 79658) @@ -1,75 +1,75 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 7, 2001 .Dt PAM_DENY 8 .Os .Sh NAME .Nm pam_deny .Nd Deny PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_deny .Op Ar options .Sh DESCRIPTION The Deny authentication service module for PAM, .Nm provides functionality for all the PAM categories: authentication, account management, session management and password management. In terms of the .Ar module-type parameter, these are the .Dq Li auth , .Dq Li account , .Dq Li session , and .Dq Li password features. .Pp The Deny module will universally deny all requests. It is primarily of use during testing, and to .Dq null-out unwanted functionality. .Pp The following options may be passed to the module: -.Bl -tag -xwidth ".Cm debug" +.Bl -tag -width ".Cm debug" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .El .Sh SEE ALSO .Xr syslog 3 , .Xr pam.conf 5 , .Xr pam 8 Index: head/lib/libpam/modules/pam_ftp/pam_ftp.8 =================================================================== --- head/lib/libpam/modules/pam_ftp/pam_ftp.8 (revision 79657) +++ head/lib/libpam/modules/pam_ftp/pam_ftp.8 (revision 79658) @@ -1,95 +1,95 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 8, 2001 .Dt PAM_FTP 8 .Os .Sh NAME .Nm pam_ftp .Nd FTP PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_ftp .Op Ar options .Sh DESCRIPTION The FTP authentication service module for PAM, .Nm provides functionality for only one PAM category: authentication. In terms of the .Ar module-type parameter, this is the .Dq Li auth feature. It also provides a null function for session management. .Ss FTP Authentication Module The FTP authentication component .Pq Fn pam_sm_authenticate , authenticates the anonymous user (usually .Dq anonymous or .Dq ftp ) usually by simply requesting an email address as a password. The supplied email address is broken up into its username and host parts, and these are assigned to the .Dv PAM_RUSER and .Dv PAM_RHOST facilities respectively. .Pp This module is intended for the .Xr ftpd 8 service. .Pp The following options may be passed to the authentication module: -.Bl -tag -xwidth ".Cm no_anon" +.Bl -tag -width ".Cm no_anon" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .It Cm no_anon Disallow anonymous access. .It Cm ignore Ingnore the password supplied, and do not use its constituent parts (username and hostname) as .Dv PAM_RUSER and .Dv PAM_RHOST respectively. .El .Sh SEE ALSO .Xr ftp 1 , .Xr syslog 3 , .Xr pam.conf 5 , .Xr ftpd 8 , .Xr pam 8 Index: head/lib/libpam/modules/pam_krb5/pam_krb5.8 =================================================================== --- head/lib/libpam/modules/pam_krb5/pam_krb5.8 (revision 79657) +++ head/lib/libpam/modules/pam_krb5/pam_krb5.8 (revision 79658) @@ -1,212 +1,212 @@ .\" .\" $Id: pam_krb5.5,v 1.5 2000/01/05 00:59:56 fcusack Exp $ .\" $FreeBSD$ .Dd January 15, 1999 .Dt PAM_KRB5 8 .Os .Sh NAME .Nm pam_krb5 .Nd Kerberos 5 PAM module .Sh SYNOPSIS .Pa /usr/lib/pam_krb5.so .Sh DESCRIPTION The Kerberos 5 service module for PAM, typically .Pa /usr/lib/pam_krb5.so , provides functionality for three PAM categories: authentication, account management, and password management. It also provides null functions for session management. The .Pa pam_krb5.so module is a shared object that can be dynamically loaded to provide the necessary functionality upon demand. Its path is specified in the PAM configuration file. .Ss Kerberos 5 Authentication Module The Kerberos 5 authentication component provides functions to verify the identity of a user .Pq Fn pam_sm_authenticate and to set user specific credentials .Pq Fn pam_sm_setcred . .Fn pam_sm_authenticate converts the supplied username into a Kerberos principal, by appending the default local realm name. It also supports usernames with explicit realm names. If a realm name is supplied, then upon a sucessful return, it changes the username by mapping the principal name into a local username (calling .Fn krb5_aname_to_localname ) . This typically just means the realm name is stripped. .Pp It prompts the user for a password and obtains a new Kerberos TGT for the principal. The TGT is verified by obtaining a service ticket for the local host. .Pp When prompting for the current password, the authentication module will use the prompt .Dq Li "Password for :" . .Pp The .Fn pam_sm_setcred function stores the newly acquired credentials in a credentials cache, and sets the environment variable .Ev KRB5CCNAME appropriately. The credentials cache should be destroyed by the user at logout with .Xr kdestroy 1 . .Pp The following options may be passed to the authentication module: -.Bl -tag -xwidth ".Cm use_first_pass" +.Bl -tag -width ".Cm use_first_pass" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .It Cm use_first_pass If the authentication module is not the first in the stack, and a previous module obtained the user's password, that password is used to authenticate the user. If this fails, the authentication module returns failure without prompting the user for a password. This option has no effect if the authentication module is the first in the stack, or if no previous modules obtained the user's password. .It Cm try_first_pass This option is similar to the .Cm use_first_pass option, except that if the previously obtained password fails, the user is prompted for another password. .It Cm forwardable Obtain forwardable Kerberos credentials for the user. .It Cm no_ccache Do not save the obtained credentials in a credentials cache. This is a useful option if the authentication module is used for services such as ftp or pop, where the user would not be able to destroy them. [This is not a recommendation to use the module for those services.] .It Cm ccache Ns = Ns Ar name Use .Ar name as the credentials cache. .Ar name must be in the form .Ar type : Ns Ar residual . The special tokens .Ql %u , to designate the decimal UID of the user; and .Ql %p , to designate the current process ID; can be used in .Ar name . .El .Ss Kerberos 5 Account Management Module The Kerberos 5 account management component provides a function to perform account management, .Fn pam_sm_acct_mgmt . The function verifies that the authenticated principal is allowed to login to the local user account by calling .Fn krb5_kuserok (which checks the user's .Pa .k5login file). .Ss Kerberos 5 Password Management Module The Kerberos 5 password management component provides a function to change passwords .Pq Fn pam_sm_chauthtok . The username supplied (the user running the .Xr passwd 1 command, or the username given as an argument) is mapped into a Kerberos principal name, using the same technique as in the authentication module. Note that if a realm name was explicitly supplied during authentication, but not during a password change, the mapping done by the password management module may not result in the same principal as was used for authentication. .Pp Unlike when changing a .Ux password, the password management module will allow any user to change any principal's password (if the user knows the principal's old password, of course). Also unlike .Ux , root is always prompted for the principal's old password. .Pp The password management module uses the same heuristics as .Xr kpasswd 1 to determine how to contact the Kerberos password server. .Pp The following options may be passed to the password management module: -.Bl -tag -xwidth ".Cm use_first_pass" +.Bl -tag -width ".Cm use_first_pass" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .It Cm use_first_pass If the password management module is not the first in the stack, and a previous module obtained the user's old password, that password is used to authenticate the user. If this fails, the password management module returns failure without prompting the user for the old password. If successful, the new password entered to the previous module is also used as the new Kerberos password. If the new password fails, the password management module returns failure without prompting the user for a new password. .It Cm try_first_pass This option is similar to the .Cm use_first_pass option, except that if the previously obtained old or new passwords fail, the user is prompted for them. .El .Ss Kerberos 5 Session Management Module The Kerberos 5 session management component provides functions to initiate .Pq Fn pam_sm_open_session and terminate .Pq Fn pam_sm_close_session sessions. Since session management is not defined under Kerberos 5, both of these functions simply return success. They are provided only because of the naming conventions for PAM modules. .Sh ENVIRONMENT .Bl -tag -width "KRB5CCNAME" .It Ev KRB5CCNAME Location of the credentials cache. .El .Sh FILES -.Bl -tag -xwidth ".Pa /tmp/krb5cc_ Ns Ar uid" -compact +.Bl -tag -width ".Pa /tmp/krb5cc_ Ns Ar uid" -compact .It Pa /tmp/krb5cc_ Ns Ar uid default credentials cache .Ar ( uid is the decimal UID of the user). .It Pa $HOME/.k5login file containing Kerberos principals that are allowed access. .El .Sh SEE ALSO .Xr kdestroy 1 , .Xr passwd 1 , .Xr syslog 3 , .Xr pam.conf 5 , .Xr pam 8 .Sh NOTES Applications should not call .Fn pam_authenticate more than once between calls to .Fn pam_start and .Fn pam_end when using the Kerberos 5 PAM module. Index: head/lib/libpam/modules/pam_nologin/pam_nologin.8 =================================================================== --- head/lib/libpam/modules/pam_nologin/pam_nologin.8 (revision 79657) +++ head/lib/libpam/modules/pam_nologin/pam_nologin.8 (revision 79658) @@ -1,77 +1,77 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 8, 2001 .Dt PAM_NOLOGIN 8 .Os .Sh NAME .Nm pam_nologin .Nd NoLogin PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_nologin .Op Ar options .Sh DESCRIPTION The NoLogin authentication service module for PAM, .Nm provides functionality for only one PAM category: authentication. In terms of the .Ar module-type parameter, this is the .Dq Li auth feature. It also provides a null function for session management. .Ss NoLogin Authentication Module The NoLogin authentication component .Pq Fn pam_sm_authenticate , always returns success for the superuser, and returns success for all other users if the file .Pa /var/run/nologin does not exist. If .Pa /var/run/nologin does exist, then its contents are echoed to non-superusers before failure is returned. .Pp The following options may be passed to the authentication module: -.Bl -tag -xwidth ".Cm debug" +.Bl -tag -width ".Cm debug" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .El .Sh SEE ALSO .Xr syslog 3 , .Xr nologin 5 , .Xr pam.conf 5 , .Xr pam 8 Index: head/lib/libpam/modules/pam_opie/pam_opie.8 =================================================================== --- head/lib/libpam/modules/pam_opie/pam_opie.8 (revision 79657) +++ head/lib/libpam/modules/pam_opie/pam_opie.8 (revision 79658) @@ -1,91 +1,91 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 7, 2001 .Dt PAM_OPIE 8 .Os .Sh NAME .Nm pam_opie .Nd OPIE PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_opie .Op Ar options .Sh DESCRIPTION The OPIE authentication service module for PAM, .Nm provides functionality for only one PAM category: that of authentication. In terms of the .Ar module-type parameter, this is the .Dq Li auth feature. It also provides a null function for session management. .Ss OPIE Authentication Module The OPIE authentication component provides functions to verify the identity of a user .Pq Fn pam_sm_authenticate , which obtains the relevant .Xr opie 4 credentials. It provides the user with an OPIE challenge, and verifies that this is correct with .Xr opiechallenge 3 . .Pp The following options may be passed to the authentication module: -.Bl -tag -xwidth ".Cm auth_as_self" +.Bl -tag -width ".Cm auth_as_self" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .It Cm auth_as_self This option will require the user to authenticate themself as the user given by .Xr getuid 2 , not as the account they are attempting to access. This is primarily for services like .Xr su 1 , where the user's ability to retype their own password might be deemed sufficient. .El .Sh FILES -.Bl -tag -xwidth ".Pa /etc/opiekeys" -compact +.Bl -tag -width ".Pa /etc/opiekeys" -compact .It Pa /etc/opiekeys default OPIE password database. .El .Sh SEE ALSO .Xr passwd 1 , .Xr opiechallenge 3 , .Xr syslog 3 , .Xr opie 4 , .Xr pam.conf 5 , .Xr pam 8 Index: head/lib/libpam/modules/pam_permit/pam_permit.8 =================================================================== --- head/lib/libpam/modules/pam_permit/pam_permit.8 (revision 79657) +++ head/lib/libpam/modules/pam_permit/pam_permit.8 (revision 79658) @@ -1,75 +1,75 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 7, 2001 .Dt PAM_PERMIT 8 .Os .Sh NAME .Nm pam_permit .Nd Promiscuous PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_permit .Op Ar options .Sh DESCRIPTION The Promiscuous authentication service module for PAM, .Nm provides functionality for all the PAM categories: authentication, account management, session management and password management. In terms of the .Ar module-type parameter, these are the .Dq Li auth , .Dq Li account , .Dq Li session , and .Dq Li password features. .Pp The Promiscuous module will universally allow all requests. It is primarily of use during testing, and to silence .Dq noisy PAM-enabled applications. .Pp The following options may be passed to the module: -.Bl -tag -xwidth ".Cm debug" +.Bl -tag -width ".Cm debug" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .El .Sh SEE ALSO .Xr syslog 3 , .Xr pam.conf 5 , .Xr pam 8 Index: head/lib/libpam/modules/pam_rootok/pam_rootok.8 =================================================================== --- head/lib/libpam/modules/pam_rootok/pam_rootok.8 (revision 79657) +++ head/lib/libpam/modules/pam_rootok/pam_rootok.8 (revision 79658) @@ -1,70 +1,70 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 8, 2001 .Dt PAM_ROOTOK 8 .Os .Sh NAME .Nm pam_rootok .Nd RootOK PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_rootok .Op Ar options .Sh DESCRIPTION The RootOK authentication service module for PAM, .Nm provides functionality for only one PAM category: authentication. In terms of the .Ar module-type parameter, this is the .Dq Li auth feature. It also provides a null function for session management. .Ss RootOK Authentication Module The RootOK authentication component .Pq Fn pam_sm_authenticate , always returns success for the superuser; i.e., if .Xr getuid 2 returns 0. .Pp The following options may be passed to the authentication module: -.Bl -tag -xwidth ".Cm debug" +.Bl -tag -width ".Cm debug" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .El .Sh SEE ALSO .Xr getuid 2 , .Xr pam.conf 5 , .Xr pam 8 Index: head/lib/libpam/modules/pam_securetty/pam_securetty.8 =================================================================== --- head/lib/libpam/modules/pam_securetty/pam_securetty.8 (revision 79657) +++ head/lib/libpam/modules/pam_securetty/pam_securetty.8 (revision 79658) @@ -1,84 +1,84 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 8, 2001 .Dt PAM_SECURETTY 8 .Os .Sh NAME .Nm pam_securetty .Nd SecureTTY PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_securetty .Op Ar options .Sh DESCRIPTION The SecureTTY authentication service module for PAM, .Nm provides functionality for only one PAM category: authentication. In terms of the .Ar module-type parameter, this is the .Dq Li auth feature. It also provides a null function for session management. .Ss SecureTTY Authentication Module The SecureTTY authentication component .Pq Fn pam_sm_authenticate , returns success if the user is attempting to authenticate as superuser, and the process is attached to a secure TTY. Alternatively, if the user is not authenticating as superuser, the module always returns success. .Pp A TTY is defined as secure if its entry is fetchable from .Pa /etc/ttys by .Xr getttynam 3 (see .Xr ttys 5 ) , and the entry (a .Vt "struct ttyent" ) has the .Dv TTY_SECURE flag set. .Pp The following options may be passed to the authentication module: -.Bl -tag -xwidth ".Cm debug" +.Bl -tag -width ".Cm debug" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .El .Sh SEE ALSO .Xr getttynam 3 , .Xr syslog 3 , .Xr pam.conf 5 , .Xr ttys 5 , .Xr pam 8 Index: head/lib/libpam/modules/pam_ssh/pam_ssh.8 =================================================================== --- head/lib/libpam/modules/pam_ssh/pam_ssh.8 (revision 79657) +++ head/lib/libpam/modules/pam_ssh/pam_ssh.8 (revision 79658) @@ -1,148 +1,148 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 7, 2001 .Dt PAM_UNIX 8 .Os .Sh NAME .Nm pam_unix .Nd UNIX PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_unix .Op Ar options .Sh DESCRIPTION The .Ux authentication service module for PAM, .Nm provides functionality for two PAM categories: authentication and account management. In terms of the .Ar module-type parameter, they are the .Dq Li auth and .Dq Li account features. It also provides a null function for session management. .Ss Ux Ss Authentication Module The .Ux authentication component provides functions to verify the identity of a user .Pq Fn pam_sm_authenticate , which obtains the relevant .Xr passwd 5 entry. It prompts the user for a password and verifies that this is correct with .Xr crypt 3 . .Pp The following options may be passed to the authentication module: -.Bl -tag -xwidth ".Cm use_first_pass" +.Bl -tag -width ".Cm use_first_pass" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .It Cm use_first_pass If the authentication module is not the first in the stack, and a previous module obtained the user's password, that password is used to authenticate the user. If this fails, the authentication module returns failure without prompting the user for a password. This option has no effect if the authentication module is the first in the stack, or if no previous modules obtained the user's password. .It Cm try_first_pass This option is similar to the .Cm use_first_pass option, except that if the previously obtained password fails, the user is prompted for another password. .It Cm auth_as_self This option will require the user to authenticate themself as the user given by .Xr getuid 2 , not as the account they are attempting to access. This is primarily for services like .Xr su 1 , where the user's ability to retype their own password might be deemed sufficient. .It Cm nullok If the password database has no password for the entity being authenticated, then this option will forgo password prompting, and silently allow authentication to succeed. .El .Ss Ux Ss Account Management Module The .Ux account management component provides a function to perform account management, .Fn pam_sm_acct_mgmt . The function verifies that the authenticated user is allowed to login to the local user account by checking the password expiry date. .Pp The following options may be passed to the management module: -.Bl -tag -xwidth ".Cm use_first_pass" +.Bl -tag -width ".Cm use_first_pass" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .El .Sh FILES -.Bl -tag -xwidth ".Pa /etc/master.passwd" -compact +.Bl -tag -width ".Pa /etc/master.passwd" -compact .It Pa /etc/master.passwd default .Ux password database. .El .Sh SEE ALSO .Xr passwd 1 , .Xr getuid 2 , .Xr crypt 3 , .Xr syslog 3 , .Xr pam.conf 5 , .Xr passwd 5 , .Xr pam 8 Index: head/lib/libpam/modules/pam_tacplus/pam_tacplus.8 =================================================================== --- head/lib/libpam/modules/pam_tacplus/pam_tacplus.8 (revision 79657) +++ head/lib/libpam/modules/pam_tacplus/pam_tacplus.8 (revision 79658) @@ -1,130 +1,130 @@ .\" Copyright (c) 1999 .\" Andrzej Bialecki . All rights reserved. .\" .\" Copyright (c) 1992, 1993, 1994 .\" The Regents of the University of California. All rights reserved. .\" All rights reserved. .\" .\" This code is derived from software donated to Berkeley by .\" Jan-Simon Pendry. .\" .\" 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 acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. .\" .\" $FreeBSD$ .\" .Dd August 2, 1999 .Dt PAM_TACPLUS 8 .Os .Sh NAME .Nm pam_tacplus .Nd TACACS+ authentication PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_tacplus .Op Ar options .Sh DESCRIPTION The .Nm module provides authentication services based upon the TACACS+ protocol for the PAM (Pluggable Authentication Module) framework. .Pp The .Nm module accepts these optional parameters: -.Bl -tag -xwidth ".Cm use_first_pass" +.Bl -tag -width ".Cm use_first_pass" .It Cm use_first_pass causes .Nm to use a previously entered password instead of prompting for a new one. If no password has been entered then authentication fails. .It Cm try_first_pass causes .Nm to use a previously entered password, if one is available. If no password has been entered, .Nm prompts for one as usual. .It Cm echo_pass causes echoing to be left on if .Nm prompts for a password. .It Cm conf Ns = Ns Ar pathname specifies a non-standard location for the TACACS+ client configuration file (normally located in .Pa /etc/tacplus.conf ) . .It Cm template_user Ns = Ns Ar username specifies a user whose .Xr passwd 5 entry will be used as a template to create the session environment if the supplied username does not exist in local password database. The user will be authenticated with the supplied username and password, but his credentials to the system will be presented as the ones for .Ar username , i.e., his login class, home directory, resource limits, etc. will be set to ones defined for .Ar username . .Pp If this option is omitted, and there is no username in the system databases equal to the supplied one (as determined by call to .Xr getpwnam 3 ) , the authentication will fail. .El .Sh FILES .Bl -tag -width /etc/tacplus.conf -compact .It Pa /etc/tacplus.conf The standard TACACS+ client configuration file for .Nm .El .Sh SEE ALSO .Xr passwd 5 , .Xr tacplus.conf 5 , .Xr pam 8 .Sh HISTORY The .Nm module first appeared in .Fx 3.1 . .Sh AUTHORS .An -nosplit The .Nm manual page was written by .An Andrzej Bialecki Aq abial@FreeBSD.org and adapted to TACACS+ from RADIUS by .An Mark R V Murray Aq markm@FreeBSD.org . .Pp The .Nm module was written by .An John D. Polstra Aq jdp@FreeBSD.org . Index: head/lib/libpam/modules/pam_unix/pam_unix.8 =================================================================== --- head/lib/libpam/modules/pam_unix/pam_unix.8 (revision 79657) +++ head/lib/libpam/modules/pam_unix/pam_unix.8 (revision 79658) @@ -1,148 +1,148 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 7, 2001 .Dt PAM_UNIX 8 .Os .Sh NAME .Nm pam_unix .Nd UNIX PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_unix .Op Ar options .Sh DESCRIPTION The .Ux authentication service module for PAM, .Nm provides functionality for two PAM categories: authentication and account management. In terms of the .Ar module-type parameter, they are the .Dq Li auth and .Dq Li account features. It also provides a null function for session management. .Ss Ux Ss Authentication Module The .Ux authentication component provides functions to verify the identity of a user .Pq Fn pam_sm_authenticate , which obtains the relevant .Xr passwd 5 entry. It prompts the user for a password and verifies that this is correct with .Xr crypt 3 . .Pp The following options may be passed to the authentication module: -.Bl -tag -xwidth ".Cm use_first_pass" +.Bl -tag -width ".Cm use_first_pass" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .It Cm use_first_pass If the authentication module is not the first in the stack, and a previous module obtained the user's password, that password is used to authenticate the user. If this fails, the authentication module returns failure without prompting the user for a password. This option has no effect if the authentication module is the first in the stack, or if no previous modules obtained the user's password. .It Cm try_first_pass This option is similar to the .Cm use_first_pass option, except that if the previously obtained password fails, the user is prompted for another password. .It Cm auth_as_self This option will require the user to authenticate themself as the user given by .Xr getuid 2 , not as the account they are attempting to access. This is primarily for services like .Xr su 1 , where the user's ability to retype their own password might be deemed sufficient. .It Cm nullok If the password database has no password for the entity being authenticated, then this option will forgo password prompting, and silently allow authentication to succeed. .El .Ss Ux Ss Account Management Module The .Ux account management component provides a function to perform account management, .Fn pam_sm_acct_mgmt . The function verifies that the authenticated user is allowed to login to the local user account by checking the password expiry date. .Pp The following options may be passed to the management module: -.Bl -tag -xwidth ".Cm use_first_pass" +.Bl -tag -width ".Cm use_first_pass" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .El .Sh FILES -.Bl -tag -xwidth ".Pa /etc/master.passwd" -compact +.Bl -tag -width ".Pa /etc/master.passwd" -compact .It Pa /etc/master.passwd default .Ux password database. .El .Sh SEE ALSO .Xr passwd 1 , .Xr getuid 2 , .Xr crypt 3 , .Xr syslog 3 , .Xr pam.conf 5 , .Xr passwd 5 , .Xr pam 8 Index: head/lib/libpam/modules/pam_wheel/pam_wheel.8 =================================================================== --- head/lib/libpam/modules/pam_wheel/pam_wheel.8 (revision 79657) +++ head/lib/libpam/modules/pam_wheel/pam_wheel.8 (revision 79658) @@ -1,99 +1,99 @@ .\" Copyright (c) 2001 Mark R V Murray .\" 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. .\" .\" $FreeBSD$ .\" .Dd July 8, 2001 .Dt PAM_WHEEL 8 .Os .Sh NAME .Nm pam_wheel .Nd Wheel PAM module .Sh SYNOPSIS .Op Ar service-name .Ar module-type .Ar control-flag .Pa pam_wheel .Op Ar options .Sh DESCRIPTION The Wheel authentication service module for PAM, .Nm provides functionality for only one PAM category: authentication. In terms of the .Ar module-type parameter, this is the .Dq Li auth feature. It also provides a null function for session management. .Ss Wheel Authentication Module The Wheel authentication component .Pq Fn pam_sm_authenticate , permit authentication to members of a group, which defaults to .Dq Li wheel . .Pp The following options may be passed to the authentication module: -.Bl -tag -xwidth ".Cm group Ns = Ns Ar foo" +.Bl -tag -width ".Cm group Ns = Ns Ar foo" .It Cm debug .Xr syslog 3 debugging information at .Dv LOG_DEBUG level. .It Cm use_uid check for .Dq Li wheel membership against the current UID (given by .Xr getuid 2 ) . .It Cm trust return .Dv PAM_SUCCESS instead of .Dv PAM_IGNORE if the user is a member of the group (default is .Dq Li wheel ) . .It Cm deny invert the operation if the user is a member of the (default .Dq Li wheel ) group. Returns failure instead of success. Mainly of use with the .Cm group Ns = Ns Ar foo option. .It Cm group Ns = Ns Ar foo checking for membership of group .Ar foo instead of the default group .Dq Li wheel . .El .Sh SEE ALSO .Xr getuid 2 , .Xr syslog 3 , .Xr group 5 , .Xr pam.conf 5 , .Xr pam 8 Index: head/sbin/sysctl/sysctl.8 =================================================================== --- head/sbin/sysctl/sysctl.8 (revision 79657) +++ head/sbin/sysctl/sysctl.8 (revision 79658) @@ -1,248 +1,248 @@ .\" Copyright (c) 1993 .\" The Regents of the University of California. 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 acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. .\" .\" From: @(#)sysctl.8 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd May 28, 2001 .Dt SYSCTL 8 .Os .Sh NAME .Nm sysctl .Nd get or set kernel state .Sh SYNOPSIS .Nm .Op Fl bNnox .Ar name Ns Op = Ns Ar value .Ar ... .Nm .Op Fl bNnox .Fl a .Sh DESCRIPTION The .Nm utility retrieves kernel state and allows processes with appropriate privilege to set kernel state. The state to be retrieved or set is described using a .Dq Management Information Base .Pq Dq MIB style name, described as a dotted set of components. .Pp The following options are available: .Bl -tag -width indent .It Fl A Equivalent to .Fl o a (for compatibility). .It Fl a List all the currently available non-opaque values. This option is ignored if one or more variable names are specified on the command line. .It Fl b Force the value of the variable(s) to be output in raw, binary format. No names are printed and no terminating newlines are output. This is mostly useful with a single variable. .It Fl N Show only variable names, not their values. This is particularly useful with shells that offer programmable completion. To enable completion of variable names in .Nm zsh , use the following code: .Bd -literal -offset indent listsysctls () { set -A reply $(sysctl -AN ${1%.*}) } compctl -K listsysctls sysctl .Ed .It Fl n Show only variable values, not their names. This option is useful for setting shell variables. For instance, to save the pagesize in variable .Va psize , use: .Pp .Dl "set psize=`sysctl -n hw.pagesize`" .It Fl o Show opaque variables (which are normally suppressed). The format and length are printed, as well as a hex dump of the first sixteen bytes of the value. .It Fl X Equivalent to .Fl x a (for compatibility). .It Fl x As .Fl o , but prints a hex dump of the entire value instead of just the first few bytes. .El .Pp The information available from .Nm consists of integers, strings, and opaques. .Nm Sysctl only knows about a couple of opaque types, and will resort to hexdumps for the rest. The opaque information is much more useful if retrieved by special purpose programs such as .Nm ps , systat , and .Nm netstat . .Pp The string and integer information is summarized below. For a detailed description of these variable see .Xr sysctl 3 . .Pp The changeable column indicates whether a process with appropriate privilege can change the value. .Bl -column net.inet.ip.forwardingxxxxxx integerxxx .It Sy "Name Type Changeable .It "kern.ostype string no .It "kern.osrelease string no .It "kern.osrevision integer no .It "kern.version string no .It "kern.maxvnodes integer yes .It "kern.maxproc integer no .It "kern.maxprocperuid integer yes .It "kern.maxfiles integer yes .It "kern.maxfilesperproc integer yes .It "kern.argmax integer no .It "kern.suser_permitted integer yes .It "kern.securelevel integer raise only .It "kern.hostname string yes .It "kern.hostid integer yes .It "kern.clockrate struct no .It "kern.posix1version integer no .It "kern.ngroups integer no .It "kern.job_control integer no .It "kern.saved_ids integer no .It "kern.boottime struct no .It "kern.domainname string yes .It "kern.filedelay integer yes .It "kern.dirdelay integer yes .It "kern.metadelay integer yes .It "kern.osreldate string no .It "kern.bootfile string yes .It "kern.corefile string yes .It "kern.logsigexit integer yes .It "vm.loadavg struct no .It "hw.machine string no .It "hw.model string no .It "hw.ncpu integer no .It "hw.byteorder integer no .It "hw.physmem integer no .It "hw.usermem integer no .It "hw.pagesize integer no .It "hw.floatingpoint integer no .It "hw.machine_arch string no .It "machdep.console_device dev_t no .It "machdep.adjkerntz integer yes .It "machdep.disable_rtc_set integer yes .It "user.cs_path string no .It "user.bc_base_max integer no .It "user.bc_dim_max integer no .It "user.bc_scale_max integer no .It "user.bc_string_max integer no .It "user.coll_weights_max integer no .It "user.expr_nest_max integer no .It "user.line_max integer no .It "user.re_dup_max integer no .It "user.posix2_version integer no .It "user.posix2_c_bind integer no .It "user.posix2_c_dev integer no .It "user.posix2_char_term integer no .It "user.posix2_fort_dev integer no .It "user.posix2_fort_run integer no .It "user.posix2_localedef integer no .It "user.posix2_sw_dev integer no .It "user.posix2_upe integer no .It "user.stream_max integer no .It "user.tzname_max integer no .El .Sh EXAMPLES For example, to retrieve the maximum number of processes allowed in the system, one would use the following request: .Pp .Dl "sysctl kern.maxproc" .Pp To set the maximum number of processes allowed per uid to 1000, one would use the following request: .Pp .Dl "sysctl -w kern.maxprocperuid=1000" .Pp Information about the system clock rate may be obtained with: .Pp .Dl "sysctl kern.clockrate" .Pp Information about the load average history may be obtained with: .Pp .Dl "sysctl vm.loadavg" .Pp More variables than these exist, and the best and likely only place to search for their deeper meaning is undoubtedly the source where they are defined. .Sh FILES -.Bl -tag -xwidth ".Aq Pa netinet/icmp_var.h" -compact +.Bl -tag -width ".Aq Pa netinet/icmp_var.h" -compact .It Aq Pa sys/sysctl.h definitions for top level identifiers, second level kernel and hardware identifiers, and user level identifiers .It Aq Pa sys/socket.h definitions for second level network identifiers .It Aq Pa sys/gmon.h definitions for third level profiling identifiers .It Aq Pa vm/vm_param.h definitions for second level virtual memory identifiers .It Aq Pa netinet/in.h definitions for third level Internet identifiers and fourth level IP identifiers .It Aq Pa netinet/icmp_var.h definitions for fourth level ICMP identifiers .It Aq Pa netinet/udp_var.h definitions for fourth level UDP identifiers .El .Sh SEE ALSO .Xr sysctl 3 , .Xr sysctl.conf 5 .Sh BUGS .Nm Sysctl presently exploits an undocumented interface to the kernel sysctl facility to traverse the sysctl tree and to retrieve format and name information. This correct interface is being thought about for the time being. .Sh HISTORY .Nm Sysctl first appeared in .Bx 4.4 . .Pp In .Fx 2.2 , .Nm was significantly remodeled. Index: head/share/man/man4/ieee80211.4 =================================================================== --- head/share/man/man4/ieee80211.4 (revision 79657) +++ head/share/man/man4/ieee80211.4 (revision 79658) @@ -1,243 +1,243 @@ .\" Copyright (c) 2001 .\" The Aerospace Corporation. 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. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AEROSPACE CORPORATION ``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 AEROSPACE CORPORATION 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$ .\" .Dd February 23, 2001 .Dt IEEE80211 4 .Os .Sh NAME .Nm ieee80211 .Nd standard interface to IEEE 802.11 devices .Sh SYNOPSIS .In net/if_ieee80211.h .Sh DESCRIPTION This section describes the interface standard interface to configuration and status information on IEEE 802.11 devices. Most devices support options not configurable by this interface. They must be set by their respective, specific control program. The interface is via one of the following .Xr ioctl 2 calls on a socket: -.Bl -tag -xwidth ".Dv SIOCG80211" +.Bl -tag -width ".Dv SIOCG80211" .It Dv SIOCG80211 Get configuration or status information. .It Dv SIOCS80211 Set configuration information. .El .Pp These requests are made via a modified .Vt ifreq structure. This structure is defined as follows: .Bd -literal struct ieee80211req { char i_name[IFNAMSIZ]; /* if_name, e.g. "wi0" */ u_int16_t i_type; /* req type */ int16_t i_val; /* Index or simple value */ int16_t i_len; /* Index or simple value */ void *i_data; /* Extra data */ }; .Ed .Pp For .Dv SIOCG80211 the following values of .Va i_type are valid: -.Bl -tag -xwidth ".Dv IEEE80211_IOC_POWERSAVESLEEP" +.Bl -tag -width ".Dv IEEE80211_IOC_POWERSAVESLEEP" .It Dv IEEE80211_IOC_SSID Returns the requested SSID by copying it into the buffer pointed to by .Va i_data and setting .Va i_len to the length. If .Va i_val is \(>= 0 then the request refers to the configured value for that slot. Generally, 0 is the only valid value, but some interfaces support more SSIDs. If .Va i_val is \-1 then the request refers to the currently active value. .It Dv IEEE80211_IOC_NUMSSIDS Returns the number of SSIDs this card supports. In most cases, this is 1, but some devices such as .Xr an 4 support more. .It Dv IEEE80211_IOC_WEP Returns the current WEP status in .Va i_val . Valid values are .Dv IEEE80211_WEP_NOSUP , IEEE80211_WEP_ON , IEEE80211_WEP_OFF , and .Dv IEEE80211_WEP_MIXED . Respectively, these values mean unsupported, mandatory for all devices, off, and on, but not required for all devices. .It Dv IEEE80211_IOC_WEPKEY Returns the requested WEP key via .Va i_data and its length via .Va i_len . If the device does not support returning the WEP key or the user is not root then the key may be returned as all zeros. Technically this is a valid key, but it's the kind of key an idiot would put on his luggage so we use it as a special value. Generally, only four WEP keys are allowed, but some devices support more. If so, the first four (0-3) are the standard keys stored in volatile storage and the others are device specific. .It Dv IEEE80211_IOC_NUMWEPKEYS Returns the number of WEP keys supported by this device, generally 4. A device that does not support WEP may either report 0 or simply return .Er EINVAL . .It Dv IEEE80211_IOC_WEPTXKEY Returns the WEP key used for transmission. .It Dv IEEE80211_IOC_AUTHMODE Returns the current authentication mode in .Va i_val . Valid values are .Dv IEEE80211_AUTH_NONE , IEEE80211_AUTH_OPEN , and .Dv IEEE80211_AUTH_SHARED . .It Dv IEEE80211_IOC_STATIONNAME Returns the station name via .Va i_data and its length via .Va i_len . While all known devices seem to support this is some way or another, they all do it differently and it appears to not have anything to do with the actual IEEE 802.11 standard so making up an answer may be necessary for future devices. .It Dv IEEE80211_IOC_CHANNEL Returns the current direct sequence spread spectrum channel in use. .It Dv IEEE80211_IOC_POWERSAVE Returns the current powersaving mode. Valid values are .Dv IEEE80211_POWERSAVE_NOSUP , IEEE80211_POWERSAVE_OFF , .Dv IEEE80211_POWERSAVE_ON , IEEE80211_POWERSAVE_CAM , .Dv IEEE80211_POWERSAVE_PSP , and .Dv IEEE80211_POWERSAVE_PSP_CAM . Currently, .Dv IEEE80211_POWERSAVE_ON is defined to be equal to .Dv IEEE80211_POWERSAVE_CAM , but this may be incorrect. .It Dv IEEE80211_IOC_POWERSAVESLEEP Returns the powersave sleep time in msec in .Va i_val . .El .Pp For .Dv SIOCS80211 the following values of .Va i_type are valid: -.Bl -tag -xwidth ".Dv IEEE80211_IOC_POWERSAVESLEEP" +.Bl -tag -width ".Dv IEEE80211_IOC_POWERSAVESLEEP" .It Dv IEEE80211_IOC_SSID Set the desired SSID for infrastructure and ad-hoc modes to value given by .Va i_data and .Va i_len . The length should be no longer then 32 characters. .It Dv IEEE80211_IOC_WEP Set the current WEP mode to the value given in .Va i_val . Valid values are the same as those for this value above. Devices which do not support all modes may choose to either return .Er EINVAL or choose a reasonable alternate (supported) setting. .It Dv IEEE80211_IOC_WEPKEY Set the WEP key indicated by .Va i_val to the value given by .Va i_data and .Va i_len . Generally, valid values of .Va i_len are 0, 5, and 13 though not all devices with WEP support have support for 13-byte keys. .It Dv IEEE80211_IOC_WEPTXKEY Set the WEP key used for transmission to the value in .Va i_val . Not all values which are valid for setting keys may be valid for setting transmit keys due to strange device interfaces. .It Dv IEEE80211_IOC_AUTHMODE Set the current authorization mode to the value given in .Va i_val . Valid values are given above. Not all devices support this. .It Dv IEEE80211_IOC_STATIONNAME Set the station name to the value given by .Va i_data and .Va i_len . The standard does not appear to deal with this feature so the range of valid values may vary from device to device. .It Dv IEEE80211_IOC_CHANNEL Set the desired ad-hoc channel to the value given by .Va i_val . On some devices this has an impact on infrastructure mode as well. Valid values are 1-14, but 0 should be allowed and should return the device to the default value. May devices support this directly by converting any invalid value to the default value. .It Dv IEEE80211_IOC_POWERSAVE Set the current powersaving mode to the value given in .Va i_val . Valid values are the same as those for this value above. Devices which do not support all modes may choose to either return .Er EINVAL or choose a reasonable alternate (supported) setting. Most devices only support CAM mode. .It Dv IEEE80211_IOC_POWERSAVESLEEP Set the powersave sleep time in msec to the value in .Va i_val . .El .Sh SEE ALSO .Xr ioctl 2 , .Xr an 4 , .Xr ray 4 , .Xr wi 4 , .Xr ancontrol 8 , .Xr ifconfig 8 , .Xr raycontrol 8 , .Xr wicontrol 8 .Sh HISTORY The .Nm manual appeared in .Fx 4.3 . Index: head/share/man/man4/lge.4 =================================================================== --- head/share/man/man4/lge.4 (revision 79657) +++ head/share/man/man4/lge.4 (revision 79658) @@ -1,142 +1,142 @@ .\" Copyright (c) 2001 Wind River Systems .\" Copyright (c) 1997, 1998, 1999, 2000, 2001 .\" Bill Paul . 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 acknowledgement: .\" This product includes software developed by Bill Paul. .\" 4. Neither the name of the author nor the names of any co-contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD .\" 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$ .\" .Dd May 30, 2001 .Dt LGE 4 .Os .Sh NAME .Nm lge .Nd "Level 1 LXT1001 NetCellerator PCI gigabit ethernet adapter driver" .Sh SYNOPSIS .Cd "device miibus" .Cd "device lge" .Sh DESCRIPTION The .Nm driver provides support for various NICs based on the Level 1 LXT1001 NetCellerator gigabit ethernet controller chip, including the following: .Pp .Bl -bullet -compact .It SMC TigerCard 1000 (SMC9462SX) .It D-Link DGE-500SX .El .Pp These NICs are capable of 1000mbps speeds over fiber optic cable. The LXT1001 also supports a GMII port for use with 10/100/1000 copper PHYs, however there aren't currently any NICs on the market that use this feature. .Pp The LXT1001 supports TCP/IP checksum offload for receive and VLAN-based filtering as well as a 64-bit multicast hash filter. It also supports jumbo frames, which can be configured via the interface MTU setting. Selecting an MTU larger than 1500 bytes with the .Xr ifconfig 8 utility configures the adapter to receive and transmit jumbo frames. Using jumbo frames can greatly improve performance for certain tasks, such as file transfers and data streaming. .Pp The .Nm driver supports the following media types: -.Bl -tag -xwidth ".Cm 1000baseSX" +.Bl -tag -width ".Cm 1000baseSX" .It Cm autoselect Enable autoselection of the media type and options. The user can manually override the autoselected mode by adding media options to .Xr rc.conf 5 . .It Cm 1000baseSX Set 1000baseSX operation over fiber optic cable. Both .Cm full-duplex and .Cm half-duplex modes are supported. .El .Pp The .Nm driver supports the following media options: -.Bl -tag -xwidth ".Cm full-duplex" +.Bl -tag -width ".Cm full-duplex" .It Cm full-duplex Force full duplex operation. .It Cm half-duplex Force half duplex operation. .El .Pp For more information on configuring this device, see .Xr ifconfig 8 . .Sh DIAGNOSTICS .Bl -diag .It "lge%d: couldn't map memory" A fatal initialization error has occurred. .It "lge%d: couldn't map ports" A fatal initialization error has occurred. .It "lge%d: couldn't map interrupt" A fatal initialization error has occurred. .It "lge%d: no memory for softc struct!" The driver failed to allocate memory for per-device instance information during initialization. .It "lge%d: failed to enable memory mapping!" The driver failed to initialize PCI shared memory mapping. This might happen if the card is not in a bus-master slot. .It "lge%d: no memory for jumbo buffers!" The driver failed to allocate memory for jumbo frames during initialization. .It "lge%d: watchdog timeout" The device has stopped responding to the network, or there is a problem with the network connection (cable). .El .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Rs .%T Level 1 LXT1001 Programming Manual .%O http://www.FreeBSD.org/~wpaul/Level1/LXT1001SRM.pdf .Re .Sh HISTORY The .Nm device driver first appeared in .Fx 5.0 . .Sh AUTHORS The .Nm driver was written by .An Bill Paul Aq william.paul@windriver.com . Index: head/share/man/man4/tun.4 =================================================================== --- head/share/man/man4/tun.4 (revision 79657) +++ head/share/man/man4/tun.4 (revision 79658) @@ -1,303 +1,303 @@ .\" $NetBSD: tun.4,v 1.1 1996/06/25 22:17:37 pk Exp $ .\" $FreeBSD$ .\" Based on PR#2411 .\" .Dd June 5, 2001 .Dt TUN 4 .Os .Sh NAME .Nm tun .Nd tunnel software network interface .Sh SYNOPSIS .Cd device tun .Sh DESCRIPTION The .Nm interface is a software loopback mechanism that can be loosely described as the network interface analog of the .Xr pty 4 , that is, .Nm does for network interfaces what the .Xr pty 4 driver does for terminals. .Pp The .Nm driver, like the .Xr pty 4 driver, provides two interfaces: an interface like the usual facility it is simulating (a network interface in the case of .Nm , or a terminal for .Xr pty 4 ) , and a character-special device .Dq control interface. .Pp The network interfaces are named .Dq Li tun0 , .Dq Li tun1 , etc., one for each control device that has been opened. These network interfaces persist until the .Pa if_tun.ko module is unloaded (if .Nm is built into your kernel, the network interfaces cannot be removed). .Pp On older systems without .Xr devfs 5 support, .Xr MAKEDEV 8 should be used to create the initial control devices and the task of locating an unused device is left up to the opener (a .Nm device is usually obtained by attempting to open .Pa /dev/tun0 , and if that fails .Pa /dev/tun1 etc., until an .Va errno of .Er EBUSY is not received). .Pp On systems with .Xr devfs 5 support, .Nm permits opens on the special control device .Pa /dev/tun . When this device is opened, .Nm will return a handle for the lowest unused .Nm device (use .Xr devname 3 to determine which). Control devices (once successfully opened) persist until .Pa if_tun.ko is unloaded in the same way that network interfaces persist (see above). .Pp Each interface supports the usual network-interface .Xr ioctl 2 Ns s , such as .Dv SIOCSIFADDR and .Dv SIOCSIFNETMASK , and thus can be used with .Xr ifconfig 8 like any other interface. At boot time, they are .Dv POINTOPOINT interfaces, but this can be changed; see the description of the control device, below. When the system chooses to transmit a packet on the network interface, the packet can be read from the control device (it appears as .Dq input there); writing a packet to the control device generates an input packet on the network interface, as if the (non\-existent) hardware had just received it. .Pp The tunnel device .Pq Pa /dev/tun Ns Ar N is exclusive-open (it cannot be opened if it is already open). A .Xr read 2 call will return an error .Pq Er EHOSTDOWN if the interface is not .Dq ready (which means that the control device is open and the interface's address has been set). .Pp Once the interface is ready, .Xr read 2 will return a packet if one is available; if not, it will either block until one is or return .Er EWOULDBLOCK , depending on whether non-blocking I/O has been enabled. If the packet is longer than is allowed for in the buffer passed to .Xr read 2 , the extra data will be silently dropped. .Pp If the .Dv TUNSLMODE ioctl has been set, packets read from the control device will be prepended with the destination address as presented to the network interface output routine, .Fn tunoutput . The destination address is in .Vt struct sockaddr format. The actual length of the prepended address is in the member .Va sa_len . If the .Dv TUNSIFHEAD ioctl has been set, packets will be prepended with a four byte address family in network byte order. .Dv TUNSLMODE and .Dv TUNSIFHEAD are mutually exclusive. In any case, the packet data follows immediately. .Pp A .Xr write 2 call passes a packet in to be .Dq received on the pseudo-interface. If the .Dv TUNSIFHEAD ioctl has been set, the address family must be prepended, otherwise the packet is assumed to be of type .Dv AF_INET . Each .Xr write 2 call supplies exactly one packet; the packet length is taken from the amount of data provided to .Xr write 2 (minus any supplied address family). Writes will not block; if the packet cannot be accepted for a transient reason (e.g., no buffer space available), it is silently dropped; if the reason is not transient (e.g., packet too large), an error is returned. .Pp The following .Xr ioctl 2 calls are supported (defined in .Aq Pa net/if_tun.h ) : -.Bl -tag -xwidth ".Dv TUNSIFMODE" +.Bl -tag -width ".Dv TUNSIFMODE" .It Dv TUNSDEBUG The argument should be a pointer to an .Vt int ; this sets the internal debugging variable to that value. What, if anything, this variable controls is not documented here; see the source code. .It Dv TUNGDEBUG The argument should be a pointer to an .Vt int ; this stores the internal debugging variable's value into it. .It Dv TUNSIFINFO The argument should be a pointer to an .Vt struct tuninfo and allows setting the MTU, the type, and the baudrate of the tunnel device. The .Vt struct tuninfo is declared in .Aq Pa net/if_tun.h . .Pp The use of this ioctl is restricted to the super-user. .It Dv TUNGIFINFO The argument should be a pointer to an .Vt struct tuninfo , where the current MTU, type, and baudrate will be stored. .It Dv TUNSIFMODE The argument should be a pointer to an .Vt int ; its value must be either .Dv IFF_POINTOPOINT or .Dv IFF_BROADCAST . The type of the corresponding .Dq Li tun Ns Ar N interface is set to the supplied type. If the value is anything else, an .Er EINVAL error occurs. The interface must be down at the time; if it is up, an .Er EBUSY error occurs. .It Dv TUNSLMODE The argument should be a pointer to an .Vt int ; a non-zero value turns off .Dq multi-af mode and turns on .Dq link-layer mode, causing packets read from the tunnel device to be prepended with the network destination address (see above). .It Dv TUNSIFPID Will set the pid owning the tunnel device to the current process's pid. .It Dv TUNSIFHEAD The argument should be a pointer to an .Vt int ; a non-zero value turns off .Dq link-layer mode, and enables .Dq multi-af mode, where every packet is preceded with a four byte address family. .It Dv TUNGIFHEAD The argument should be a pointer to an .Vt int ; the ioctl sets the value to one if the device is in .Dq multi-af mode, and zero otherwise. .It Dv FIONBIO Turn non-blocking I/O for reads off or on, according as the argument .Vt int Ns 's value is or isn't zero. (Writes are always non-blocking.) .It Dv FIOASYNC Turn asynchronous I/O for reads (i.e., generation of .Dv SIGIO when data is available to be read) off or on, according as the argument .Vt int Ns 's value is or isn't zero. .It Dv FIONREAD If any packets are queued to be read, store the size of the first one into the argument .Vt int ; otherwise, store zero. .It Dv TIOCSPGRP Set the process group to receive .Dv SIGIO signals, when asynchronous I/O is enabled, to the argument .Vt int value. .It Dv TIOCGPGRP Retrieve the process group value for .Dv SIGIO signals into the argument .Vt int value. .El .Pp The control device also supports .Xr select 2 for read; selecting for write is pointless, and always succeeds, since writes are always non-blocking. .Pp On the last close of the data device, by default, the interface is brought down (as if with .Nm ifconfig Ar tunN Cm down ) . All queued packets are thrown away. If the interface is up when the data device is not open output packets are always thrown away rather than letting them pile up. .Sh SEE ALSO .Xr ioctl 2 , .Xr read 2 , .Xr select 2 , .Xr write 2 , .Xr devname 3 , .Xr inet 4 , .Xr intro 4 , .Xr pty 4 , .Xr devfs 5 , .Xr ifconfig 8 , .Xr MAKEDEV 8 .Sh AUTHORS This manual page was originally obtained from .Nx . Index: head/share/man/man9/BUF_LOCK.9 =================================================================== --- head/share/man/man9/BUF_LOCK.9 (revision 79657) +++ head/share/man/man9/BUF_LOCK.9 (revision 79658) @@ -1,72 +1,72 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt BUF_LOCK 9 .Os .Sh NAME .Nm BUF_LOCK .Nd "locks a buffer" .Sh SYNOPSIS .In sys/param.h .In sys/buf.h .Ft int .Fn BUF_LOCK "struct buf *bp" "int locktype" .Sh DESCRIPTION The .Fn BUF_LOCK function locks the given buffer. If the lock is already held this call will block until it can aquire the lock unless .Dv LK_NOWAIT is set. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa locktype" +.Bl -tag -width ".Fa locktype" .It Fa bp The buffer to lock. .It Fa locktype Flags controlling the type of lock. See .Xr lockmgr 9 for details. .El .Sh RETURN VALUES A value of 0 is returned upon success. See .Xr lockmgr 9 for information on non-zero return values. .Sh SEE ALSO .Xr buf 9 , .Xr BUF_TIMELOCK 9 , .Xr BUF_UNLOCK 9 , .Xr lockmgr 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/BUF_LOCKFREE.9 =================================================================== --- head/share/man/man9/BUF_LOCKFREE.9 (revision 79657) +++ head/share/man/man9/BUF_LOCKFREE.9 (revision 79658) @@ -1,60 +1,60 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt BUF_LOCKFREE 9 .Os .Sh NAME .Nm BUF_LOCKFREE .Nd "destroys a buffer's lock" .Sh SYNOPSIS .In sys/param.h .In sys/buf.h .Ft void .Fn BUF_LOCKFREE "struct buf *bp" .Sh DESCRIPTION The .Fn BUF_LOCKFREE macro destroys the buffer lock. The lock must not be held when this macro is called or a panic will result. .Pp Its argument is: -.Bl -tag -xwidth ".Fa bp" +.Bl -tag -width ".Fa bp" .It Fa bp The buffer whose lock is to be destroyed. .El .Sh SEE ALSO .Xr buf 9 , .Xr BUF_LOCK 9 , .Xr BUF_TIMELOCK 9 , .Xr BUF_UNLOCK 9 , .Xr lockdestroy 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/BUF_LOCKINIT.9 =================================================================== --- head/share/man/man9/BUF_LOCKINIT.9 (revision 79657) +++ head/share/man/man9/BUF_LOCKINIT.9 (revision 79658) @@ -1,59 +1,59 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt BUF_LOCKINIT 9 .Os .Sh NAME .Nm BUF_LOCKINIT .Nd "unlocks a locked buffer" .Sh SYNOPSIS .In sys/param.h .In sys/buf.h .Ft void .Fn BUF_LOCKINIT "struct buf *bp" .Sh DESCRIPTION The .Fn BUF_LOCKINIT macro initializes a buffer lock. .Pp Its argument is: -.Bl -tag -xwidth ".Fa bp" +.Bl -tag -width ".Fa bp" .It Fa bp The buffer whose lock it to be initialized. .El .Sh SEE ALSO .Xr buf 9 , .Xr BUF_LOCK 9 , .Xr BUF_TIMELOCK 9 , .Xr BUF_UNLOCK 9 , .Xr lockinit 9 , .Xr lockmgr 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/BUF_REFCNT.9 =================================================================== --- head/share/man/man9/BUF_REFCNT.9 (revision 79657) +++ head/share/man/man9/BUF_REFCNT.9 (revision 79658) @@ -1,58 +1,58 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt BUF_REFCNT 9 .Os .Sh NAME .Nm BUF_REFCNT .Nd "returns the reference count on a buffer's lock" .Sh SYNOPSIS .In sys/param.h .In sys/buf.h .Ft int .Fn BUF_REFCNT "struct buf *bp" .Sh DESCRIPTION The .Fn BUF_REFCNT function returns the reference count on a buffer's lock. .Pp Its argument is: -.Bl -tag -xwidth ".Fa bp" +.Bl -tag -width ".Fa bp" .It Fa bp The buffer whose lock reference count is to be returned. .El .Sh SEE ALSO .Xr buf 9 , .Xr BUF_LOCK 9 , .Xr BUF_TIMELOCK 9 , .Xr BUF_UNLOCK 9 , .Xr lockcount 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/BUF_TIMELOCK.9 =================================================================== --- head/share/man/man9/BUF_TIMELOCK.9 (revision 79657) +++ head/share/man/man9/BUF_TIMELOCK.9 (revision 79658) @@ -1,80 +1,80 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt BUF_TIMELOCK 9 .Os .Sh NAME .Nm BUF_TIMELOCK .Nd "locks a buffer" .Sh SYNOPSIS .In sys/param.h .In sys/buf.h .Ft int .Fn BUF_TIMELOCK "struct buf *bp" "int locktype" "char *wmesg" "int catch" "int timo" .Sh DESCRIPTION The .Fn BUF_TIMELOCK function locks the given buffer, and limits the amount of time it will sleep to .Fa timo and OR's .Fa catch into the sleep's priority. .Fa wmesg is the wmesg used in the sleep. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa locktype" +.Bl -tag -width ".Fa locktype" .It Fa bp The buffer to lock. .It Fa locktype Flags controlling the type of lock. See .Xr lockmgr 9 for details. .It Fa wmesg The wmesg used in any sleeps while aquiring the lock. .It Fa catch Priority OR'd into the sleep's priority. .It Fa timo The timeout for any sleeps encountered during the lock. .El .Sh RETURN VALUES A value of 0 is returned on success. See .Xr lockmgr 9 for details on non-zero return values. .Sh SEE ALSO .Xr buf 9 , .Xr BUF_LOCK 9 , .Xr BUF_UNLOCK 9 , .Xr lockmgr 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/BUF_UNLOCK.9 =================================================================== --- head/share/man/man9/BUF_UNLOCK.9 (revision 79657) +++ head/share/man/man9/BUF_UNLOCK.9 (revision 79658) @@ -1,61 +1,61 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt BUF_UNLOCK 9 .Os .Sh NAME .Nm BUF_UNLOCK .Nd "unlocks a locked buffer" .Sh SYNOPSIS .In sys/param.h .In sys/buf.h .Ft void .Fn BUF_UNLOCK "struct buf *bp" .Sh DESCRIPTION The .Fn BUF_UNLOCK function unlocks a buffer that was previously locked with .Fn BUF_LOCK or .Fn BUF_TIMELOCK . .Pp Its argument is: -.Bl -tag -xwidth ".Fa bp" +.Bl -tag -width ".Fa bp" .It Fa bp The buffer to unlock. The buffer must already be locked. .El .Sh SEE ALSO .Xr buf 9 , .Xr BUF_LOCK 9 , .Xr BUF_TIMELOCK 9 , .Xr lockmgr 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/cdevsw_add.9 =================================================================== --- head/share/man/man9/cdevsw_add.9 (revision 79657) +++ head/share/man/man9/cdevsw_add.9 (revision 79658) @@ -1,65 +1,65 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt CDEVSW_ADD 9 .Os .Sh NAME .Nm cdevsw_add .Nd adds a .Vt cdevsw entry .Sh SYNOPSIS .In sys/param.h .In sys/conf.h .Ft int .Fn cdevsw_add "struct cdevsw *newentry" .Sh DESCRIPTION The .Fn cdevsw_add function adds .Fa newentry to the .Va cdevsw table if its major number is greater than or equal to zero, and is less than .Dv NUMCDEVSW . .Pp Its argument is: -.Bl -tag -xwidth ".Fa newentry" +.Bl -tag -width ".Fa newentry" .It Fa newentry The device to add to the table. .El .Sh RETURN VALUES A value of 0 is returned on success; otherwise, .Er EINVAL is returned indicating that the major number is not in the valid range. .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/cdevsw_remove.9 =================================================================== --- head/share/man/man9/cdevsw_remove.9 (revision 79657) +++ head/share/man/man9/cdevsw_remove.9 (revision 79658) @@ -1,65 +1,65 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt CDEVSW_REMOVE 9 .Os .Sh NAME .Nm cdevsw_remove .Nd removes a .Vt cdevsw entry .Sh SYNOPSIS .In sys/param.h .In sys/conf.h .Ft int .Fn cdevsw_remove "struct cdevsw *oldentry" .Sh DESCRIPTION The .Fn cdevsw_remove function removes .Fa oldentry from the .Va cdevsw table if its major number is greater than or equal to zero, and is less than .Dv NUMCDEVSW . .Pp Its argument is: -.Bl -tag -xwidth ".Fa oldentry" +.Bl -tag -width ".Fa oldentry" .It Fa oldentry The device to remove from the table. .El .Sh RETURN VALUES A value of 0 is returned on success; otherwise, .Er EINVAL is returned indicating that the major number is not in the valid range. .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/devsw.9 =================================================================== --- head/share/man/man9/devsw.9 (revision 79657) +++ head/share/man/man9/devsw.9 (revision 79658) @@ -1,75 +1,75 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt DEVSW 9 .Os .Sh NAME .Nm devsw .Nd returns the .Vt cdevsw structure .Sh SYNOPSIS .In sys/conf.h .Ft "struct cdevsw *" .Fn devsw "dev_t dev" .Sh DESCRIPTION The .Fn devsw function returns a pointer to the .Vt cdevsw structure associated with this character device ID. If .Fa dev->si_cdevsw is set it is returned; otherwise, the .Xr major 9 offset into the .Va cdevsw array is returned. .Pp Its argument is: -.Bl -tag -xwidth ".Fa dev" +.Bl -tag -width ".Fa dev" .It Fa dev The device whose .Vt cdevsw entry should be returned. .El .Sh RETURN VALUES A pointer to a .Vt cdevsw structure. .Sh SEE ALSO .Xr major 9 , .Xr minor 9 , .Xr umajor 9 , .Xr uminor 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/lockcount.9 =================================================================== --- head/share/man/man9/lockcount.9 (revision 79657) +++ head/share/man/man9/lockcount.9 (revision 79658) @@ -1,61 +1,61 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt LOCKCOUNT 9 .Os .Sh NAME .Nm lockcount .Nd "returns the reference count of a lock" .Sh SYNOPSIS .In sys/types.h .In sys/lockmgr.h .Ft int .Fn lockcount "struct lock *lkp" .Sh DESCRIPTION The .Fn lockcount function returns the reference count of the lock. The reference count is the sum of exclusive locks and shared locks. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa lkp" +.Bl -tag -width ".Fa lkp" .It Fa lkp The lock to return the reference count on. .El .Sh RETURN VALUES An integer greater than or equal to zero. .Sh SEE ALSO .Xr lockdestroy 9 , .Xr lockmgr 9 , .Xr lockmgr_printinfo 9 , .Xr lockstatus 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/lockdestroy.9 =================================================================== --- head/share/man/man9/lockdestroy.9 (revision 79657) +++ head/share/man/man9/lockdestroy.9 (revision 79658) @@ -1,58 +1,58 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt LOCKDESTROY 9 .Os .Sh NAME .Nm lockdestroy .Nd "destroys a lock" .Sh SYNOPSIS .In sys/types.h .In sys/lockmgr.h .Ft int .Fn lockdestroy "struct lock *lkp" .Sh DESCRIPTION The .Fn lockdestroy function destroys the given lock. (Currently is does nothing!) .Pp Its argument is: -.Bl -tag -xwidth ".Fa lkp" +.Bl -tag -width ".Fa lkp" .It Fa lkp The lock to destroy. .El .Sh SEE ALSO .Xr lockcount 9 , .Xr lockmgr 9 , .Xr lockmgr_printinfo 9 , .Xr lockstatus 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/lockmgr.9 =================================================================== --- head/share/man/man9/lockmgr.9 (revision 79657) +++ head/share/man/man9/lockmgr.9 (revision 79658) @@ -1,155 +1,155 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt LOCKMGR 9 .Os .Sh NAME .Nm lockmgr .Nd "acquires, releases and updates locks" .Sh SYNOPSIS .In sys/types.h .In sys/lockmgr.h .Ft int .Fn lockmgr "struct lock *lkp" "u_int flags" "struct mtx *interlkp" "struct proc *p" .Sh DESCRIPTION The .Fn lockmgr function handles general locking functionality within the kernel, including support for shared and exclusive locks, and recursion. Locks can also be upgraded and downgraded. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa interlkp" +.Bl -tag -width ".Fa interlkp" .It Fa lkp A pointer to lock to manipulate. .It Fa flags Flags indicating what action is to be taken. -.Bl -tag -xwidth ".Dv LK_EXCLUPGRADE" +.Bl -tag -width ".Dv LK_EXCLUPGRADE" .It Dv LK_SHARED Aquire a shared lock. If we currently hold an exclusive lock it will be downgraded. .It Dv LK_EXCLUSIVE Aquire an exclusive lock. If we already hold an exclusive lock and .Dv LK_CANRECURSE is not set we will panic. .It Dv LK_DOWNGRADE Downgrade our exclusive lock to a shared lock. Downgrading a shared lock is not valid. If the exclusive lock has been recursed, all references will be downgraded. .It Dv LK_EXCLUPGRADE Upgrade our lock to an exclusive lock. Will fail with .Er EBUSY if there is someone ahead of use waiting for an upgrade. If this call fails we loose our shared lock. Upgrading an exclusive lock will cause a panic. .It Dv LK_UPGRADE Upgrades our lock to an exclusive lock. If this call fails we loose our shared lock. Upgrading an exclusive lock will cause a panic. .It Dv LK_RELEASE Release the lock. Releasing a lock that you do not hold can cause a panic. .It Dv LK_DRAIN Waits for all activity on the lock to end, and then marks it decommissioned. This is used before freeing a lock that is part of a piece of memory that is about to be freed. (As documented in .Pa sys/lockmgr.h . ) .It Dv LK_SLEEPFAIL If we had to sleep for the lock then fail. .It Dv LK_NOWAIT Do not allow the call to sleep. This can be used to test the lock. .It Dv LK_CANRECURSE It is ok to recurse on an exclusive lock. For every lock there must be a release. .It Dv LK_INTERLOCK Unlock the interlock, which is of course locked already. .El .It Fa interlkp An interlock mutex for controlling group access to the lock. If .Dv LK_INTERLOCK is specified, .Fn lockmgr assumes .Fa interlkp is currently owned and not recursed, and will return it unlocked. See .Xr mtx_assert 9 . .It Fa p The process responsible for this call. .Dv NULL becomes .Dv LK_KERNPROC . .El .Sh LOCKS If .Dv LK_INTERLOCK is specified then .Fa interlkp must be held prior to calling .Fn lockmgr and will be returned unlocked. .Pp Upgrade attempts that fail result in the loss of the lock that is currently held. As well, it is not valid to upgrade an exclusive lock, and a panic will be the result of trying. .Sh RETURN VALUES A value of 0 is returned on success. .Sh ERRORS .Bl -tag -width Er .It Bq Er EBUSY Either .Dv LK_NOWAIT was specified and .Fn lockmgr would have slept, or another process was ahead of you in line for an exclusive upgrade. .It Bq Er ENOLCK .Dv LK_SLEEP_FAIL was set and we slept. .El .Sh SEE ALSO .Xr lockcount 9 , .Xr lockdestroy 9 , .Xr lockmgr_printinfo 9 , .Xr lockstatus 9 , .Xr mutex 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/lockmgr_printinfo.9 =================================================================== --- head/share/man/man9/lockmgr_printinfo.9 (revision 79657) +++ head/share/man/man9/lockmgr_printinfo.9 (revision 79658) @@ -1,60 +1,60 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt LOCKMGR_PRINTINFO 9 .Os .Sh NAME .Nm lockmgr_printinfo .Nd "prints information about the lock" .Sh SYNOPSIS .In sys/types.h .In sys/lockmgr.h .Ft void .Fn lockmgr_printinfo "struct lock *lkp" .Sh DESCRIPTION The .Fn lockmgr_printinfo function prints information about the lock including the lock time and the wait count. .Pp Its argument is: -.Bl -tag -xwidth ".Fa lkp" +.Bl -tag -width ".Fa lkp" .It Fa lkp The lock to print. .El .Sh NOTES This function seems to only exist for debugging purposes. .Sh SEE ALSO .Xr lockcount 9 , .Xr lockdestroy 9 , .Xr lockmgr 9 , .Xr lockstatus 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/lockstatus.9 =================================================================== --- head/share/man/man9/lockstatus.9 (revision 79657) +++ head/share/man/man9/lockstatus.9 (revision 79658) @@ -1,83 +1,83 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt LOCKSTATUS 9 .Os .Sh NAME .Nm lockstatus .Nd "returns the lock status" .Sh SYNOPSIS .In sys/types.h .In sys/lockmgr.h .Ft int .Fn lockstatus "struct lock *lkp" "struct proc *p" .Sh DESCRIPTION The .Fn lockstatus function returns the status of the lock in relation to the .Vt proc passed to it. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa lkp" +.Bl -tag -width ".Fa lkp" .It Fa lkp The lock to return the status of. .It Fa p The process to check any exclusive locks against. If .Fa p is .Dv NULL and an exclusive lock is held, .Dv LK_EXCLUSIVE is returned. .El .Sh RETURN VALUES -.Bl -tag -xwidth ".Dv LK_EXCLUSIVE" +.Bl -tag -width ".Dv LK_EXCLUSIVE" .It Dv LK_EXCLUSIVE An exclusive lock is held by the process .Fa p passed in. .It Dv LK_EXCLOTHER An exclusive lock is held by someone other then the process .Fa p passed in. .It Dv LK_SHARED A shared lock is held. .It 0 The lock is not held by anyone. .El .Sh SEE ALSO .Xr lockcount 9 , .Xr lockdestroy 9 , .Xr lockmgr 9 , .Xr lockmgr_printinfo 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/major.9 =================================================================== --- head/share/man/man9/major.9 (revision 79657) +++ head/share/man/man9/major.9 (revision 79658) @@ -1,59 +1,59 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt MAJOR 9 .Os .Sh NAME .Nm major .Nd "returns the major number for the device" .Sh SYNOPSIS .In sys/systm.h .Ft int .Fn major "dev_t dev" .Sh DESCRIPTION The .Fn major function returns the major device number for the given device. .Pp Its argument is: -.Bl -tag -xwidth ".Fa dev" +.Bl -tag -width ".Fa dev" .It Fa dev The device whose major device number should be returned. .El .Sh RETURN VALUES An integer greater than zero and less than .Dv NUMCDEVSW , or .Dv NOUDEV if the device is invalid. .Sh SEE ALSO .Xr minor 9 .Sh AUTHORS This man page was written by .An Chad David . Index: head/share/man/man9/minor.9 =================================================================== --- head/share/man/man9/minor.9 (revision 79657) +++ head/share/man/man9/minor.9 (revision 79658) @@ -1,57 +1,57 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt MINOR 9 .Os .Sh NAME .Nm minor .Nd "returns the minor number for the device" .Sh SYNOPSIS .In sys/systm.h .Ft int .Fn minor "dev_t dev" .Sh DESCRIPTION The .Fn minor function returns the minor device number for the given device. .Pp Its argument is: -.Bl -tag -xwidth ".Fa dev" +.Bl -tag -width ".Fa dev" .It Fa dev The device whose minor device number should be returned. .El .Sh RETURN VALUES An integer greater than zero, or .Dv NOUDEV if the device is invalid. .Sh SEE ALSO .Xr major 9 .Sh AUTHORS This man page was written by .An Chad David . Index: head/share/man/man9/umajor.9 =================================================================== --- head/share/man/man9/umajor.9 (revision 79657) +++ head/share/man/man9/umajor.9 (revision 79658) @@ -1,58 +1,58 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt UMAJOR 9 .Os .Sh NAME .Nm umajor .Nd "returns the major number from the raw device number" .Sh SYNOPSIS .In sys/systm.h .Ft int .Fn umajor "udev_t dev" .Sh DESCRIPTION The .Fn umajor function returns the major device number form the given raw device number. .Pp Its argument is: -.Bl -tag -xwidth ".Fa dev" +.Bl -tag -width ".Fa dev" .It Fa dev The device number whose major ID should be calculated and returned. .El .Sh RETURN VALUES An integer greater than or equal to zero. .Sh SEE ALSO .Xr major 9 , .Xr minor 9 , .Xr uminor 9 .Sh AUTHORS This man page was written by .An Chad David . Index: head/share/man/man9/uminor.9 =================================================================== --- head/share/man/man9/uminor.9 (revision 79657) +++ head/share/man/man9/uminor.9 (revision 79658) @@ -1,58 +1,58 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt UMINOR 9 .Os .Sh NAME .Nm uminor .Nd "returns the minor number from the raw device number" .Sh SYNOPSIS .In sys/systm.h .Ft int .Fn uminor "udev_t dev" .Sh DESCRIPTION The .Fn uminor function returns the minor device number from the raw device number. .Pp Its argument is: -.Bl -tag -xwidth ".Fa dev" +.Bl -tag -width ".Fa dev" .It Fa dev The raw device number from which the minor device number should be calculated. .El .Sh RETURN VALUES An integer greater than or equal to zero. .Sh SEE ALSO .Xr major 9 , .Xr minor 9 , .Xr umajor 9 .Sh AUTHORS This man page was written by .An Chad David . Index: head/share/man/man9/vfs_busy.9 =================================================================== --- head/share/man/man9/vfs_busy.9 (revision 79657) +++ head/share/man/man9/vfs_busy.9 (revision 79658) @@ -1,103 +1,103 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 8, 2001 .Dt VFS_BUSY 9 .Os .Sh NAME .Nm vfs_busy .Nd "marks a mount point as busy" .Sh SYNOPSIS .In sys/param.h .In sys/mount.h .Ft int .Fn vfs_busy "struct mount *mp" "int flags" "struct mtx *interlkp" "struct proc *p" .Sh DESCRIPTION The .Fn vfs_busy function marks a mount point as busy. The purpose of this function is to synchronize access to a mount point. It also delays unmounting by sleeping on .Fa mp if the .Dv MNTK_UNMOUNT flag is set in .Fa mp->mnt_kern_flag and the .Dv LK_NOWAIT flag is .Em not set. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa interlkp" +.Bl -tag -width ".Fa interlkp" .It Fa mp The mount point to busy. .It Fa flags Flags controlling how .Fn vfs_busy should act. -.Bl -tag -xwidth ".Dv LK_NOWAIT" +.Bl -tag -width ".Dv LK_NOWAIT" .It Dv LK_NOWAIT do not sleep if .Dv MNTK_UNMOUNT is set. .El .It Fa interlkp The interlock mutex for .Fa mp->mount_lock . If there is any chance the mount point is being unmounted and .Dv LK_NOWAIT is not set then interlock must be valid locked mutex. .It Fa p The process responsible for this call. .El .Sh LOCKS If .Fa interlkp is a valid pointer it must be locked on entry, and it will not be unlocked even in the case of an error. .Sh RETURN VALUES A 0 value is returned on success. If the mount point is being unmounted .Er ENOENT will always be returned. .Sh ERRORS .Bl -tag -width Er .It Bq Er ENOENT The mount point is being unmounted .Dv ( MNTK_UNMOUNT is set). .El .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/vfs_mount.9 =================================================================== --- head/share/man/man9/vfs_mount.9 (revision 79657) +++ head/share/man/man9/vfs_mount.9 (revision 79658) @@ -1,129 +1,129 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 8, 2001 .Dt VFS_MOUNT 9 .Os .Sh NAME .Nm vfs_mount .Nd "generic filesystem mount function" .Sh SYNOPSIS .In sys/param.h .In sys/mount.h .Ft int .Fn vfs_mount "struct proc *p" "char *fstype" "char *fspath" "int fsflags" "void *fsdata" .Sh DESCRIPTION The .Fn vfs_mount function handles the generic portion of mounting a filesystem, and calls the filesystem specific mount function after verifying its parameters and setting up the structures expected by the underlying mount code. .Pp .Fn vfs_mount is called directly by the .Xr mount 2 system call. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa fsflags" +.Bl -tag -width ".Fa fsflags" .It Fa p The process responsible for this call. .It Fa fstype The type of filesystem being mounted. .It Fa fspath The path to the mount point of the filesystem. .It Fa fsflags Flags controlling the mount. See .Xr mount 2 for details. .Pp .Dv MNT_EXPORTED , MNT_NOSUID , MNT_NODEV , MNT_UPDATE , MNT_RELOAD , .Dv MNT_FORCE , MNT_ASYNC , MNT_SYNCHRONOUS , MNT_UNION , MNT_NOATIME , .Dv MNT_SNAPSHOT , MNT_NOCLUSTERR , MNT_NOCLUSTERW , MNT_IGNORE , .Dv MNT_UNION , MNT_NOSYMFOLLOW .It Fa fsdata Filesystem specific data structure. It is in userspace when passed to .Fn vfs_mount and is left untouched when passed to filesystem's .Fn mount . .El .Sh RETURN VALUES A 0 value is returned on success. .Sh ERRORS .Bl -tag -width Er .It Bq Er ENAMETOOLONG The fs type or the mount point path is too long or any individual path component is too long. .It Bq Er EPERM Permission denied. There are a number of reason this can occur ranging from the user not having permission to mount a filesystem to the securelevel being to high to load the .Fa fstype module. .It Bq Er EINVAL Invalid operation (ex: trying to update a non mount-point). .It Bq Er ENOENT The mount point does not exist (from .Fn namei ) . .It Bq Er ELOOP The mount point is a muddle of links (from .Fn namei ) . .It Bq Er EOPNOTSUPP The operation is not supported (ex: reloading a r/w filesystem). .It Bq Er EBUSY The mount point is busy or is not really a mount point (on update). .It Bq Er ENOTDIR The mount point is not a directory. .It Bq Er ENODEV The kernel linker was unable to load the specified .Fa fstype or was unable to find the specified .Fa fstype module. .El .Pp Other errors can be returned by the filesystem's .Fn mount and you should check the specific filesystem for details. Also this call relies on a large number of other kernel services whose errors it returns so this list may not be exhaustive. .Sh SEE ALSO .Xr mount 2 , .Xr mount 8 .Pp .Va vfs.usermount .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/vfs_unbusy.9 =================================================================== --- head/share/man/man9/vfs_unbusy.9 (revision 79657) +++ head/share/man/man9/vfs_unbusy.9 (revision 79658) @@ -1,66 +1,66 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 8, 2001 .Dt VFS_UNBUSY 9 .Os .Sh NAME .Nm vfs_unbusy .Nd "unbusy a mount point" .Sh SYNOPSIS .In sys/param.h .In sys/mount.h .Ft void .Fn vfs_unbusy "struct mount *mp" "struct proc *p" .Sh DESCRIPTION The .Fn vfs_unbusy function unbusies a mount point by unlocking .Fa mp->mnt_lock . The lock is typically aquired by calling .Xr vfs_busy 9 prior to this call. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa mp" +.Bl -tag -width ".Fa mp" .It Fa mp The mount point to unbusy (unlock). .It Fa p The process responsible for this call. .El .Sh LOCKS .Va mnt_lock must be locked in .Fa mp prior to calling this function, and it will be unlocked upon return. .Sh SEE ALSO .Xr vfs_busy 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/vinvalbuf.9 =================================================================== --- head/share/man/man9/vinvalbuf.9 (revision 79657) +++ head/share/man/man9/vinvalbuf.9 (revision 79658) @@ -1,121 +1,121 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 7, 2001 .Dt VINVALBUF 9 .Os .Sh NAME .Nm vinvalbuf .Nd "flushes and invalidates all buffers associated with a vnode" .Sh SYNOPSIS .In sys/param.h .In sys/vnode.h .Ft int .Fn vinvalbuf "struct vnode *vp" "int flags" "struct ucred *cred" "struct proc *p" "int slpflag" "int slptimeo" .Sh DESCRIPTION The .Fn vinvalbuf function invalidates all of the buffers associated with the given vnode. This includes buffers on the clean list and the dirty list. If the .Dv V_SAVE flag is specified then the buffers on the dirty list are synced prior to being released. If there is a VM Object associated with the vnode, it is removed. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa spltimeo" +.Bl -tag -width ".Fa spltimeo" .It Fa vp A pointer to the vnode whose buffers will be invalidated. .It Fa flags The only supported flag is .Dv V_SAVE and it indicates that dirty buffers should be synced with the disk. .It Fa cred The user credentials that are used to .Xr VOP_FSYNC 9 buffers if .Dv V_SAVE is set. .It Fa p The process responsible for this call. .It Fa slpflag The slp flag that will be used in the priority of any sleeps in the function. .It Fa slptimeo The timeout for any sleeps in the function. .El .Sh LOCKS The vnode is assumed to be locked prior to the call and remains locked upon return. .Pp .Va Giant must be held by prior to the call and remains locked upon return. .Sh RETURN VALUES A 0 value is returned on success. .Sh PSEUDOCODE .Bd -literal -offset indent vn_lock(devvp, LK_EXCLUSIVE | LK_RETRY, p); error = vinvalbuf(devvp, V_SAVE, cred, p, 0, 0); VOP_UNLOCK(devvp, 0, p); if (error) return (error); .Ed .Sh ERRORS .Bl -tag -width Er .It Bq Er ENOSPC The filesystem is full. (With .Dv V_SAVE ) .It Bq Er EDQUOT Disc quota exceeded. (With .Dv V_SAVE ) .It Bq Er EWOULDBLOCK Sleep operation timed out. (See .Fa slptimeo ) .It Bq Er ERESTART A signal needs to be delivered and the system call should be restarted. (With .Dv PCATCH set in .Fa slpflag ) .It Bq Er EINTR The system has been interrupted by a signal. (With .Dv PCATCH set in .Fa slpflag ) .El .Sh SEE ALSO .Xr brelse 9 , .Xr bremfree 9 , .Xr tsleep 9 , .Xr VOP_FSYNC 9 .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/share/man/man9/vn_isdisk.9 =================================================================== --- head/share/man/man9/vn_isdisk.9 (revision 79657) +++ head/share/man/man9/vn_isdisk.9 (revision 79658) @@ -1,73 +1,73 @@ .\" .\" Copyright (C) 2001 Chad David . 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(s), this list of conditions and the following disclaimer as .\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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$ .\" .Dd July 9, 2001 .Dt VN_ISDISK 9 .Os .Sh NAME .Nm vn_isdisk .Nd "checks if a vnode represents a disk" .Sh SYNOPSIS .In sys/param.h .In sys/vnode.h .Ft int .Fn vn_isdisk "struct vnode *vp" "int *errp" .Sh DESCRIPTION The .Fn vn_isdisk function checks to see if .Fa vp represents a disk. In order for .Fa vp to be a disk, it must be a character device, .Va v_rdev must be valid, and the .Vt cdevsw entry's .Va flags must have .Dv D_DISK set. .Pp Its arguments are: -.Bl -tag -xwidth ".Fa errp" +.Bl -tag -width ".Fa errp" .It Fa vp The vnode to check. .It Fa errp An integer pointer to store the error number in if the call fails. .El .Sh RETURN VALUES If the vnode represents a disk, 1 is returned; otherwise, 0 is returned and .Fa errp will contain the error number. .Sh AUTHORS This man page was written by .An Chad David Aq davidc@acns.ab.ca . Index: head/usr.bin/nl/nl.1 =================================================================== --- head/usr.bin/nl/nl.1 (revision 79657) +++ head/usr.bin/nl/nl.1 (revision 79658) @@ -1,242 +1,242 @@ .\" $FreeBSD$ .\" .\" Copyright (c) 1999 The NetBSD Foundation, Inc. .\" All rights reserved. .\" .\" This code is derived from software contributed to The NetBSD Foundation .\" by Klaus Klein. .\" .\" 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 acknowledgement: .\" This product includes software developed by the NetBSD .\" Foundation, Inc. and its contributors. .\" 4. Neither the name of The NetBSD Foundation nor the names of its .\" contributors may be used to endorse or promote products derived .\" from this software without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" .Dd February 15, 1999 .Dt NL 1 .Os .Sh NAME .Nm nl .Nd line numbering filter .Sh SYNOPSIS .Nm .Op Fl p .Bk -words .Op Fl b Ar type .Ek .Bk -words .Op Fl d Ar delim .Ek .Bk -words .Op Fl f Ar type .Ek .Bk -words .Op Fl h Ar type .Ek .Bk -words .Op Fl i Ar incr .Ek .Bk -words .Op Fl l Ar num .Ek .Bk -words .Op Fl n Ar format .Ek .Bk -words .Op Fl s Ar sep .Ek .Bk -words .Op Fl v Ar startnum .Ek .Bk -words .Op Fl w Ar width .Ek .Op Ar file .Sh DESCRIPTION The .Nm utility reads lines from the named .Ar file or the standard input if the .Ar file argument is ommitted, applies a configurable line numbering filter operation and writes the result to the standard output. .Pp The .Nm utility treats the text it reads in terms of logical pages. Unless specified otherwise, line numbering is reset at the start of each logical page. A logical page consists of a header, a body and a footer section; empty sections are valid. Different line numbering options are independently available for header, body and footer sections. .Pp The starts of logical page sections are signalled by input lines containing nothing but one of the following sequences of delimiter characters: .Pp .Bl -column "\e:\e:\e:" "Start of" -offset indent .Em "Line Start of" .It "\e:\e:\e: header" .It "\e:\e: body" .It "\e: footer" .El .Pp If the input does not contain any logical page section signalling directives, the text being read is assumed to consist of a single logical page body. .Pp The following options are available: -.Bl -tag -xwidth ".Fl v Ar startnum" +.Bl -tag -width ".Fl v Ar startnum" .It Fl b Ar type Specify the logical page body lines to be numbered. Recognized .Ar type arguments are: .Bl -tag -width indent .It Cm a Number all lines. .It Cm t Number only non-empty lines. .It Cm n No line numbering. .It Cm p Ns Ar expr Number only those lines that contain the basic regular expression specified by .Ar expr . .El .Pp The default .Ar type for logical page body lines is .Cm t . .It Fl d Ar delim Specify the delimiter characters used to indicate the start of a logical page section in the input file. At most two characters may be specified; if only one character is specified, the first character is replaced and the second character remains unchanged. The default .Ar delim characters are .Dq Li \e: . .It Fl f Ar type Specify the same as .Fl b Ar type except for logical page footer lines. The default .Ar type for logical page footer lines is .Cm n . .It Fl h Ar type Specify the same as .Fl b Ar type except for logical page header lines. The default .Ar type for logical page header lines is .Cm n . .It Fl i Ar incr Specify the increment value used to number logical page lines. The default .Ar incr value is 1. .It Fl l Ar num If numbering of all lines is specified for the current logical section using the corresponding .Fl b Cm a , .Fl f Cm a or .Fl h Cm a option, specify the number of adjacent blank lines to be considered as one. For example, .Fl l 2 results in only the second adjacent blank line being numbered. The default .Ar num value is 1. .It Fl n Ar format Specify the line numbering output format. Recognized .Ar format arguments are: .Bl -tag -width indent -compact .It Cm ln Left justified. .It Cm rn Right justified, leading zeros suppressed. .It Cm rz Right justified, leading zeros kept. .El .Pp The default .Ar format is .Cm rn . .It Fl p Specify that line numbering should not be restarted at logical page delimiters. .It Fl s Ar sep Specify the characters used in separating the line number and the corresponding text line. The default .Ar sep setting is a single tab character. .It Fl v Ar startnum Specify the initial value used to number logical page lines; see also the description of the .Fl p option. The default .Ar startnum value is 1. .It Fl w Ar width Specify the number of characters to be occupied by the line number; in case the .Ar width is insufficient to hold the line number, it will be truncated to its .Ar width least significant digits. The default .Ar width is 6. .El .Sh DIAGNOSTICS The .Nm utility exits 0 on success, and >0 if an error occurs. .Sh SEE ALSO .Xr pr 1 .Sh STANDARDS The .Nm utility conforms to .St -xpg4.2 with the exception of not supporting the intermingling of the .Ar file operand with the options, which the standard considers an obsolscent feature to be removed from a further issue. .Sh HISTORY The .Nm utility first appeared in .At V.2 . Index: head/usr.sbin/digictl/digictl.8 =================================================================== --- head/usr.sbin/digictl/digictl.8 (revision 79657) +++ head/usr.sbin/digictl/digictl.8 (revision 79658) @@ -1,118 +1,118 @@ .\" $FreeBSD$ .Dd June 20, 2001 .Dt DIGICTL 8 .Os .Sh NAME .Nm digictl .Nd control .Tn Digiboard devices .Sh SYNOPSIS .Nm .Fl a .Cm disable | enable | query .Ar device ... .Nm .Op Fl d Ar debug .Op Fl ir .Ar ctrl-device ... .Sh DESCRIPTION The .Nm program provides control of the .Tn Digiboard installed with the given .Ar ctrl-device name and provides control of individual digiboard .Ar devices . A digiboard .Ar ctrl-device is usually of the form .Sm off .Pa /dev/digi Ar N Pa .ctl .Sm on where .Ar N is the card number and starts at .Dq 0 for the first attached card. A digiboard .Ar device is usually of the form .Sm off .Pa /dev/cua Oo Pa il Oc Pa D Ar N Pa \&. Ar P .Sm on or .Sm off .Pa /dev/tty Oo Pa il Oc Pa D Ar N Pa \&. Ar P .Sm on where .Ar N is the card number and .Ar P is the port number. .Pp The following flags are recognized: .Bl -tag .It Fl a Cm disable | enable | query Disable, enable or query the .Em ALTPIN settings for the given port(s). .Pp When ALTPIN is enabled, the CD and DSR lines are logically reversed. This is useful when wiring serial ports to an 8 way RJ45 cable (full 10 way RJ45 cables are quite rare). .Pp A single ALTPIN setting applies to both of the callout and callin devices. .It Fl d Ar debug If the driver has been compiled with .Dv DEBUG defined, the following bits from the .Ar debug variable are used to enable diagnostics in the digiboard driver: -.Bl -tag -xwidth ".No 1024 ( Em MODEM )" +.Bl -tag -width ".No 1024 ( Em MODEM )" .It 1 ( Em INIT ) Diagnostics during card attach, detach and initialization. .It 2 ( Em OPEN ) Diagnostics when opening a port. .It 4 ( Em CLOSE ) Diagnostics when closing a port. .It 8 ( Em SET ) Diagnostics when setting tty device flags. .It 16 ( Em INT ) Diagnostics when processing card events. .It 32 ( Em READ ) Reports return values from port reads. .It 64 ( Em WRITE ) Reports return values from port writes. .It 128 ( Em RX ) Reports receive queue flow control. .It 256 ( Em TX ) Reports transmit queue flow control. .It 512 ( Em IRQ ) Diagnostics during interrupts (enable these with care). .It 1024 ( Em MODEM ) Diagnostics when setting modem status flags. .It 2048 ( Em RI ) Reports when a RING is received. .El .It Fl i Display the card identification string and type ID. .It Fl r Reinitialize the card. For boards with external port modules, it is possible to add or remove modules and dynamically reprobe the number of ports using this switch. All ports on the card must be closed in order to reinitialize the card. .Pp It is preferable to reinitialize the card rather than reload the entire digi module as reinitialization only affects the specified board rather than affecting all attached boards. .El .Sh BUGS It should be possible to reinitialize a board without closing all of the existing ports. .Sh HISTORY The .Nm command first appeared in .Fx 5.0 .