1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-08-03 22:15:42 +02:00

style-guide: give instructions on sudo usage (#17087)

Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
This commit is contained in:
Managor 2025-07-03 11:28:51 +03:00 committed by GitHub
parent e690c3cf7b
commit 617bae7d16
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -313,6 +313,8 @@ Use backticks on the following:
When describing keycaps or a keyboard shortcut for a utility, use the same [keypress syntax](#keypress-syntax) as in example commands. Make sure to enclose it in backticks so that it is not invisible in markdown renderers (i.e. ``Print the last lines of a given file and keep reading it until `<Ctrl c>`:``).
If a program requires root privileges to run and doesn't provide its own prompt for a password, prepend the command with `sudo` (e.g. `sudo apt update`).
## Heading
### Program description