RUSH(8)

📦
version 2.4 · 2 versions
  • 2.4 · debian trixie, epel 10, epel 9, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 2.3 · debian bookworm, ubuntu noble
, in debian trixie, epel 10, epel 9, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 RUSH(8) — Rush User Reference 💖

okay bestie, gather round, because this is the manual page for rush — restricted user shell — and it's genuinely iconic. it lives in section 8 of the manual, and yes we're doing the whole thing, no skimming, no cap. 🫶

✨ SYNOPSIS ✨

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

📢 NOTE 📢

this manpage is just a short description of GNU rush, bestie. it is not the whole story.

for the detailed discussion — like, examples and usage recommendations and everything — you want 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 it via info mode in emacs(1), or grab it in various formats online at

http://www.gnu.org.ua/software/rush/manual
and listen — if this manpage and the Manual ever disagree, the Manual wins. it's the authoritative source. periodt. 👑

🌸 DESCRIPTION 🌸

GNU rush is a restricted user shell, designed for sites that wanna give out limited remote access to their resources — think svn or git repositories, scp, that kind of thing. it's giving gatekeeper but make it a shell. 💅

upon startup, 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.

🎀 OPTIONS 🎀

  • -c COMMAND — run COMMAND. that's it, that's the vibe.
  • -C, --security-check=CHECK — add or remove a configuration security check. the argument is one of these cuties:
    • all — enable all the checks. go big or go home.
    • owner — check whether the file is owned by root.
    • iwgrp, groupwritablefile — check that the file is not group writable.
    • iwoth, worldwritablefile — check that the file is not world writable.
    • dir_iwgrp, groupwritabledir — check that the directory the file lives in is not group writable.
    • dir_iwoth, worldwritabledir — check that the directory the file lives in is not world writable.
    • link — check that the file is not a symbolic link pointing at a file that resides in a group or world writable directory.
  • -d, --debug=NUMBER — set the debugging level. the bigger the NUMBER, the more verbose the logging gets. the debugging info is reported via syslog(3) using authpriv, priority debug. the maximum meaningful value for NUMBER is 3. (yes, only 3. anything past that is just noise, bestie.)
  • -D, --dump=ATTR[,ATTR...] — request dump mode. the arguments are the names of the attributes you wanna dump, or the word all standing for all the attributes. refer to the GNU Rush manual for a detailed description — this manpage is not gonna hold your hand on that one.
  • -i — emulate interactive access. use this to test whether and how your configuration allows interactive access. it's the vibe check for your config. ✅
  • --show-default — show the default configuration.
  • -t, --test, --lint — run in test mode. when you pass this, here's what goes down:
    1. all diagnostic messages get redirected to standard error, instead of syslog.
    2. if a single non-option argument is present, it's taken as the name of the configuration file to use.
    3. the configuration file gets 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 the command itself is not executed. fake it till you make it, but safely. 🙈
  • -T — test scanner mode. this option is used by the rush testsuite.
  • -u, --user=NAME — supplies the user name for use with --test.
  • -x, --trace — print parser traces. use it twice and it prints lexical scanner traces as well. this one's intended for debugging, so it's very much for the girlies who read logs for fun. 🔥

👀 SEE ALSO 👀

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

🌟 AUTHORS 🌟

Sergey Poznyakoff

🐛 BUG REPORTS 🐛

found a bug? report it to <bug-rush@gnu.org.ua>. we love a girl who files issues. 💜

Copyright © 2016-2019 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 that's the whole page, you're officially educated bestie 💖 this was RUSH(8), from the Rush User Reference, dated May 15, 2019 — mwah, go read the info manual, ily, bye 🎀✨🦋

📦 where this page comes from