about summary refs log tree commit diff stats
path: root/main.c
blob: da209a9640ab18ef90a987cf7922aebc529f1af0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/* (C)opyright MMVI-MMVII Anselm R. Garbe <garbeam at gmail dot com>
 * See LICENSE file for license details.
 */

#include "dwm.h"
#include <errno.h>
#include <locale.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/select.h>
#include <X11/cursorfont.h>
#include <X11/keysym.h>
#include <X11/Xatom.h>
#include <X11/Xproto.h>

/* extern */

char stext[1024];
Bool *seltag;
int bx, by, bw, bh, bmw, masterd, screen, sx, sy, sw, sh, wax, way, waw, wah;
unsigned int master, nmaster, ntags, numlockmask;
Atom wmatom[WMLast], netatom[NetLast];
Bool running = True;
Bool issel = True;
Client *clients = NULL;
Client *sel = NULL;
Client *stack = NULL;
Cursor cursor[CurLast];
Display *dpy;
DC dc = {0};
Window root, barwin;

/* static */

static int (*xerrorxlib)(Display *, XErrorEvent *);
static Bool otherwm, readin;

static void
cleanup(void) {
	close(STDIN_FILENO);
	while(stack) {
		resize(stack, True, TopLeft);
		unmanage(stack);
	}
	if(dc.font.set)
		XFreeFontSet(dpy, dc.font.set);
	else
		XFreeFont(dpy, dc.font.xfont);
	XUngrabKey(dpy, AnyKey, AnyModifier, root);
	XFreePixmap(dpy, dc.drawable);
	XFreeGC(dpy, dc.gc);
	XDestroyWindow(dpy, barwin);
	XFreeCursor(dpy, cursor[CurNormal]);
	XFreeCursor(dpy, cursor[CurResize]);
	XFreeCursor(dpy, cursor[CurMove]);
	XSetInputFocus(dpy, PointerRoot, RevertToPointerRoot, CurrentTime);
	XSync(dpy, False);
	free(seltag);
}

static void
scan(void) {
	unsigned int i, num;
	Window *wins, d1, d2;
	XWindowAttributes wa;

	wins = NULL;
	if(XQueryTree(dpy, root, &d1, &d2, &wins, &num)) {
		for(i = 0; i < num; i++) {
			if(!XGetWindowAttributes(dpy, wins[i], &wa))
				continue;
			if(wa.override_redirect || XGetTransientForHint(dpy, wins[i], &d1))
				continue;
			if(wa.map_state == IsViewable)
				manage(wins[i], &wa);
		}
	}
	if(wins)
		XFree(wins);
}

static void
setup(void) {
	int i, j;
	unsigned int mask;
	Window w;
	XModifierKeymap *modmap;
	XSetWindowAttributes wa;

	/* init atoms */
	wmatom[WMProtocols] = XInternAtom(dpy, "WM_PROTOCOLS", False);
	wmatom[WMDelete] = XInternAtom(dpy, "WM_DELETE_WINDOW", False);
	netatom[NetSupported] = XInternAtom(dpy, "_NET_SUPPORTED", False);
	netatom[NetWMName] = XInternAtom(dpy, "_NET_WM_NAME", False);
	XChangeProperty(dpy, root, netatom[NetSupported], XA_ATOM, 32,
			PropModeReplace, (unsigned char *) netatom, NetLast);
	/* init cursors */
	cursor[CurNormal] = XCreateFontCursor(dpy, XC_left_ptr);
	cursor[CurResize] = XCreateFontCursor(dpy, XC_sizing);
	cursor[CurMove] = XCreateFontCursor(dpy, XC_fleur);
	/* init modifier map */
	modmap = XGetModifierMapping(dpy);
	for (i = 0; i < 8; i++) {
		for (j = 0; j < modmap->max_keypermod; j++) {
			if(modmap->modifiermap[i * modmap->max_keypermod + j] == XKeysymToKeycode(dpy, XK_Num_Lock))
				numlockmask = (1 << i);
		}
	}
	XFreeModifiermap(modmap);
	/* select for events */
	wa.event_mask = SubstructureRedirectMask | SubstructureNotifyMask
		| EnterWindowMask | LeaveWindowMask;
	wa.cursor = cursor[CurNormal];
	XChangeWindowAttributes(dpy, root, CWEventMask | CWCursor, &wa);
	grabkeys();
	initrregs();
	for(ntags = 0; tags[ntags]; ntags++);
	seltag = emallocz(sizeof(Bool) * ntags);
	seltag[0] = True;
	/* style */
	dc.norm[ColBG] = getcolor(NORMBGCOLOR);
	dc.norm[ColFG] = getcolor(NORMFGCOLOR);
	dc.sel[ColBG] = getcolor(SELBGCOLOR);
	dc.sel[ColFG] = getcolor(SELFGCOLOR);
	dc.status[ColBG] = getcolor(STATUSBGCOLOR);
	dc.status[ColFG] = getcolor(STATUSFGCOLOR);
	setfont(FONT);
	/* geometry */
	bmw = textw(TILESYMBOL) > textw(FLOATSYMBOL) ?  textw(TILESYMBOL) : textw(FLOATSYMBOL);
	sx = sy = 0;
	sw = DisplayWidth(dpy, screen);
	sh = DisplayHeight(dpy, screen);
	master = MASTER;
	nmaster = NMASTER;
	/* bar */
	bx = sx;
	by = sy;
	bw = sw;
	dc.h = bh = dc.font.height + 2;
	wa.override_redirect = 1;
	wa.background_pixmap = ParentRelative;
	wa.event_mask = ButtonPressMask | ExposureMask;
	barwin = XCreateWindow(dpy, root, bx, by, bw, bh, 0, DefaultDepth(dpy, screen),
			CopyFromParent, DefaultVisual(dpy, screen),
			CWOverrideRedirect | CWBackPixmap | CWEventMask, &wa);
	XDefineCursor(dpy, barwin, cursor[CurNormal]);
	XMapRaised(dpy, barwin);
	strcpy(stext, "dwm-"VERSION);
	/* windowarea */
	wax = sx;
	way = sy + bh;
	wah = sh - bh;
	waw = sw;
	/* pixmap for everything */
	dc.drawable = XCreatePixmap(dpy, root, sw, bh, DefaultDepth(dpy, screen));
	dc.gc = XCreateGC(dpy, root, 0, 0);
	XSetLineAttributes(dpy, dc.gc, 1, LineSolid, CapButt, JoinMiter);
	/* multihead support */
	issel = XQueryPointer(dpy, root, &w, &w, &i, &i, &i, &i, &mask);
}

/*
 * Startup Error handler to check if another window manager
 * is already running.
 */
static int
xerrorstart(Display *dsply, XErrorEvent *ee) {
	otherwm = True;
	return -1;
}

/* extern */

int
getproto(Window w) {
	int i, format, protos, status;
	unsigned long extra, res;
	Atom *protocols, real;

	protos = 0;
	status = XGetWindowProperty(dpy, w, wmatom[WMProtocols], 0L, 20L, False,
			XA_ATOM, &real, &format, &res, &extra, (unsigned char **)&protocols);
	if(status != Success || protocols == 0)
		return protos;
	for(i = 0; i < res; i++)
		if(protocols[i] == wmatom[WMDelete])
			protos |= PROTODELWIN;
	free(protocols);
	return protos;
}

void
sendevent(Window w, Atom a, long value) {
	XEvent e;

	e.type = ClientMessage;
	e.xclient.window = w;
	e.xclient.message_type = a;
	e.xclient.format = 32;
	e.xclient.data.l[0] = value;
	e.xclient.data.l[1] = CurrentTime;
	XSendEvent(dpy, w, False, NoEventMask, &e);
	XSync(dpy, False);
}

void
quit(Arg *arg) {
	readin = running = False;
}

/* There's no way to check accesses to destroyed windows, thus those cases are
 * ignored (especially on UnmapNotify's).  Other types of errors call Xlibs
 * default error handler, which may call exit.
 */
int
xerror(Display *dpy, XErrorEvent *ee) {
	if(ee->error_code == BadWindow
	|| (ee->request_code == X_SetInputFocus && ee->error_code == BadMatch)
	|| (ee->request_code == X_PolyText8 && ee->error_code == BadDrawable)
	|| (ee->request_code == X_PolyFillRectangle && ee->error_code == BadDrawable)
	|| (ee->request_code == X_PolySegment && ee->error_code == BadDrawable)
	|| (ee->request_code == X_ConfigureWindow && ee->error_code == BadMatch)
	|| (ee->request_code == X_GrabKey && ee->error_code == BadAccess)
	|| (ee->request_code == X_CopyArea && ee->error_code == BadDrawable))
		return 0;
	fprintf(stderr, "dwm: fatal error: request code=%d, error code=%d\n",
		ee->request_code, ee->error_code);
	return xerrorxlib(dpy, ee); /* may call exit */
}

int
main(int argc, char *argv[]) {
	char *p;
	int r, xfd;
	fd_set rd;

	if(argc == 2 && !strncmp("-v", argv[1], 3)) {
		fputs("dwm-"VERSION", (C)opyright MMVI-MMVII Anselm R. Garbe\n", stdout);
		exit(EXIT_SUCCESS);
	}
	else if(argc != 1)
		eprint("usage: dwm [-v]\n");
	setlocale(LC_CTYPE, "");
	dpy = XOpenDisplay(0);
	if(!dpy)
		eprint("dwm: cannot open display\n");
	xfd = ConnectionNumber(dpy);
	screen = DefaultScreen(dpy);
	root = RootWindow(dpy, screen);
	otherwm = False;
	XSetErrorHandler(xerrorstart);
	/* this causes an error if some other window manager is running */
	XSelectInput(dpy, root, SubstructureRedirectMask);
	XSync(dpy, False);
	if(otherwm)
		eprint("dwm: another window manager is already running\n");

	XSync(dpy, False);
	XSetErrorHandler(NULL);
	xerrorxlib = XSetErrorHandler(xerror);
	XSync(dpy, False);
	setup();
	drawstatus();
	scan();

	/* main event loop, also reads status text from stdin */
	XSync(dpy, False);
	procevent();
	readin = True;
	while(running) {
		FD_ZERO(&rd);
		if(readin)
			FD_SET(STDIN_FILENO, &rd);
		FD_SET(xfd, &rd);
		if(select(xfd + 1, &rd, NULL, NULL, NULL) == -1) {
			if(errno == EINTR)
				continue;
			eprint("select failed\n");
		}
		if(FD_ISSET(STDIN_FILENO, &rd)) {
			switch(r = read(STDIN_FILENO, stext, sizeof stext - 1)) {
			case -1:
				strncpy(stext, strerror(errno), sizeof stext - 1);
				stext[sizeof stext - 1] = '\0';
				readin = False;
				break;
			case 0:
				strncpy(stext, "EOF", 4);
				readin = False;
				break;
			default:
				for(stext[r] = '\0', p = stext + strlen(stext) - 1; p >= stext && *p == '\n'; *p-- = '\0');
				for(p = stext + strlen(stext) - 1; p >= stext && *p != '\n'; --p);
				if(p > stext)
					strncpy(stext, p + 1, sizeof stext);
			}
			drawstatus();
		}
		if(FD_ISSET(xfd, &rd))
			procevent();
	}
	cleanup();
	XCloseDisplay(dpy);
	return 0;
}
ot; to sort from Z to A. =item status_bar_on_top [bool] Put the status bar at the top of the window? =item hostname_in_titlebar [bool] Show hostname in titlebar? =item tilde_in_titlebar [bool] Abbreviate $HOME with ~ in the titlebar (first line) of ranger? =item unicode_ellipsis [bool] Use a unicode "..." character instead of "~" to mark cut-off filenames? =item update_title [bool] Set a window title? =item update_tmux_title [bool] Set the title to "ranger" in the tmux program? =item use_preview_script [bool] <zv> Use the preview script defined in the setting I<preview_script>? =item vcs_aware [bool] Gather and display data about version control systems. Supported vcs: git, hg. =item vcs_backend_git, vcs_backend_hg, vcs_backend_bzr [string] Sets the state for the version control backend. The possible values are: disabled don't display any information. local display only local state. enabled display both, local and remote state. May be slow for hg and bzr. =item xterm_alt_key [bool] Enable this if key combinations with the Alt Key don't work for you. (Especially on xterm) =item clear_filters_on_dir_change [bool] If set to 'true', persistent filters would be cleared upon leaving the directory =back =head1 COMMANDS You can enter the commands in the console which is opened by pressing ":". You can always get a list of the currently existing commands by typing "2?" in ranger. For your convenience, this is a list of the "public" commands including their parameters, excluding descriptions: alias [newcommand] [oldcommand] bulkrename cd [directory] chain command1[; command2[; command3...]] chmod octal_number cmap key command console [-pSTARTPOSITION] command copycmap key newkey [newkey2...] copymap key newkey [newkey2...] copypmap key newkey [newkey2...] copytmap key newkey [newkey2...] cunmap keys... default_linemode [path=regexp | tag=tags] linemodename delete echo [text] edit [filename] eval [-q] python_code filter [string] filter_inode_type [dfl] find pattern flat level grep pattern help jump_non [-FLAGS...] linemode linemodename load_copy_buffer map key command mark pattern mark_tag [tags] meta key value mkdir dirname open_with [application] [flags] [mode] pmap key command prompt_metadata [key1 [key2 [...]]] punmap keys... quit quit! relink newpath rename_append [-FLAGS...] rename newname save_copy_buffer scout [-FLAGS...] pattern search pattern search_inc pattern set option value setintag tags option value setlocal [path=<path>] option value shell [-FLAGS...] command source filename terminal tmap key command touch filename travel pattern tunmap keys... unmap keys... unmark pattern unmark_tag [tags] There are additional commands which are directly translated to python functions, one for every method in the ranger.core.actions.Actions class. They are not documented here, since they are mostly for key bindings, not to be typed in by a user. Read the source if you are interested in them. These are the public commands including their descriptions: =over 2 =item alias [I<newcommand>] [I<oldcommand>] Copies the oldcommand as newcommand. =item bulkrename This command opens a list of selected files in an external editor. After you edit and save the file, it will generate a shell script which does bulk renaming according to the changes you did in the file. This shell script is opened in an editor for you to review. After you close it, it will be executed. =item cd [I<directory>] The cd command changes the directory. The command C<:cd -> is equivalent to typing ``. =item chain I<command1>[; I<command2>[; I<command3>...]] Combines multiple commands into one, separated by semicolons. =item chmod I<octal_number> Sets the permissions of the selection to the octal number. The octal number is between 000 and 777. The digits specify the permissions for the user, the group and others. A 1 permits execution, a 2 permits writing, a 4 permits reading. Add those numbers to combine them. So a 7 permits everything. Key bindings in the form of [-+]<who><what> and <octal>= also exist. For example, B<+ar> allows reading for everyone, -ow forbids others to write and 777= allows everything. See also: man 1 chmod =item cmap I<key> I<command> Binds keys for the console. Works like the C<map> command. =item console [-pI<N>] I<command> Opens the console with the command already typed in. The cursor is placed at I<N>. =item copycmap I<key> I<newkey> [I<newkey2> ...] See C<copymap> =item copymap I<key> I<newkey> [I<newkey2> ...] Copies the keybinding I<key> to I<newkey> in the "browser" context. This is a deep copy, so if you change the new binding (or parts of it) later, the old one is not modified. To copy key bindings of the console, taskview, or pager use "copycmap", "copytmap" or "copypmap". =item copypmap I<key> I<newkey> [I<newkey2> ...] See C<copymap> =item copytmap I<key> I<newkey> [I<newkey2> ...] See C<copymap> =item cunmap [I<keys...>] Removes key mappings of the console. Works like the C<unmap> command. =item default_linemode [I<path=regexp> | I<tag=tags>] I<linemodename> Sets the default linemode. See I<linemode> command. Examples: Set the global default linemode to "permissions": :default_linemode permissions Set the default linemode to "permissions" for all files tagged with "p" or "P": :default_linemode tag=pP permissions Set the default linemode for all files in ~/books/ to "metatitle": :default_linemode path=/home/.*?/books/.* metatitle =item delete Destroy all files in the selection with a roundhouse kick. ranger will ask for a confirmation if you attempt to delete multiple (marked) files or non-empty directories. This can be changed by modifying the setting "confirm_on_delete". =item echo I<text> Display the text in the statusbar. =item edit [I<filename>] Edit the current file or the file in the argument. =item eval [I<-q>] I<python_code> Evaluates the python code. `fm' is a reference to the FM instance. To display text, use the function `p'. The result is displayed on the screen unless you use the "-q" option. Examples: :eval fm :eval len(fm.tabs) :eval p("Hello World!") =item filter [I<string>] Displays only the files which contain the I<string> in their basename. Running this command without any parameter will reset the filter. This command is based on the I<scout> command and supports all of its options. =item filter_inode_type [dfl] Displays only the files of specified inode type. To display only directories, use the 'd' parameter. To display only files, use the 'f' parameter. To display only links, use the 'l' parameter. Parameters can be combined. To remove this filter, use no parameter. =item find I<pattern> Search files in the current directory that contain the given (case-insensitive) string in their name as you type. Once there is an unambiguous result, it will be run immediately. (Or entered, if it's a directory.) This command is based on the I<scout> command and supports all of its options. =item flat level Flattens the directory view up to the specified level. Level -1 means infinite level. Level 0 means standard view without flattened directory view. Level values -2 and less are invalid. =item grep I<pattern> Looks for a string in all marked files or directories. =item help Provides a quick way to view ranger documentations. =item jump_non [-I<flags>...] Jumps to first non-directory if highlighted file is a directory and vice versa. Flags: -r Jump in reverse order -w Wrap around if reaching end of filelist =item linemode I<linemodename> Sets the linemode of all files in the current directory. The linemode may be: "filename": display each line as "<basename>...<size>" "fileinfo": display each line as "<basename>...<file(1) output>" "permissions": display each line as "<permissions> <owner> <group> <basename>" "metatitle": display metadata from .metadata.json files if available, fall back to the "filename" linemode if no metadata was found. See :meta command. The custom linemodes may be added by subclassing the I<LinemodeBase> class. See the I<ranger.core.linemode> module for some examples. =item load_copy_buffer Load the copy buffer from F<~/.config/ranger/copy_buffer>. This can be used to pass the list of copied files to another ranger instance. =item map I<key> I<command> Assign the key combination to the given command. Whenever you type the key/keys, the command will be executed. Additionally, if you use a quantifier when typing the key, like 5j, it will be passed to the command as the attribute "self.quantifier". The keys you bind with this command are accessible in the file browser only, not in the console, task view or pager. To bind keys there, use the commands "cmap", "tmap" or "pmap". =item mark I<pattern> Mark all files matching the regular expression pattern. This command is based on the I<scout> command and supports all of its options. =item mark_tag [I<tags>] Mark all tags that are tagged with either of the given tags. When leaving out the tag argument, all tagged files are marked. =item meta I<key> I<value> Set the metadata of the currently highlighted file. Example: :meta title The Hitchhiker's Guide to the Galaxy :meta year 1979 This metadata can be displayed by, for example, using the "metatitle" line mode by typing Mt. =item mkdir I<dirname> Creates a directory with the name I<dirname>. =item open_with [I<application>] [I<flags>] [I<mode>] Open the selected files with the given application, unless it is omitted, in which case the default application is used. I<flags> change the way the application is executed and are described in their own section in this man page. The I<mode> is a number that specifies which application to use. The list of applications is generated by the external file opener "rifle" and can be displayed when pressing "r" in ranger. Note that if you specify an application, the mode is ignored. =item pmap I<key> I<command> Binds keys for the pager. Works like the C<map> command. =item prompt_metadata [I<keys ...>] Prompt the user to input metadata with the C<meta> command for multiple keys in a row. =item punmap [I<keys ...>] Removes key mappings of the pager. Works like the C<unmap> command. =item quit Like quit!, but closes only this tab if multiple tabs are open. =item quit! Quit ranger. The current directory will be bookmarked as ' so you can re-enter it by typing `` or '' the next time you start ranger. =item relink I<newpath> Change the link destination of the current symlink file to <newpath>. First <tab> will load the original link. =item rename I<newname> Rename the current file. If a file with that name already exists, the renaming will fail. Also try the key binding A for appending something to a file name. =item rename_append [-I<flags>...] Opens the console with ":rename <current file>" with the cursor positioned before the file extension. Flags: -a Position before all extensions -r Remove everything before extensions =item save_copy_buffer Save the copy buffer to I<~/.config/ranger/copy_buffer>. This can be used to pass the list of copied files to another ranger instance. =item scout [-I<flags>...] [--] I<pattern> Swiss army knife command for searching, traveling and filtering files. Flags: -a Automatically open a file on unambiguous match -e Open the selected file when pressing enter -f Filter files that match the current search pattern -g Interpret pattern as a glob pattern -i Ignore the letter case of the files -k Keep the console open when changing a directory with the command -l Letter skipping; e.g. allow "rdme" to match the file "readme" -m Mark the matching files after pressing enter -M Unmark the matching files after pressing enter -p Permanent filter: hide non-matching files after pressing enter -r Interpret pattern as a regular expression pattern -s Smart case; like -i unless pattern contains upper case letters -t Apply filter and search pattern as you type -v Inverts the match Multiple flags can be combined. For example, ":scout -gpt" would create a :filter-like command using globbing. =item search I<pattern> Search files in the current directory that match the given (case insensitive) regular expression pattern. This command is based on the I<scout> command and supports all of its options. =item search_inc I<pattern> Search files in the current directory that match the given (case insensitive) regular expression pattern. This command gets you to matching files as you type. This command is based on the I<scout> command and supports all of its options. =item set I<option> I<value> Assigns a new value to an option. Valid options are listed in the settings section. Use tab completion to get the current value of an option, though this doesn't work for functions and regular expressions. Valid values are: setting type | example values ---------------+---------------------------- bool | true, false integer | 1, 23, 1337 string | foo, hello world list | 1,2,3,4 none | none =item setintag I<tags> I<option> I<value> Assigns a new value to an option, but locally for the directories that are marked with I<tag>. This means, that this option only takes effect when visiting that directory. For example, to change the sorting order in your downloads directory, tag it with the I<v> tag by typing I<"v>, then use this command: setintag v sort ctime =item setlocal [path=I<path>] I<option> I<value> Assigns a new value to an option, but locally for the directory given by I<path>. This means, that this option only takes effect when visiting that directory. If no path is given, uses the current directory. I<path> is a regular expression. This means that C<path=~/dl> applies to all paths that start with I<~/dl>, e.g. I<~/dl2> and I<~/dl/foo>. To avoid this, use C<path=~/dl$>. I<path> can be quoted with either single or double quotes to prevent unwanted splitting. I<path='~/dl dl$'> or I<path="~/dl dl$"> =item shell [-I<flags>] I<command> Run a shell command. I<flags> are discussed in their own section. =item source I<filename> Reads commands from a file and executes them in the ranger console. This can be used to re-evaluate the rc.conf file after changing it: map X chain shell vim -p %confdir/rc.conf %rangerdir/config/rc.conf; source %confdir/rc.conf =item terminal Spawns the I<x-terminal-emulator> starting in the current directory. =item tmap I<key> I<command> Binds keys for the taskview. Works like the C<map> command. =item touch I<filename> Creates an empty file with the name I<filename>, unless it already exists. =item travel I<pattern> Filters the current directory for files containing the letters in the string, possibly with other letters in between. The filter is applied as you type. When only one directory is left, it is entered and the console is automatically reopened, allowing for fast travel. To close the console, press ESC or execute a file. This command is based on the I<scout> command and supports all of its options. =item tunmap [I<keys ...>] Removes key mappings of the taskview. Works like the C<unmap> command. =item unmap [I<keys> ...] Removes the given key mappings in the "browser" context. To unmap key bindings in the console, taskview, or pager use "cunmap", "tunmap" or "punmap". =item unmark I<pattern> Unmark all files matching a regular expression pattern. This command is based on the I<scout> command and supports all of its options. =item unmark_tag [I<tags>] Unmark all tags that are tagged with either of the given tags. When leaving out the tag argument, all tagged files are unmarked. =back =head1 FILES ranger reads several configuration files which are located in F<$HOME/.config/ranger> or F<$XDG_CONFIG_HOME/ranger> if $XDG_CONFIG_HOME is defined. You can use the --copy-config option to obtain the default configuration files. Each of the files contains further documentation. You don't need to copy the whole file though, most configuration files are overlaid on top of the defaults (F<commands.py>, F<rc.conf>) or can be sub-classed (F<colorschemes>). That being said, the user configuration files F<rc.conf> and F<commands.py> are loaded only after ranger loads the default configuration files. This may lead to some confusing situations, for example when a key is being bound despite the corresponding line being removed from the user's copy of the configuration file. This behavior may be disabled with an environment variable (see also: B<ENVIRONMENT>). When starting ranger with the B<--clean> option, it will not access or create any of these files. =head2 CONFIGURATION =over 10 =item rc.conf Contains a list of commands which are executed on startup. Mostly key bindings and settings are defined here. =item commands.py A python module that defines commands which can be used in ranger's console by typing ":" or in the rc.conf file. Note that you can define commands in the same manner within plugins. =item commands_full.py This file is copied by --copy-config=commands_full and serves as a reference for custom commands. It is entirely ignored by ranger. =item rifle.conf This is the configuration file for the built-in file launcher called "rifle". =item scope.sh This is a script that handles file previews. When the options I<use_preview_script> and I<preview_files> are set, the program specified in the option I<preview_script> is run and its output and/or exit code determines rangers reaction. =item colorschemes/ Colorschemes can be placed here. =item plugins/ Plugins can be placed here. =back =head2 STORAGE =over 10 =item bookmarks This file contains a list of bookmarks. The syntax is /^(.):(.*)$/. The first character is the bookmark key and the rest after the colon is the path to the file. In ranger, bookmarks can be set by typing m<key>, accessed by typing '<key> and deleted by typing um<key>. =item copy_buffer When running the command :save_copy_buffer, the paths of all currently copied files are saved in this file. You can later run :load_copy_buffer to copy the same files again, pass them to another ranger instance or process them in a script. =item history Contains a list of commands that have been previously typed in. =item tagged Contains a list of tagged files. The syntax is /^(.:)?(.*)$/ where the first letter is the optional name of the tag and the rest after the optional colon is the path to the file. In ranger, tags can be set by pressing t and removed with T. To assign a named tag, type "<tagname>. =back =head1 ENVIRONMENT These environment variables have an effect on ranger: =over 8 =item RANGER_LEVEL ranger sets this environment variable to "1" or increments it if it already exists. External programs can determine whether they were spawned from ranger by checking for this variable. =item RANGER_LOAD_DEFAULT_RC If this variable is set to FALSE, ranger will not load the default rc.conf. This can save time if you copied the whole rc.conf to ~/.config/ranger/ and don't need the default one at all. =item EDITOR Defines the editor to be used for the "E" key. Defaults to "nano". =item SHELL Defines the shell that ranger is going to use with the :shell command and the "S" key. Defaults to "/bin/sh". =item TERMCMD Defines the terminal emulator command that ranger is going to use with the :terminal command and the "t" run flag. Defaults to "xterm". =item XDG_CONFIG_HOME Specifies the directory for configuration files. Defaults to F<$HOME/.config>. =item PYTHONOPTIMIZE This variable determines the optimize level of python. Using PYTHONOPTIMIZE=1 (like python -O) will make python discard assertion statements. You will gain efficiency at the cost of losing some debug info. Using PYTHONOPTIMIZE=2 (like python -OO) will additionally discard any docstrings. Using this will disable the <F1> key on commands. =item W3MIMGDISPLAY_PATH By changing this variable, you can change the path of the executable file for image previews. By default, it is set to F</usr/lib/w3m/w3mimgdisplay>. =back =head1 EXAMPLES There are various examples on how to extend ranger with plugins or combine ranger with other programs. These can be found in the F</usr/share/doc/ranger/examples/> directory, or the F<doc/ranger/> that is provided along with the source code. =head1 LICENSE GNU General Public License 3 or (at your option) any later version. =head1 LINKS =over =item Download: L<http://ranger.nongnu.org/ranger-stable.tar.gz> =item The project page: L<http://ranger.nongnu.org/> =item The mailing list: L<http://savannah.nongnu.org/mail/?group=ranger> =item IRC channel: #ranger on freenode.net =back ranger is maintained with the git version control system. To fetch a fresh copy, run: git clone git://git.savannah.nongnu.org/ranger.git =head1 SEE ALSO rifle(1) =head1 BUGS Report bugs here: L<https://github.com/hut/ranger/issues> Please include as much relevant information as possible. For the most diagnostic output, run ranger like this: C<PYTHONOPTIMIZE= ranger --debug>