X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_beep.3x;h=be18f910ea60432be23e113e5f9cd61df0b99776;hb=d79ff7b4d5f5ac63e7d9d7e76706d95a1ddb243c;hp=579931ccc47f64a5c9c41ec368034b38559b6c49;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;p=ncurses.git diff --git a/man/curs_beep.3x b/man/curs_beep.3x index 579931cc..be18f910 100644 --- a/man/curs_beep.3x +++ b/man/curs_beep.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2003 Free Software Foundation, Inc. * +.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 1998-2005,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,38 +27,35 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_beep.3x,v 1.9 2003/12/27 18:44:30 tom Exp $ -.TH curs_beep 3X "" +.\" $Id: curs_beep.3x,v 1.17 2021/12/25 21:41:58 tom Exp $ +.TH curs_beep 3X 2021-12-25 "ncurses 6.4" "Library calls" .SH NAME -\fBbeep\fR, \fBflash\fR - \fBcurses\fR bell and screen flash routines +\fBbeep\fP, \fBflash\fP \- \fBcurses\fP bell and screen flash routines .SH SYNOPSIS -\fB#include \fR +\fB#include \fP .PP -\fBint beep(void);\fR +\fBint beep(void);\fP .br -\fBint flash(void);\fR +\fBint flash(void);\fP .br .SH DESCRIPTION -The \fBbeep\fR and \fBflash\fR routines are used to alert the terminal user. -The routine \fBbeep\fR sounds an audible alarm on the terminal, if possible; -otherwise it flashes the screen (visible bell). The routine \fBflash\fR -flashes the screen, and if that is not possible, sounds the alert. If neither -alert is possible, nothing happens. Nearly all terminals have an audible alert +The \fBbeep\fP and \fBflash\fP routines are used to alert the terminal user. +The routine \fBbeep\fP sounds an audible alarm on the terminal, if possible; +otherwise it flashes the screen (visible bell). +The routine \fBflash\fP +flashes the screen, and if that is not possible, sounds the alert. +If neither +alert is possible, nothing happens. +Nearly all terminals have an audible alert (bell or beep), but only some can flash the screen. .SH RETURN VALUE -These routines return \fBOK\fR if they succeed in beeping or flashing, -\fBERR\fR otherwise. +These routines return \fBOK\fP if they succeed in beeping or flashing, +\fBERR\fP otherwise. .SH EXTENSIONS -SVr4's beep and flash routines always returned \fBOK\fR, so it was not +SVr4's beep and flash routines always returned \fBOK\fP, so it was not possible to tell when the beep or flash failed. .SH PORTABILITY -These functions are defined in the XSI Curses standard, Issue 4. Like SVr4, it -specifies that they always return \fBOK\fR. +These functions are described in the XSI Curses standard, Issue 4. +Like SVr4, it specifies that they always return \fBOK\fP. .SH SEE ALSO -\fBcurses\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fP(3X)