Skip to content

Add documentation for BELL signal #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clue merged 1 commit into from
Aug 18, 2019
Merged

Add documentation for BELL signal #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ without requiring any extensions or special installation.
* [History](#history)
* [Autocomplete](#autocomplete)
* [Keys](#keys)
* [Bell](#bell)
* [Readline](#readline)
* [Pitfalls](#pitfalls)
* [Install](#install)
Expand Down Expand Up @@ -534,6 +535,23 @@ $stdio->on("\033[A", function () use ($stdio) {
});
```

#### Bell

By default, this project will emit a audible/visible BELL signal when the user
tries to execute an otherwise disabled function, such as using the
<kbd>left</kbd> or <kbd>backspace</kbd> keys when already at the beginning of the line.

Whether or not the BELL is audible/visible depends on the termin and its
settings, i.e. some terminals may "beep" or flash the screen or emit a short
vibration.

The `setBell(bool $bell): void` method can be used to
enable or disable emitting the BELL signal when using a disabled function:

```php
$stdio->setBell(false);
```

### Readline

The deprecated `Readline` class is responsible for reacting to user input and
Expand Down