Add a description.

mavit · May 3, 2012 · 541f2f2 · 541f2f2
1 parent 429eef0
commit 541f2f2
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/README.pod b/README.pod
@@ -8,7 +8,17 @@ B<xsudo> I<sudo-arguments> ...
 
 =head1 DESCRIPTION
 
-FIXME
+Running X Window programs as a different user with sudo generally
+doesn't work because the target user can't authenticate with the X11
+server.
+
+This program copies your authorisation token into a temporary file
+readable by the target user.  Call it in place of sudo.
+
+In addition, you need to make sure that the DISPLAY and XAUTHORITY
+environment variables are passed to the program run by sudo.  See the
+C<env_keep> option in L<sudoers(5)> if you find that this is not the
+case.
 
 
 =cut

diff --git a/xsudo b/xsudo
@@ -13,7 +13,17 @@ B<xsudo> I<sudo-arguments> ...
 
 =head1 DESCRIPTION
 
-FIXME
+Running X Window programs as a different user with sudo generally
+doesn't work because the target user can't authenticate with the X11
+server.
+
+This program copies your authorisation token into a temporary file
+readable by the target user.  Call it in place of sudo.
+
+In addition, you need to make sure that the DISPLAY and XAUTHORITY
+environment variables are passed to the program run by sudo.  See the
+C<env_keep> option in L<sudoers(5)> if you find that this is not the
+case.
 
 =cut