summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorSamuel Walladge <samuel@swalladge.id.au>2017-02-03 21:43:08 +1030
committernfnty <git@nfnty.se>2017-02-05 09:44:03 +0100
commit24dd1af4f0bd05ad781e0f79723df2b07cb70218 (patch)
treea1433f40cc1a871d65da8f11d5511810bedf4b5d /doc
parent3fe5f92984e1361d06170e3b6a420ec93a041aaa (diff)
downloadranger-24dd1af4f0bd05ad781e0f79723df2b07cb70218.tar.gz
rifle: Add new option flag `-c`
Diffstat (limited to 'doc')
-rw-r--r--doc/rifle.110
-rw-r--r--doc/rifle.pod11
2 files changed, 15 insertions, 6 deletions
diff --git a/doc/rifle.1 b/doc/rifle.1
index ba985281..07875bc2 100644
--- a/doc/rifle.1
+++ b/doc/rifle.1
@@ -139,7 +139,7 @@ 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
+[\fB\-w\fR \fI\s-1PROGRAM\s0\fR] [\fB\-c\fR \fI\s-1CONFIG_FILE\s0\fR] \fIfiles\fR
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 rifle is a powerful file executor that allows for complex file type checking,
@@ -170,14 +170,18 @@ Pick a method to open the files.
 .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\-c\fR \fI\s-1CONFIG_FILE\s0\fR" 14
+.IX Item "-c CONFIG_FILE"
+Read configuration from \fI\s-1CONFIG_FILE\s0\fR, instead of the default.
 .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.
+order to use rifle. The default configuration file \fIrifle.conf\fR is expected
+to be at \fI~/.config/ranger/rifle.conf\fR. However, this can be overridden with
+the \fB\-c\fR option.
 .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
diff --git a/doc/rifle.pod b/doc/rifle.pod
index ea04c5ee..7241f6b5 100644
--- a/doc/rifle.pod
+++ b/doc/rifle.pod
@@ -8,7 +8,7 @@ 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>
+[B<-w> I<PROGRAM>] [B<-c> I<CONFIG_FILE>] I<files>
 
 
 
@@ -53,6 +53,10 @@ I<KEYWORD> is either the ID number listed by C<rifle -l> or a string that matche
 
 Open the files with the program I<PROGRAM>
 
+=item B<-c> I<CONFIG_FILE>
+
+Read configuration from I<CONFIG_FILE>, instead of the default.
+
 =item B<-h>, B<--help>
 
 Print a list of options and exit.
@@ -65,8 +69,9 @@ Print a list of options and exit.
 =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>.
+order to use rifle. The default configuration file F<rifle.conf> is expected
+to be at F<~/.config/ranger/rifle.conf>. However, this can be overridden with
+the B<-c> option.
 
 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