From 8a3510e03374dc4dcc5f26fad214d7e1bed80cf7 Mon Sep 17 00:00:00 2001 From: Qball Cow Date: Tue, 2 Jun 2015 19:01:25 +0200 Subject: [PATCH] Switch to ronn for manpage generation. --- Makefile.am | 2 +- doc/rofi-manpage.markdown | 8 +- doc/rofi.1 | 1882 ++++++++++++++++++++++--------------- 3 files changed, 1117 insertions(+), 775 deletions(-) diff --git a/Makefile.am b/Makefile.am index 6329d9b2..ecb9ff36 100644 --- a/Makefile.am +++ b/Makefile.am @@ -108,7 +108,7 @@ indent: ${rofi_SOURCES} ${top_srcdir}/config/config.def.c uncrustify -c ${top_srcdir}/data/uncrustify.cfg --replace $^ update-manpage: ${top_srcdir}/doc/rofi-manpage.markdown - md2man-roff $^ > ${top_srcdir}/doc/rofi.1 + ronn --roff --pipe $^ > ${top_srcdir}/doc/rofi.1 ## # Rofi test program diff --git a/doc/rofi-manpage.markdown b/doc/rofi-manpage.markdown index 2deec9dd..5551a43d 100644 --- a/doc/rofi-manpage.markdown +++ b/doc/rofi-manpage.markdown @@ -306,9 +306,11 @@ The following options are further explained in the theming section: Set window background and border color. -`-color-normal` *background,foreground,background alt, highlight background, highlight foreground* -`-color-urgent` *background,foreground,background alt, highlight background, highlight foreground* -`-color-active` *background,foreground,background alt, highlight background, highlight foreground* +`-color-normal` *background, foreground, background alt, highlight background, highlight foreground* + +`-color-urgent` *background, foreground, background alt, highlight background, highlight foreground* + +`-color-active` *background, foreground, background alt, highlight background, highlight foreground* Specify the colors used in a row per state (normal, active, urgent). diff --git a/doc/rofi.1 b/doc/rofi.1 index 26763457..4222718d 100644 --- a/doc/rofi.1 +++ b/doc/rofi.1 @@ -1,932 +1,1270 @@ -.TH ROFI 1 rofi -.SH NAME -.PP -\fBrofi\fP \- A window switcher, run launcher, ssh dialog and dmenu replacement -.SH SYNOPSIS -.PP -\fBrofi\fP -[ \-width \fIpct_scr\fP ] -[ \-lines \fIlines\fP ] -[ \-columns \fIcolumns\fP ] -[ \-font \fIpangofont\fP ] -[ \-fg \fIcolor\fP ] -[ \-fg\-urgent \fIcolor\fP ] -[ \-fg\-active \fIcolor\fP ] -[ \-bg\-urgent \fIcolor\fP ] -[ \-bg\-active \fIcolor\fP ] -[ \-bg \fIcolor\fP ] -[ \-bgalt \fIcolor\fP ] -[ \-hlfg \fIcolor\fP ] -[ \-hlbg \fIcolor\fP ] -[ \-key\-\fBmode\fP \fIcombo\fP ] -[ \-terminal \fIterminal\fP ] -[ \-location \fIposition\fP ] -[ \-fixed\-num\-lines ] -[ \-padding \fIpadding\fP ] -[ \-opacity \fIopacity%\fP ] -[ \-display \fIdisplay\fP ] -[ \-bc \fIcolor\fP ] -[ \-bw \fIwidth\fP ] -[ \-dmenu [ \-p \fIprompt\fP ] [ \-sep \fIseparator\fP ] [ \-l \fIselected line\fP ] [ \-mesg ] [ \-filter ] [ \-select ] ] -[ \-ssh\-client \fIclient\fP ] -[ \-ssh\-command \fIcommand\fP ] -[ \-disable\-history ] -[ \-levenshtein\-sort ] -[ \-case\-sensitive ] -[ \-show \fImode\fP ] -[ \-modi \fImode1,mode2\fP ] -[ \-eh \fIelement height\fP ] -[ \-lazy\-filter\-limit \fIlimit\fP ] -[ \-e \fImessage\fP] -[ \-a \fIrow\fP ] -[ \-u \fIrow\fP ] -[ \-pid \fIpath\fP ] -[ \-now ] -[ \-rnow ] -[ \-snow ] -[ \-version ] -[ \-help] -[ \-dump\-Xresources ] -[ \-auto\-select ] -[ \-parse\-hosts ] -[ \-combi\-modi \fImode1,mode2\fP ] -[ \-quiet ] -.SH DESCRIPTION -.PP -\fBrofi\fP is an X11 popup window switcher, run dialog, dmenu replacement and more. It focuses on -being fast to use and have minimal distraction. It supports keyboard and mouse navigation, type to -filter, tokenized search and more. -.SH USAGE -.PP -\fBrofi\fP can be used in three ways, single\-shot; executes once and directly exits when done, as a -daemon listening to specific key\-combination or emulating dmenu. -.SS Single\-shot mode -.PP -To launch \fBrofi\fP directly in a certain mode, specifying \fB\fCrofi \-show \fR\&. -To show the run dialog: -.PP -.RS +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ROFI\-MANPAGE" "" "June 2015" "" "" +. +.SH "NAME" +\fBrofi\fR \- A window switcher, run launcher, ssh dialog and dmenu replacement +. +.SH "SYNOPSIS" +\fBrofi\fR [ \-width \fIpct_scr\fR ] [ \-lines \fIlines\fR ] [ \-columns \fIcolumns\fR ] [ \-font \fIpangofont\fR ] [ \-fg \fIcolor\fR ] [ \-fg\-urgent \fIcolor\fR ] [ \-fg\-active \fIcolor\fR ] [ \-bg\-urgent \fIcolor\fR ] [ \-bg\-active \fIcolor\fR ] [ \-bg \fIcolor\fR ] [ \-bgalt \fIcolor\fR ] [ \-hlfg \fIcolor\fR ] [ \-hlbg \fIcolor\fR ] [ \-key\-\fBmode\fR \fIcombo\fR ] [ \-terminal \fIterminal\fR ] [ \-location \fIposition\fR ] [ \-fixed\-num\-lines ] [ \-padding \fIpadding\fR ] [ \-opacity \fIopacity%\fR ] [ \-display \fIdisplay\fR ] [ \-bc \fIcolor\fR ] [ \-bw \fIwidth\fR ] [ \-dmenu [ \-p \fIprompt\fR ] [ \-sep \fIseparator\fR ] [ \-l \fIselected line\fR ] [ \-mesg ] [ \-filter ] [ \-select ] ] [ \-ssh\-client \fIclient\fR ] [ \-ssh\-command \fIcommand\fR ] [ \-disable\-history ] [ \-levenshtein\-sort ] [ \-case\-sensitive ] [ \-show \fImode\fR ] [ \-modi \fImode1,mode2\fR ] [ \-eh \fIelement height\fR ] [ \-lazy\-filter\-limit \fIlimit\fR ] [ \-e \fImessage\fR] [ \-a \fIrow\fR ] [ \-u \fIrow\fR ] [ \-pid \fIpath\fR ] [ \-now ] [ \-rnow ] [ \-snow ] [ \-version ] [ \-help] [ \-dump\-Xresources ] [ \-auto\-select ] [ \-parse\-hosts ] [ \-combi\-modi \fImode1,mode2\fR ] [ \-quiet ] +. +.SH "DESCRIPTION" +\fBrofi\fR is an X11 popup window switcher, run dialog, dmenu replacement and more\. It focuses on being fast to use and have minimal distraction\. It supports keyboard and mouse navigation, type to filter, tokenized search and more\. +. +.SH "USAGE" +\fBrofi\fR can be used in three ways, single\-shot; executes once and directly exits when done, as a daemon listening to specific key\-combination or emulating dmenu\. +. +.SS "Single\-shot mode" +To launch \fBrofi\fR directly in a certain mode, specifying \fBrofi \-show \fR\. To show the run dialog: +. +.IP "" 4 +. .nf + rofi \-show run +. .fi -.RE -.SS Daemon mode -.PP -To launch \fBrofi\fP in daemon mode don't specify a mode to show (\fB\fC\-show \fR), instead you can -bind keys to launch a certain mode. To have run mode open when pressing \fB\fCF2\fR start \fBrofi\fP like: -.PP -.RS +. +.IP "" 0 +. +.SS "Daemon mode" +To launch \fBrofi\fR in daemon mode don\'t specify a mode to show (\fB\-show \fR), instead you can bind keys to launch a certain mode\. To have run mode open when pressing \fBF2\fR start \fBrofi\fR like: +. +.IP "" 4 +. .nf + rofi \-key\-run F2 +. .fi -.RE -.PP -Keybindings can also be specified in the \fB\fCXresources\fR file. -.SS Emulating dmenu -.PP -\fBrofi\fP can emulate \fB\fCdmenu\fR (a dynamic menu for X) when launched with the \fB\fC\-dmenu\fR flag. -.PP -The official website for \fB\fCdmenu\fR can be found here -\[la]http://tools.suckless.org/dmenu/\[ra]\&. -.SH OPTIONS -.PP +. +.IP "" 0 +. +.P +Keybindings can also be specified in the \fBXresources\fR file\. +. +.SS "Emulating dmenu" +\fBrofi\fR can emulate \fBdmenu\fR (a dynamic menu for X) when launched with the \fB\-dmenu\fR flag\. +. +.P +The official website for \fBdmenu\fR can be found here \fIhttp://tools\.suckless\.org/dmenu/\fR\. +. +.SH "OPTIONS" There are currently three methods of setting configuration options: -.RS -.IP \(bu 2 -Compile time: edit config.c. This method is strongly discouraged. -.IP \(bu 2 -Xresources: A method of storing key values in the Xserver. See -here -\[la]https://en.wikipedia.org/wiki/X_resources\[ra] for more information. -This is the recommended way of configuring \fBrofi\fP\&. -.IP \(bu 2 -Command\-line options: Arguments passed to \fBrofi\fP\&. -.RE -.PP -The Xresources options and the command\-line options are aliased. So to set option X you would set: -.PP -.RS +. +.IP "\(bu" 4 +Compile time: edit config\.c\. This method is strongly discouraged\. +. +.IP "\(bu" 4 +Xresources: A method of storing key values in the Xserver\. See here \fIhttps://en\.wikipedia\.org/wiki/X_resources\fR for more information\. This is the recommended way of configuring \fBrofi\fR\. +. +.IP "\(bu" 4 +Command\-line options: Arguments passed to \fBrofi\fR\. +. +.IP "" 0 +. +.P +The Xresources options and the command\-line options are aliased\. So to set option X you would set: +. +.IP "" 4 +. .nf -rofi.X: value + +rofi\.X: value +. .fi -.RE -.PP -In the Xresources file, and to (override) this via the command\-line you would pass the same key -prefixed with a '\-': -.PP -.RS +. +.IP "" 0 +. +.P +In the Xresources file, and to (override) this via the command\-line you would pass the same key prefixed with a \'\-\': +. +.IP "" 4 +. .nf + rofi \-X value +. .fi -.RE -.PP +. +.IP "" 0 +. +.P To get a list of available options, formatted as Xresources entries run: -.PP -.RS +. +.IP "" 4 +. .nf + rofi \-dump\-Xresources +. .fi -.RE -.PP +. +.IP "" 0 +. +.P The configuration system supports the following types: -.RS -.IP \(bu 2 +. +.IP "\(bu" 4 String -.IP \(bu 2 +. +.IP "\(bu" 4 Integer (signed and unsigned) -.IP \(bu 2 +. +.IP "\(bu" 4 Char -.IP \(bu 2 +. +.IP "\(bu" 4 Boolean -.RE -.PP -The boolean option has a non\-default command\-line syntax, to enable option X you do: -.PP -.RS +. +.IP "" 0 +. +.P +The boolean option has a non\-default command\-line syntax, to enable option X you do: +. +.IP "" 4 +. .nf + \-X +. .fi -.RE -.PP +. +.IP "" 0 +. +.P to disable it: -.PP -.RS +. +.IP "" 4 +. .nf + \-no\-X +. .fi -.RE -.PP +. +.IP "" 0 +. +.P Below is a list of the most important options: -.SS General -.PP -\fB\fC\-key\-{mode}\fR \fBKEY\fP -.IP -Set the key combination to display a {mode} in daemon mode. -.PP -.RS +. +.SS "General" +\fB\-key\-{mode}\fR \fBKEY\fR +. +.P +Set the key combination to display a {mode} in daemon mode\. +. +.IP "" 4 +. .nf + rofi \-key\-run F12 rofi \-key\-ssh control+shift+s rofi \-key\-window mod1+Tab +. .fi -.RE -.PP -\fB\fC\-dmenu\fR -.IP -Run \fBrofi\fP in dmenu mode. Allowing it to be used for user interaction in scripts. -.IP -In \fB\fCdmenu\fR mode, \fBrofi\fP will read input from STDIN, and will output to STDOUT by default. -.IP +. +.IP "" 0 +. +.P +\fB\-dmenu\fR +. +.P +Run \fBrofi\fR in dmenu mode\. Allowing it to be used for user interaction in scripts\. +. +.P +In \fBdmenu\fR mode, \fBrofi\fR will read input from STDIN, and will output to STDOUT by default\. +. +.P Example to let the user choose between three pre\-defined options: -.PP -.RS +. +.IP "" 4 +. .nf - echo \-e "Option #1\\nOption #2\\nOption #3" | rofi \-dmenu + + echo \-e "Option #1\enOption #2\enOption #3" | rofi \-dmenu +. .fi -.RE -.IP +. +.IP "" 0 +. +.P Or get the options from a script: -.PP -.RS +. +.IP "" 4 +. .nf - ~/my_script.sh | rofi \-dmenu + + ~/my_script\.sh | rofi \-dmenu +. .fi -.RE -.IP -Pressing \fB\fCshift\-enter\fR will open the selected entries and move to the next entry. -.PP -\fB\fC\-show\fR \fImode\fP -.IP -Open \fBrofi\fP in a certain mode. -.IP +. +.IP "" 0 +. +.P +Pressing \fBshift\-enter\fR will open the selected entries and move to the next entry\. +. +.P +\fB\-show\fR \fImode\fR +. +.P +Open \fBrofi\fR in a certain mode\. +. +.P For example to show the run\-dialog: -.PP -.RS +. +.IP "" 4 +. .nf + rofi \-show run +. .fi -.RE -.IP +. +.IP "" 0 +. +.P This function deprecates \-rnow,\-snow and \-now -.PP -\fB\fC\-switchers\fR \fImode1,mode1\fP -\fB\fC\-modi\fR \fImode1,mode1\fP -.IP -Give a comma separated list of modes to enable, in what order. -.IP +. +.P +\fB\-switchers\fR \fImode1,mode1\fR \fB\-modi\fR \fImode1,mode1\fR +. +.P +Give a comma separated list of modes to enable, in what order\. +. +.P For example to only show the run and ssh launcher (in that order): -.PP -.RS +. +.IP "" 4 +. .nf + rofi \-modi "run,ssh" \-show run +. .fi -.RE -.IP -Custom modes can be added using the internal 'script' mode. Each mode has two parameters: -.PP -.RS +. +.IP "" 0 +. +.P +Custom modes can be added using the internal \'script\' mode\. Each mode has two parameters: +. +.IP "" 4 +. .nf + :