freebsd-skq/usr.bin/mesg/mesg.1

.\" Copyright (c) 1987, 1990, 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. 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.
.\"
.\"	@(#)mesg.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd May 5, 2002
.Dt MESG 1
.Os
.Sh NAME
.Nm mesg
.Nd display (do not display) messages from other users
.Sh SYNOPSIS
.Nm
.Op Cm n | Cm y
.Sh DESCRIPTION
The
.Nm
utility is invoked by a user to control write access others
have to a terminal device.
Write access is allowed by default, and programs such as
.Xr talk 1
and
.Xr write 1
may display messages on the terminal.
.Pp
The first terminal device in the sequence of devices associated with standard
input, standard output and standard error is affected.
.Pp
The following options are available:
.Bl -tag -width indent
.It Cm n
Disallow messages.
.It Cm y
Permit messages to be displayed.
.El
.Pp
If no arguments are given,
.Nm
displays the present message status to the standard output.
.Sh EXIT STATUS
The
.Nm
utility exits with one of the following values:
.Pp
.Bl -tag -width flag -compact -offset indent
.It Li "\ 0"
Messages are allowed.
.It Li "\ 1"
Messages are not allowed.
.It Li ">1"
An error has occurred.
.El
.Sh EXAMPLES
Disallow messages from other users to the current terminal:
.Pp
.Dl "mesg n"
.Pp
Allow messages from other users to
.Pa ttyp1
(assuming you are also logged in on that terminal):
.Pp
.Dl "mesg y </dev/ttyp1"
.Sh COMPATIBILITY
Previous versions of the
.Nm
utility wrote the message status to the standard error output and
affected the terminal attached to standard error without first trying the
standard input or output devices.
.Sh SEE ALSO
.Xr biff 1 ,
.Xr talk 1 ,
.Xr wall 1 ,
.Xr write 1
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2001 .
.Sh HISTORY
A
.Nm
command appeared in
.At v1 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1987, 1990, 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.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" 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.`
			`.\"`
			`.\" @(#)mesg.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Affect the first of stdin, stdout and stderr that is attached to a terminal. Write status information to stdout instead of stderr. Exit status when an error occurs musn't be 1, that is reserved for indicating that messages are disabled. These changes bring mesg(1) up to SUSv3 conformance. Reviewed by: mike 2002-05-06 04:33:04 +00:00			`.Dd May 5, 2002`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt MESG 1`
			`.Os`
			`.Sh NAME`
			`.Nm mesg`
			`.Nd display (do not display) messages from other users`
			`.Sh SYNOPSIS`
Add usage(). 1997-07-24 07:00:17 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Cm n \| Cm y`
			`.Sh DESCRIPTION`
			`The`
Add usage(). 1997-07-24 07:00:17 +00:00			`.Nm`
Affect the first of stdin, stdout and stderr that is attached to a terminal. Write status information to stdout instead of stderr. Exit status when an error occurs musn't be 1, that is reserved for indicating that messages are disabled. These changes bring mesg(1) up to SUSv3 conformance. Reviewed by: mike 2002-05-06 04:33:04 +00:00			`utility is invoked by a user to control write access others`
			`have to a terminal device.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Write access is allowed by default, and programs such as`
			`.Xr talk 1`
			`and`
			`.Xr write 1`
			`may display messages on the terminal.`
			`.Pp`
Affect the first of stdin, stdout and stderr that is attached to a terminal. Write status information to stdout instead of stderr. Exit status when an error occurs musn't be 1, that is reserved for indicating that messages are disabled. These changes bring mesg(1) up to SUSv3 conformance. Reviewed by: mike 2002-05-06 04:33:04 +00:00			`The first terminal device in the sequence of devices associated with standard`
			`input, standard output and standard error is affected.`
			`.Pp`
Introduce options definition the standard way. 2003-06-09 19:32:02 +00:00			`The following options are available:`
			`.Bl -tag -width indent`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Cm n`
Introduce options definition the standard way. 2003-06-09 19:32:02 +00:00			`Disallow messages.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Cm y`
Introduce options definition the standard way. 2003-06-09 19:32:02 +00:00			`Permit messages to be displayed.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.El`
			`.Pp`
			`If no arguments are given,`
Add usage(). 1997-07-24 07:00:17 +00:00			`.Nm`
Affect the first of stdin, stdout and stderr that is attached to a terminal. Write status information to stdout instead of stderr. Exit status when an error occurs musn't be 1, that is reserved for indicating that messages are disabled. These changes bring mesg(1) up to SUSv3 conformance. Reviewed by: mike 2002-05-06 04:33:04 +00:00			`displays the present message status to the standard output.`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The`
Add usage(). 1997-07-24 07:00:17 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility exits with one of the following values:`
			`.Pp`
mdoc: make pages render with mandoc It's a bit more pedantic regarding .Bl list elements. This has an added benefit of unbreaking the ipfw(8) manpage, where groff was silently skipping one list element. 2010-10-21 12:27:13 +00:00			`.Bl -tag -width flag -compact -offset indent`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Li "\ 0"`
			`Messages are allowed.`
			`.It Li "\ 1"`
			`Messages are not allowed.`
The text describing exit values >1 was formatted incorrectly. Obtained from: NetBSD-bugs PR# 3406 1997-03-29 20:01:59 +00:00			`.It Li ">1"`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`An error has occurred.`
			`.El`
Sort sections. 2005-01-18 13:43:56 +00:00			`.Sh EXAMPLES`
			`Disallow messages from other users to the current terminal:`
			`.Pp`
			`.Dl "mesg n"`
			`.Pp`
			`Allow messages from other users to`
			`.Pa ttyp1`
			`(assuming you are also logged in on that terminal):`
			`.Pp`
			`.Dl "mesg y </dev/ttyp1"`
Affect the first of stdin, stdout and stderr that is attached to a terminal. Write status information to stdout instead of stderr. Exit status when an error occurs musn't be 1, that is reserved for indicating that messages are disabled. These changes bring mesg(1) up to SUSv3 conformance. Reviewed by: mike 2002-05-06 04:33:04 +00:00			`.Sh COMPATIBILITY`
			`Previous versions of the`
			`.Nm`
			`utility wrote the message status to the standard error output and`
			`affected the terminal attached to standard error without first trying the`
			`standard input or output devices.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SEE ALSO`
			`.Xr biff 1 ,`
			`.Xr talk 1 ,`
Add xref to wall(1). PR: docs/32128 Submitted by: Gerald Pfeifer <pfeifer@dbai.tuwien.ac.at> (partially) 2001-11-20 15:39:58 +00:00			`.Xr wall 1 ,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Xr write 1`
Affect the first of stdin, stdout and stderr that is attached to a terminal. Write status information to stdout instead of stderr. Exit status when an error occurs musn't be 1, that is reserved for indicating that messages are disabled. These changes bring mesg(1) up to SUSv3 conformance. Reviewed by: mike 2002-05-06 04:33:04 +00:00			`.Sh STANDARDS`
			`The`
			`.Nm`
			`utility conforms to`
			`.St -p1003.1-2001 .`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
			`A`
Add usage(). 1997-07-24 07:00:17 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`command appeared in`
[HISTORY] command appeared in Version 1 AT&T UNIX Obtained from: A Quarter Century of UNIX, Peter H. Salus, page 41 1996-08-29 18:06:19 +00:00			`.At v1 .`