RUSH(1)

✨ RUSH(1) ✨ — the Rush User Reference, bestie edition 🫶

okay so. before we even get into it: this is the manual page for rush, from the Rush User Reference. she's a restricted user shell and she's lowkey iconic. let's go 💅

---

🌸 NAME 🌸

rush — restricted user shell

---

🎀 SYNOPSIS 🎀

rush [-ht] [-C CHECK] [-D ATTR[,ATTR...]] [-c COMMAND] [-d NUMBER] [-i]
[-u USER] [--debug NUMBER] [--dump=ATTR[,ATTR...]] [--help]
[--show-default] [--usage] [--version] [FILE]

---

💖 NOTE 💖

ngl, this manpage is just a short description of GNU rush. if you want the whole detailed discussion — examples, usage recommendations, the whole main character arc — you gotta go read the manual GNU Rush -- a restricted user shell, which comes in texinfo format. 📖

if the info reader and the rush docs are properly installed on your system, this command:

info rush

should hand you the complete manual. slay.

you can also read the manual using the info mode in emacs(1), or find it in various formats online at:

http://www.gnu.org.ua/software/rush/manual

⚠️ real talk though: if there are any discrepancies between this manpage and the Manual, the Manual wins. it's the authoritative source, periodt.

---

🌈 DESCRIPTION 🌈

GNU rush is a restricted user shell 💜 — designed for sites that give limited remote access to their resources, like svn or git repositories, scp, or the like.

when it starts up, rush analyzes its command line and examines the set of configuration rules to figure out what kind of access the user is gonna be granted. vibe check on the whole situation, basically. ✨

---

💅 OPTIONS 💅

• -d, --debug=NUMBER — sets the debugging level. the greater the NUMBER, the more verbose the logging gets. the debugging info gets reported via syslog(3) using authpriv, priority debug. the maximum meaningful value for NUMBER is 3. so like, don't get too ambitious.
• -D, --dump=ATTR[,ATTR...] — requests dump mode. the arguments are the names of the attributes to be dumped, or the word all, which stands for all attributes. go check the GNU Rush manual for a detailed description, iykyk.
• -t, --test, --lint — runs in test mode. when this option is given, the following happens, in order:
  1. all diagnostic messages are redirected to standard error, instead of syslog.
  2. if a single non-option argument is present, it's taken as a name of the configuration file to use.
  3. the configuration file is parsed. if parsing fails, the program exits with the code 1.
  4. if the -c option is present, rush processes its argument as usual, except that the command itself is not executed.
• -u, --user=NAME — supplies user name for use with --test.
• -c COMMAND — execute COMMAND.
• -C, --security-check=CHECK — add or remove configuration security check. the argument is one of the following:
  • all — enable all checks.
  • owner — check if the file is owned by root.
  • iwgrp, groupwritablefile — check if the file is not group writable.
  • iwoth, worldwritablefile — check if the file is not world writable.
  • dir_iwgrp, groupwritabledir — check if the directory where the file resides is not group writable.
  • dir_iwoth, worldwritabledir — check if the directory where the file resides is not world writable.
  • link — check if the file is not a symbolic link to a file residing in a group or world writable directory.
• -i — emulate interactive access. use this option to test whether and how your configuration allows interactive access. 🦋
• --show-default — show default configuration.

---

👑 SEE ALSO 👑

rush.rc(5), rushlast(1), rushwho(1).

---

🍓 AUTHORS 🍓

Sergey Poznyakoff

---

🙈 BUG REPORTS 🙈

report bugs to <bug-rush@gnu.org.ua>.

---

💀 COPYRIGHT 💀

Copyright © 2016 Sergey Poznyakoff
License GPLv3+: GNU GPL version 3 or later
<http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

---

okay and that's the whole page, bestie!! 🎀 this was RUSH, from the Rush User Reference — August 20, 2016, version vibes courtesy of the Rush page itself. go forth and restrict some shells responsibly 💖✨🫶