pause.rst 822 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. .. SPDX-License-Identifier: GPL-2.0-or-later:
  2. pause command
  3. =============
  4. Synopsis
  5. --------
  6. ::
  7. pause [prompt]
  8. Description
  9. -----------
  10. The pause command delays execution waiting for any user input.
  11. It can accept a single parameter to change the prompt message.
  12. Examples
  13. --------
  14. Using with the default prompt:
  15. ::
  16. => pause
  17. Press any key to continue...
  18. Using with a custom prompt:
  19. ::
  20. => pause 'Prompt for pause...'
  21. Prompt for pause...
  22. Note that complex prompts require proper quoting:
  23. ::
  24. => pause Prompt for pause...
  25. pause - delay until user input
  26. Usage:
  27. pause [prompt] - Wait until users presses any key. [prompt] can be used to customize the message.
  28. Return value
  29. ------------
  30. The return value $? is always set to 0 (true), unless invoked in an invalid
  31. manner.