Skip to content

Commit

Permalink
Update man page (fix Guake#288)
Browse files Browse the repository at this point in the history
  • Loading branch information
gsemet committed Oct 28, 2014
1 parent 6446cd7 commit a96c5ee
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 49 deletions.
95 changes: 64 additions & 31 deletions data/guake.1
Original file line number Diff line number Diff line change
@@ -1,31 +1,64 @@
.TH "guake" "1"
.SH "NAME"
guake \(em A drop-down terminal for GNOME environment.
.SH "SYNOPSIS"
.PP
\fBguake\fR [\fB-h, \-\-help\fR\fP] [\fB-s, --show-hide\fR\fP] [\fB-p, --preferences\fR\fP] [\fB-a, --about\fR\fP] [\fB-q, --quit\fR\fP]
.SH "DESCRIPTION"
.PP
Guake is a drop-down terminal for GNOME and any other desktop.
It aims to provide a quick-access terminal, that show/hide on screen with a simple key pressing.
.PP
.SH "OPTIONS"
.B \-h, \-\-help
Show summary of options.
.TP
.B \-s, \-\-show\-hide
Toggle the visibility of guake
.TP
.B \-p, \-\-preferences
Shows the preferences window of guake
.TP
.B \-a, \-\-about
Shows the about window of guake
.TP
.B \-q, \-\-quit
Closes the current running guake
.SH AUTHOR
guake was written by <[email protected]>
.PP
This manual page was written by Gabriel Falcao Goncalves de Moura <[email protected]>,
for the Debian project (but may be used by others).
.TH "guake" "1"
.SH "NAME"
guake \(em A drop-down terminal for GNOME environment.
.SH "SYNOPSIS"
.PP
\fBguake\fR [\fB-h, \-\-help\fR\fP] [\fB-s, --show-hide\fR\fP] [\fB-p, --preferences\fR\fP] [\fB-a, --about\fR\fP] [\fB-q, --quit\fR\fP] [\fB-f, --fullscreen\fR\fP] [\fB-t, --toggle-visiblity\fR\fP] [\fB--show\fR\fP] [\fB--hide\fR\fP] [\fB-s, --select-tab\fR\fP] [\fB-g, --selected-tab\fR\fP] [\fB-e, --execute-command\fR\fP] [\fB-t, --tab-index\fR\fP] [\fB--bgcolor\fR\fP] [\fB--fgcolor\fR\fP] [\fB-r, --rename-current-tab\fR\fP]
.SH "DESCRIPTION"
.PP
Guake is a drop-down terminal for GNOME and any other desktop.
It aims to provide a quick-access terminal, that show/hide on screen with a simple key pressing.
.PP
.SH "OPTIONS"
.B \-h, \-\-help
Show summary of options.
.TP
.B \-t, \-\-toggle\-visibility
Toggle the visibility of guake
.TP
.B \-\-show
Dioplay the main window
.TP
.B \-\-hide
Hide the main window
.TP
.B \-p, \-\-preferences
Shows the preferences window of guake
.TP
.B \-a, \-\-about
Shows the about window of guake
.TP
.B \-n, \-\-new\-tab
Create a new tab in Guake
.TP
.B \-s, \-\-select\-tab
Select a tab given its 0-based index
.TP
.B \-g, \-\-selected\-tab
Return the index of the current tab
.TP
.B \-e, \-\-execute\-command
Execute a command in the selected tab
.TP
.B \-i, \-\-tab\-index
Specify which tab to rename. Default is 0.
.TP
.B \-\-bgcolor
Set the hexadecimal (#rrggbb) background color of the selected tab.
.TP
.B \-\-fgcolor
Set the hexadecimal (#rrggbb) foreground color of the selected tab
.TP
.B \-\-rename\-tab
Rename the specified tab. Reset to default if TITLE is a single dash "\-".
.TP
.B \-r, \-\-rename\-current\-tab
Rename the current tab. Reset to default if TITLE is a single dash "\-".
.TP
.B \-q, \-\-quit
Closes the current running guake
.SH AUTHOR
guake was originally written by <[email protected]>
.PP
This manual page was written by Gabriel Falcao Goncalves de Moura <[email protected]>,
for the Debian project (but may be used by others).
36 changes: 18 additions & 18 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
==============================================
Welcome to Quake Terminal online Documentation
==============================================

Contents:

.. toctree::
:maxdepth: 2



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

==============================================
Welcome to Guake Terminal online Documentation
==============================================

Contents:

.. toctree::
:maxdepth: 2



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit a96c5ee

Please sign in to comment.