summaryrefslogtreecommitdiff
path: root/doc/usage/cmd/pause.rst
blob: b55825f5d93acc4f2c8dcbdfbfd31b19c1db9292 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
.. SPDX-License-Identifier: GPL-2.0-or-later:

.. index::
   single: pause (command)

pause command
=============

Synopsis
--------

::

    pause [prompt]


Description
-----------

The pause command delays execution waiting for any user input.

It can accept a single parameter to change the prompt message.

Examples
--------

Using with the default prompt:

::

    => pause
    Press any key to continue...


Using with a custom prompt:

::

    => pause 'Prompt for pause...'
    Prompt for pause...

Note that complex prompts require proper quoting:

::

    => pause Prompt for pause...
    pause - delay until user input
    
    Usage:
    pause [prompt] - Wait until users presses any key. [prompt] can be used to customize the message.