diff options
| author | Joey Hess <joeyh@joeyh.name> | 2017-04-21 21:31:47 -0400 |
|---|---|---|
| committer | Joey Hess <joeyh@joeyh.name> | 2017-04-21 21:31:47 -0400 |
| commit | 3969a295be5adda22ce8414416f536f1309faf79 (patch) | |
| tree | 2ba8183309675f22f0e8c071090c0ca05b9a92e8 | |
| parent | 194272f2f40a3d2aeee930d502379a7526e0d28d (diff) | |
| download | debug-me-3969a295be5adda22ce8414416f536f1309faf79.tar.gz | |
man page
| -rw-r--r-- | Role/User.hs | 2 | ||||
| -rw-r--r-- | debug-me.1 | 43 |
2 files changed, 44 insertions, 1 deletions
diff --git a/Role/User.hs b/Role/User.hs index 99a8a1a..5fb8897 100644 --- a/Role/User.hs +++ b/Role/User.hs @@ -48,7 +48,7 @@ run os = do shellCommand :: UserOpts -> IO (String, [String]) shellCommand os = case cmdToRun os of Just v -> return v - Nothing -> (, []) . fromMaybe "bash" <$> lookupEnv "SHELL" + Nothing -> maybe ("bash", ["-l"]) (, []) <$> lookupEnv "SHELL" -- | Log of recent Activity, with the most recent first. type Backlog = NonEmpty Log @@ -0,0 +1,43 @@ +.\" -*- nroff -*- +.TH debug-me 1 "Commands" +.SH NAME +debug-me \- secure remote debugging +.SH SYNOPSIS +.B debug-me [options] +.SH DESCRIPTION +.I debug-me +`debug-me` lets a developer access your shell remotely, to debug a problem, +avoiding a tedious back-and-forth by email. When you start `debug-me`, it +starts a shell, and generates an URL which you can give to the developer +(or developers) to connect them to the session. +.PP +It's not normally a good idea to let someone run commands in a shell on +your computer. To make this as safe as possible, debug-me uses the +GPG web of trust. Everything the developer sends to debug-me is signed +with their GPG key, in a way that produces a GPG signed proof of what the +developer saw, and what they did in the debug-me session. +If the developer does something Evil, you have the neccessary proof +to adjust their reputation. +.PP +.SH OPTIONS +.PP +.IP -- cmd opts +Normally debug-me will run your login shell. To run some other command, +pass the command and any options after "--". +.IP --debug url +Connect to a debug-me session on the specified url. The developer runs +debug-me with this option to see and interact with the user's bug. +.IP --replay logfile +Replay a debug-me logfile. +.IP --graphviz logfile +Uses graphviz to generate a visualization of a debug-me log file. +.IP --show-hashes +Include hashes in the graphviz visualization. +.IP --server logdir +Run a debug-me server, logging to the specified directory. +.IP --port N +Specify a port for the debug-me server to listen to. +.SH SEE ALSO +<https://debug-me.branchable.com/> +.SH AUTHOR +Joey Hess <id@joeyh.name> |