kov changed gksu/trunk/ChangeLog, gksu/trunk/man/gksu.1

[Gustavo Noronha]

Mensagem de log: 
enhance manpage to describe gksu better and provide
missing information


-----


Modified: gksu/trunk/ChangeLog
===================================================================
--- gksu/trunk/ChangeLog	2006-08-18 01:07:32 UTC (rev 698)
+++ gksu/trunk/ChangeLog	2006-08-19 15:33:46 UTC (rev 699)
@@ -1,3 +1,11 @@
+2006-08-19  Gustavo Noronha Silva  <kov at debian.org>
+
+	* man/man.1:
+	- enhanced the description, wrote about the missing options and
+	  added information about the new usage mode (with no command
+	  specified); this also addresses the concerns of Debian bug
+	  #383477
+
 2006-08-17  Gustavo Noronha Silva  <kov at debian.org>
 
 	* gksu/gksu.c:

Modified: gksu/trunk/man/gksu.1
===================================================================
--- gksu/trunk/man/gksu.1	2006-08-18 01:07:32 UTC (rev 698)
+++ gksu/trunk/man/gksu.1	2006-08-19 15:33:46 UTC (rev 699)
@@ -1,12 +1,42 @@
-.TH GKSU "1" "April 2006" "GKsu version 1.9.0" "User Commands"
+.TH GKSU "1" "August 2006" "gksu version 2.0.x" "User Commands"
 .SH NAME
-GKsu \- manual page for GKsu version 1.9.0
+gksu \- GTK+ frontend for su and sudo
 .SH SYNOPSIS
 .B gksu
+.PP
+.B gksu
 [\fI-u <user>\fR] [\fIoptions\fR] \fI<command>\fR
+.PP
+.B gksudo
+[\fI-u <user>\fR] [\fIoptions\fR] \fI<command>\fR
 .SH DESCRIPTION
-GKsu version 1.9.0
-.HP
+This manual page documents briefly
+.B gksu
+and
+.B gksudo
+.PP
+gksu is a frontend to su and gksudo is a frontend to sudo.
+Their primary purpose is to run graphical commands that need
+root without the need to run an X terminal emulator and using
+su directly.
+.PP
+Notice that all the magic is done by the underlying library,
+libgksu. Also notice that the library will decide if it should use su
+or sudo as backend using the
+.B /apps/gksu/sudo-mode
+gconf key, if you call the
+.B gksu
+command. You can force the backend by using the
+.B gksudo
+command, or by using the \fB\-\-sudo\-mode\fR and \fB\-\-su\-mode\fR
+options.
+.PP
+If no command is given, the
+.B gksu
+program will display a small window that allows you to type in a
+command to be run, and to select what user the program should be run
+as. The other options are disregarded, right now, in this mode.
+.SH OPTIONS
 \fB\-\-debug\fR, \fB\-d\fR
 .IP
 Print information on the screen that might be
@@ -59,6 +89,15 @@
 like ssh\-askpass. Useful to use in scripts with
 programs that accept receiving the password on
 stdin.
+.PP
+.HP
+\fB\-\-su\-mode\fR, \fB\-w\fR
+.IP
+Force gksu to you su(1) as its backend for running the programs.
+.HP
+\fB\-\-sudo\-mode\fR, \fB\-S\fR
+.IP
+Force gksu to you sudo(1) as its backend for running the programs.
 .SH "SEE ALSO"
 .BR su (1),
 .BR sudo (1)