view scripts/io/beep.m @ 20352:2ec049e50ed8 stable

doc: Fix backslash characters in docstrings * utils.cc (Fisindex), beep.m: Use @xbackslashchar to produce backslashes in docstrings consistently and be compatible with Texinfo 6.
author Mike Miller <mtmiller@octave.org>
date Thu, 09 Jul 2015 21:44:09 -0400
parents 03b9d17a2d95
children
line wrap: on
line source

## Copyright (C) 2003-2015 John W. Eaton
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {} beep ()
## Produce a beep from the speaker (or visual bell).
##
## This function sends the alarm character @qcode{"@xbackslashchar{}a"} to
## the terminal. Depending on the user's configuration this may produce an
## audible beep, a visual bell, or nothing at all.
## @seealso{puts, fputs, printf, fprintf}
## @end deftypefn

## Author: jwe

function beep ()

  if (nargin != 0)
    print_usage ();
  endif

  puts ("\a");

endfunction


%!error (beep (1))