From 3969a295be5adda22ce8414416f536f1309faf79 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Fri, 21 Apr 2017 21:31:47 -0400 Subject: man page --- debug-me.1 | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) (limited to 'debug-me.1') diff --git a/debug-me.1 b/debug-me.1 index e69de29..d0605ba 100644 --- a/debug-me.1 +++ b/debug-me.1 @@ -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 + +.SH AUTHOR +Joey Hess -- cgit v1.2.3