diff options
| -rw-r--r-- | Makefile | 4 | ||||
| -rw-r--r-- | doc/ranger.pod | 7 | ||||
| -rw-r--r-- | doc/rifle.1 | 211 | ||||
| -rw-r--r-- | doc/rifle.pod | 120 |
4 files changed, 342 insertions, 0 deletions
diff --git a/Makefile b/Makefile index a88a001f..2a4975ce 100644 --- a/Makefile +++ b/Makefile @@ -3,6 +3,8 @@ NAME = ranger VERSION = $(shell grep -m 1 -o '[0-9][0-9.]\+' README) +NAME_RIFLE = rifle +VERSION_RIFLE = $(VERSION) SNAPSHOT_NAME ?= $(NAME)-$(VERSION)-$(shell git rev-parse HEAD | cut -b 1-8).tar.gz # Find suitable python version (need python >= 2.6 or 3.1): PYTHON ?= $(shell python -c 'import sys; sys.exit(sys.version < "2.6")' && \ @@ -66,6 +68,8 @@ test: man: pod2man --stderr --center='ranger manual' --date='$(NAME)-$(VERSION)' \ --release=$(shell date +%x) doc/ranger.pod doc/ranger.1 + pod2man --stderr --center='rifle manual' --date='$(NAME_RIFLE)-$(VERSION_RIFLE)' \ + --release=$(shell date +%x) doc/rifle.pod doc/rifle.1 manhtml: pod2html doc/ranger.pod --outfile=doc/ranger.1.html diff --git a/doc/ranger.pod b/doc/ranger.pod index 1e3a7242..a8800498 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -1181,6 +1181,13 @@ copy, run: +=head1 SEE ALSO + +rifle(1) + + + + =head1 BUGS Report bugs here: L<http://savannah.nongnu.org/bugs/?group=ranger> diff --git a/doc/rifle.1 b/doc/rifle.1 new file mode 100644 index 00000000..c6423326 --- /dev/null +++ b/doc/rifle.1 @@ -0,0 +1,211 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "RIFLE 1" +.TH RIFLE 1 "rifle-1.5.5" "02/18/2013" "rifle manual" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +rifle \- ranger's file opener +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBrifle\fR [\fB\-\-help\fR] [\fB\-f\fR \fI\s-1FLAGS\s0\fR] [\fB\-l\fR] [\fB\-p\fR \fI\s-1KEYWORD\s0\fR] +[\fB\-w\fR \fI\s-1PROGRAM\s0\fR] \fIfiles\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +rifle is a powerful file executor that allows for complex file type checking, +written to meet the needs of the file manager \fIranger\fR. rifle's strength lies +in automatically determining file types, depending on which programs are +installed on the system, even without any user interaction. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR \fI\s-1FLAGS\s0\fR" 14 +.IX Item "-f FLAGS" +Specify flags for opening the files. Flags are letters that changes how the +program is executed. Any combination of flags will work. Writing uppercase +flags will negate the effect of all previously used lowercase flags of the same +letter. +.Sp +Table of all flags: + f fork program to background + r run program as root, using sudo + t run program in a separate terminal, as specified by \f(CW$TERMCMD\fR +.IP "\fB\-l\fR" 14 +.IX Item "-l" +List all possible ways to open the specified files. Each line will contain information in the format of \fIid:label:flags:command\fR. \fIid\fR is the identification number. \fIlabel\fR is an arbitrary string that was specified for this command, \fIflags\fR are the flags that are used by default, and \fIcommand\fR is the command that is going to be executed. +.IP "\fB\-p\fR \fI\s-1KEYWORD\s0\fR" 14 +.IX Item "-p KEYWORD" +Pick a method to open the files. +.Sp +\&\fI\s-1KEYWORD\s0\fR is either the \s-1ID\s0 number listed by \f(CW\*(C`rifle \-l\*(C'\fR or a string that matches a label in the configuration file. +.IP "\fB\-w\fR \fI\s-1PROGRAM\s0\fR" 14 +.IX Item "-w PROGRAM" +Open the files with the program \fI\s-1PROGRAM\s0\fR +.IP "\fB\-h\fR, \fB\-\-help\fR" 14 +.IX Item "-h, --help" +Print a list of options and exit. +.SH "FILES" +.IX Header "FILES" +rifle shares configuration files with ranger, though ranger is not required in +order to use rifle. The configuration file \fIrifle.conf\fR is expected to be at +\&\fI~/.config/ranger/rifle.conf\fR. +.PP +This file specifies patterns for determining the commands to open files with. +The syntax is described in the comments of the default \fIrifle.conf\fR that ships +with ranger. To obtain it, you need to run: \f(CW\*(C`ranger \-\-copy\-config=rifle\*(C'\fR +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +.IP "\s-1EDITOR\s0" 8 +.IX Item "EDITOR" +Determines which editor to use for editing files (in the default \fIrifle.conf\fR). +.IP "\s-1PAGER\s0" 8 +.IX Item "PAGER" +Determines which pager to use for displaying files (in the default \fIrifle.conf\fR). +.IP "\s-1TERMCMD\s0" 8 +.IX Item "TERMCMD" +Determines the terminal emulator command for use with the \fIt\fR flag. It is required that the value is the path to an executable file which accepts the \*(L"\-e \s-1COMMAND\s0\*(R" argument. +.IP "\s-1XDG_CONFIG_HOME\s0" 8 +.IX Item "XDG_CONFIG_HOME" +Specifies the directory for configuration files. Defaults to \fI\f(CI$HOME\fI/.config\fR. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +List all the different methods: + $ rifle \-l helloworld.py + 0:editor::\*(L"$EDITOR\*(R" \*(-- \*(L"$@\*(R" + 1:pager::\*(L"$PAGER\*(R" \*(-- \*(L"$@\*(R" + 2:::python \*(-- \*(L"$1\*(R" +.PP +Display its content by opening it with \*(L"cat\*(R": + $ rifle \-w cat helloworld.py + print(\*(L"Hello World!\*(R") +.PP +Run it by picking the method 2, which calls 'python \*(-- \*(L"$1\*(R"': + $ rifle \-p 2 helloworld.py + Hello World! +.PP +Display the file in a pager inside a new terminal, run as root: + $ rifle \-p 1 \-f tr helloworld.py diff --git a/doc/rifle.pod b/doc/rifle.pod new file mode 100644 index 00000000..5a01057b --- /dev/null +++ b/doc/rifle.pod @@ -0,0 +1,120 @@ +=head1 NAME + +rifle - ranger's file opener + + + + +=head1 SYNOPSIS + +B<rifle> [B<--help>] [B<-f> I<FLAGS>] [B<-l>] [B<-p> I<KEYWORD>] +[B<-w> I<PROGRAM>] I<files> + + + + +=head1 DESCRIPTION + +rifle is a powerful file executor that allows for complex file type checking, +written to meet the needs of the file manager I<ranger>. rifle's strength lies +in automatically determining file types, depending on which programs are +installed on the system, even without any user interaction. + + + + +=head1 OPTIONS + +=over 14 + +=item B<-f> I<FLAGS> + +Specify flags for opening the files. Flags are letters that changes how the +program is executed. Any combination of flags will work. Writing uppercase +flags will negate the effect of all previously used lowercase flags of the same +letter. + +Table of all flags: + f fork program to background + r run program as root, using sudo + t run program in a separate terminal, as specified by $TERMCMD + +=item B<-l> + +List all possible ways to open the specified files. Each line will contain information in the format of I<id:label:flags:command>. I<id> is the identification number. I<label> is an arbitrary string that was specified for this command, I<flags> are the flags that are used by default, and I<command> is the command that is going to be executed. + +=item B<-p> I<KEYWORD> + +Pick a method to open the files. + +I<KEYWORD> is either the ID number listed by C<rifle -l> or a string that matches a label in the configuration file. + +=item B<-w> I<PROGRAM> + +Open the files with the program I<PROGRAM> + +=item B<-h>, B<--help> + +Print a list of options and exit. + +=back + + + + +=head1 FILES + +rifle shares configuration files with ranger, though ranger is not required in +order to use rifle. The configuration file F<rifle.conf> is expected to be at +F<~/.config/ranger/rifle.conf>. + +This file specifies patterns for determining the commands to open files with. +The syntax is described in the comments of the default F<rifle.conf> that ships +with ranger. To obtain it, you need to run: C<ranger --copy-config=rifle> + + + + +=head1 ENVIRONMENT + +=over 8 + +=item EDITOR + +Determines which editor to use for editing files (in the default F<rifle.conf>). + +=item PAGER + +Determines which pager to use for displaying files (in the default F<rifle.conf>). + +=item TERMCMD + +Determines the terminal emulator command for use with the I<t> flag. It is required that the value is the path to an executable file which accepts the "-e COMMAND" argument. + +=item XDG_CONFIG_HOME + +Specifies the directory for configuration files. Defaults to F<$HOME/.config>. + +=back + + + + +=head1 EXAMPLES + +List all the different methods: + $ rifle -l helloworld.py + 0:editor::"$EDITOR" -- "$@" + 1:pager::"$PAGER" -- "$@" + 2:::python -- "$1" + +Display its content by opening it with "cat": + $ rifle -w cat helloworld.py + print("Hello World!") + +Run it by picking the method 2, which calls 'python -- "$1"': + $ rifle -p 2 helloworld.py + Hello World! + +Display the file in a pager inside a new terminal, run as root: + $ rifle -p 1 -f tr helloworld.py |