pax_global_header00006660000000000000000000000064130342724270014516gustar00rootroot0000000000000052 comment=630c6529377097953d9cb5e725da94f46b64110e ranger-1.8.1/000077500000000000000000000000001303427242700130035ustar00rootroot00000000000000ranger-1.8.1/.gitignore000066400000000000000000000001171303427242700147720ustar00rootroot00000000000000*~ *.pyc *.pyo stuff/* doc/ranger.1.html build pytestdebug.log install_log.txt ranger-1.8.1/.travis.yml000066400000000000000000000004311303427242700151120ustar00rootroot00000000000000language: python python: - "2.6" - "2.7" - "3.2" - "3.3" - "3.4" - "3.5" - "3.5-dev" # 3.5 development branch - "nightly" # currently points to 3.6-dev # command to install dependencies install: - pip install pytest # command to run tests script: - make test ranger-1.8.1/AUTHORS000066400000000000000000001104731303427242700140610ustar00rootroot00000000000000Copyright 2009-2016 Roman Zimbelmann Copyright 2010 David Barnett Copyright 2010 Lucas de Vries Copyright 2010 Sitaram Chamarty Copyright 2011 David Pugnasse Copyright 2011 ornicar Copyright 2011-2012 Abdó Roig-Maranges Copyright 2011-2012 M Rawash Copyright 2012 Serge Broslavsky Copyright 2012 joe Copyright 2013 Emanuel Guevel Copyright 2013 Joseph Tannhuber Copyright 2013-2014 GermainZ Copyright 2014 Célestin Matte Copyright 2014 Milan Svoboda Copyright 2014 rukai Copyright 2015 Alexander Buddenbrock Copyright 2015 Delisa Mason Copyright 2015 No Suck Copyright 2015 Randy Nance Copyright 2015 Ryan Burns Copyright 2015 anekos Copyright 2015 bastorran Copyright 2015 nfnty Copyright 2015-2016 Wojciech Siewierski Ideally, all contributors of non-trivial code are named here to the extent that a name and e-mail address is available. Please write a mail to hut@hut.pm if your name is missing, or in case of any other issues. The authorship and modification date of the individual lines of code can be determined through querying the version control management software: git blame Explicitly named authors in a source file are there to help you find a competent person in case of questions, not necessarily because they are the exclusive authors of a source file. This software is distributed under the terms of the GNU General Public License version 3. Copyright terms follow. ======================================================================= GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ranger-1.8.1/CHANGELOG.md000066400000000000000000000340411303427242700146160ustar00rootroot00000000000000This log documents changes between stable versions. # 2017-01-08: version 1.8.1 * Fixed `:scout` break due to incompatible change in python 3.6 # 2016-12-24: version 1.8.0 * scope.sh is now needed for the now fully scriptable image previews * Overhaul of version control system integration, now with threads * Fixed ranger not finding the location of w3mimgdisplay in most cases * Fixed many minor bugs * Added midnight-commander like multipane view, toggleable with `~` key. It displays the current directory of all the open tabs next to each other. * Added autodetect for 256 color support in scope.sh source code preview * Added macro `%confdir` that expands to `~/.config/ranger` by default * Added possibility to toggle/cycle through options with `set !` * Added `Mm`/`Ms` key to enable the linemode showing modification time * Added `yt`/`dt` keys to toggle whether file is in copy/cut buffer * Added `line_numbers` setting showing absolute/relative line numbers * Added `Alt-Left` and `Alt-Right` key bindings to move by words in console * Added previews for libreoffice files with `odt2txt` * Added `preview_images_method=urxvt` option for previewing images by changing the urxvt background (requires urxvt compiled with pixbuf support) * Added `clear_filters_on_dir_change` option * Added Travis-CI integration * Changed `zi` key to toggle `preview_images` option * Improved PEP8 compliance * Improved documentation * Improved UI by separating file path in title bar with a space from the username/hostname for quick copy&pasting by shift+double-clicking on it. # 2015-10-04: version 1.7.2 * Fixed file name arguments passed to `sxiv` and `feh` when using `:flat` * Fixed removal of empty directories when using `:rename` * Fixed free disk space display on Mac OS X * Fixed `examples/vim_file_chooser` to work with gvim too * Fixed some other rare crashes and bugs * Fixed downward mouse wheel scrolling * Fixed warning about regex splits being drawn in title bar since python3.5 * Really fixed `S` key binding not working when SHELL=fish * Improved `doc/cheatsheet.svg` * Added some entries to rifle.conf * Added key bindings `pO` and `pP` which work like `po` and `pp` but queue the operation in a first-in-first-out order. # 2015-05-04: version 1.7.1 * Added `doc/cheatsheet.svg` * Added `examples/rc_emacs.conf`, a config file adding emacs-like key bindings * Added `env` keyword in rifle.conf * Fixed `:bulkrename` command in python3 * Fixed `S` key binding not working when SHELL=fish # 2015-04-13: version 1.7.0 * The default editor is now `vim` instead of `nano` * Added automatic updates of tags when a file is renamed from within ranger * Added `preview_images_method` which can be set to `iterm2` to use native iTerm2 image previews * Added `:rename_append` command to rename files without the file extension * Added `:linemode` command to change the way the files are displayed Try this out by pressing M followed by one of the suggested keys. New linemodes can be added with `ranger.api.register_linemode()`. * Added `:filter_inode_type` command to only show directories, files or links * Added `:meta` command for managing custom file metadata * Added `:flat` command for displaying subdirectories * Added `solarized` colorscheme * Added generic ability to use scope.sh for image previews * Added video previews in scope.sh * Added option `sort_unicode` to sort according to unicode, not ASCII * `:mkdir` can now create multiple directory levels (like `mkdir -p`) * `:help` (key binding `?`) is now interactive * `:find` (key binding `/`) is now case insensitive by default * `ranger --copy-config=all` now copies a short sample commands.py rather than the full one, so that you can update ranger without having broken commands. The full commands.py is still copied to `~/.config/ranger/commands_full.py`. * Fixed broken copying of symlinks # 2013-05-24: Version 1.6.1 * Added support for version control systems, see: http://lists.nongnu.org/archive/html/ranger-users/2013-03/msg00007.html * Added :scout command as a unified backend to :find, :search, etc * Added `open_all_images` setting to remove the need for external scripts to handle opening of all images in a directory at once. * Now previewing with `i` uses the whole available width. # 2013-02-22: Version 1.6.0 * Overhauled all config files. Please update them or use the --clean switch * Added `examples/` directory to source code which contains sample programs or plugins that can be used together with ranger * Added progress bars to copying, moving and directory loading processes * Added feature to draw images inside the console using w3mimgdisplay (you need to add `set preview_images true` in rc.conf) * Added a plugin system like in the program `anki`, i.e. place any python file into ~/.config/ranger/plugins/ and it will be imported by ranger * Added a separate file launcher named `rifle` that is configured through rifle.conf and is installed as a standalone program. Using `ranger [filename]` from the shell for opening files is deprecated now, please use `rifle [filename]` instead. * Added `uq` keybinding to undo closed tabs * Added :setlocal command to change settings for specific directories only * Added :travel command to move more quickly to your destination * Added 256 color support for scope.sh * Added a real yes/no prompt for :delete command * Added settings: `confirm_on_delete`, `draw_progress_bar_in_status_bar`, `preview_images`, `status_bar_on_top`, `update_tmux_title` * Added commands: `:mark_tag`, `:unmark_tag` * Added BSD-friendly setsid implementation * Added as-you-type filtering for `:filter` command * Replaced `options.py` file by :set commands in rc.conf * Replaced `apps.py` file with rifle.conf * Improved `r` key to interface with rifle * Rewritten `scope.sh` in POSIX shell * Changed copying/moving code to work without GNU coreutils * Changed key to untag files from `T` to `ut` * Changed the flag `d` (for detached) to `f` (for fork) in program launcher * Changed appearance of keybinding-hints and bookmarks * Changed tabs with 4 spaces in the source code (see PEP 8) * Removed ranger.core.environment class * Removed settings: `colorscheme_overlay`, `draw_bookmark_borders`, `init_function`, `load_default_rc` * Fixed zombie process apocalypse * Fixed `draw_borders=true` in combination with `padding_right=false` # 2012-08-10: Version 1.5.5 * Ensure that detached programs continue to run when ranger is killed # 2012-05-03: Version 1.5.4 * Added exiftool to scope.sh by default * Fixed a crash when entering a directory with a unicode name * Speedup in `ranger.ext.get_executables` # 2012-03-05: Version 1.5.3 * Added --selectfile option that selects a certain file on startup * Added --list-tagged-files option * Added --cmd option to run commands on startup * Added --profile option for additional debug information on exit * Added a visual mode (activate with `V`, deactivate with Esc) * Added a reversed visual mode (activate with `uV`) * Added `$RANGER_LEVEL` environment variable which ranger sets to `1` or higher so programs can know that they were spawned from ranger * Added run flag `r` for running with root privileges (needs sudo) * Added run flag `t` for running in a new terminal (as specified in $TERMCMD) * Added :relink command to change destinations of symlinks * Added `dc` binding for getting the cumulative size of a directory * Added `autoupdate_cumulative_size` option * Added `pht` binding to Paste Hardlinked subTrees (like cp -l) * Improved sorting speed of signals (noticeable when caching many directories) * Improved drawing speed * Fixed unexpected behavior when displaying nonprintable characters * Fixed :bulkrename to work with files starting with a minus sign * Fixed RangerChooser example in man page * Fixed crash when opening images with sxiv/feh by running `ranger ` # 2011-10-23: Version 1.5.2 * Fixed graphical bug that appears in certain cases when drawing characters at the right edge. # 2011-10-23: Version 1.5.1 * Added `fm.select_file(path)` * Added --choosefiles option (like --choosefile, but chooses multiple files) * Fixed --list-unused-keys * Fixed Zombie processes * Fixed handling of filenames with undecodable bytes (unicode surrogates) * Fixed crashes due to incomplete loading of directories * Fixed tab completion of the command `shell` * Fixed `ot` and `oT` keys in rc.conf * Fixed parsing of chained commands (like in the binding `om`) # 2011-10-11: Version 1.5.0 * Full python3.2 compatibility * Added new configuration file `rc.conf` which contains a list of commands that are executed on startup - mainly used for keybindings * Added --list-unused-keys * Added new program handlers to apps.py * Added pop-up window for keychains and bookmarks * Added `load_default_rc` option * Fixed all known unicode issues * Fixed crash when $TERM is unknown to the system * Fixed scrolling in colored preview * Changed the default `column_ratios` to 1/3/4 and sorting method to `natural` * Changed :rename so it doesn't overwrite existing files * Internal actions are now accessible as commands * Replaced unittests by doctests * Replaced integrated help with an extended man page and dynamic lists of keybindings, commands and settings. * Removed `keys.py` configuration file in favor of `rc.conf` * Removed `texas` colorscheme * apps.py: Now able to define programs that only run with Xorg * commands.py: Using parse(self.line) to parse the line is unnecessary now. parse(self.line).rest(n) is now written as self.rest(n). However, parse(self.line).chunk(n) has been renamed to self.arg(n). * commands.py: parse(self.line) + X is now self.firstpart + X * commands.py: New special attribute `resolve_macros` which decides whether strings like %f should be expanded to the name of the current file, etc. * commands.py: New special attribute `escape_macros_for_shell` to toggle whether or not macros should be escaped, so you can use them in other commands than :shell, for example :edit %f * Countless small fixes and improvements # 2011-10-02: Version 1.4.4 * Added keys for chmod (like +ow for `chmod o+w`, etc) * Added `c` flag for running files * Added various key bindings * Added wavpack and webm types to mime.types * Added option `display_tags_in_all_columns` * Added command.cancel method which is called when pressing ESC in console * Added sorting and cycling by ctime and atime * Added custom tags (press "x) * Added bittorrent preview * Fixed blocking when using interactive scripts in scope.sh * Fixed issues with ALT key * Fixed pager crash when trying to read non-readable file * Forbid piping things into ranger * Improved hints # 2011-04-05: Version 1.4.3 * Fixed mimetype checking when invoking ranger with a filename * Fixed loss of bookmarks when disk is full * Minor improvements # 2011-03-05: Version 1.4.2 * Added --choosefile and --choosedir flag * Added use of bookmarks in tab completion of the :cd command * Fixed bug with detached programs and python 3.2 # 2011-01-04: Version 1.4.1 * Fixed crash when preview failed under some circumstances * Fixed graphical bug when pressing i # 2010-12-22: Version 1.4.0 * Added option to use any external scripts for previews (see scope.sh) * Added key: zv to toggle the use of the external script * Added indicator for the used filter (type `zf`) * Added option `padding_right` to remove whitespace if theres no preview * Added command `:search_inc` for incremental search * Added commands `:save_copy_buffer` and `:load_copy_buffer` to share the copied files between ranger instances * Added mimeopen as a fallback if no useful application can be found * Added natural sort, sorts 1foo before 10foo. (type `on`) * Added keys: yp, yd and yb to copy path, dirname or basename to seleciton * Let `open_with` use the selection, not just one file * Run files with right mouse click * Implemented copying via coreutils rather than internal python code * Improved handling of unicode * Some restructuration of the source code # 2010-12-13: Version 1.2.3 * Enable binding to alt-keys * Fixed memory leak in garbage collecting of old, unused directory objects * Fixed python3 incompatibilities * Fixed problems with identifying changes of files * Fixed lazy lookup of some FSObject attributes # 2010-10-10: Version 1.2.2 * Prevent currently used directories from being garbage collected * Disable mouse buttons when console is open * Fixed :cd command: Without arguments, cd's into $HOME * Fixed bug which prevented pydoc to work on some config files * Fixed some bugs in `snow` and `jungle` colorschemes * Several other clean-ups and fixes # 2010-09-16: Version 1.2.1 * Fixed yy/pp bug when yanking multiple directories # 2010-09-13: Version 1.2.0 * !!! Changed the default configuration directory to ~/.config/ranger !!! * Removed `Console Modes`, each old mode is now a simple command * Disabled file previews by default if ranger is used by root * Allow to jump to specific help sections by typing two numbers, e.g. 13? * Added keys: da, dr, ya, yr for adding and removing files from copy buffer * Added keys: gl and gL to resolve links, see 11? * Added key: pL to create a relative symlink * Added % and % macros for the console, see 33? * Fixed ansi codes for colors in the pager * Use the file ~/.mime.types for mime type detection * Several clean-ups and fixes # 2010-07-17: Version 1.1.2 * Fix crash when using scrollwheel to scroll down in some cases * The command `ranger dir1 dir2 ...` opens multiple directories in tabs * Removed pydoc html documentation by default, re-create it with `make doc` * Minor fixes # 2010-06-18: Version 1.1.1 * New install script, `setup.py` * New flag for running programs: `w` (waits for enter press) * Minor fixes # 2010-06-09: Version 1.1.0 * Added a man page * Tab support * Improved directory loading performance * Commands are definable in ~/.ranger/commands.py * Case insensitive sorting (type zs) * Better UTF support * Possibility to turn off previews (zp and zP) * Changing options with :set (e.g. `:set column_ratios=1,2,3,4`) * Ask for confirmation when using :delete * New invocation flag: --fail-unless-cd * New hotkeys, commands, options. * New syntax for ~/.ranger/keys.py * Several user contributions * And tons of general improvements ranger-1.8.1/CONTRIBUTING.md000066400000000000000000000007051303427242700152360ustar00rootroot00000000000000# Contributing to Ranger ## Tips for bug reports * You can obtain much better error messages with `ranger --debug`, please post those in bug reports rather than the usual, single-line error message. * Please mention the version of ranger and Python * If possible, Please give step-by-step instructions to reproduce the bug. * Send security-relevant bugs PGP-encrypted to hut@hut.pm, see HACKING.md ## Tips on patching * See HACKING.md Thank you! ranger-1.8.1/HACKING.md000066400000000000000000000201511303427242700143700ustar00rootroot00000000000000Guidelines for Code Modification ================================ Coding Style ------------ * Use syntax compatible to both python 2.6+ and 3.1+. * Use docstrings with pydoc in mind * Follow the style guide for python code: http://www.python.org/dev/peps/pep-0008/ * Test the code with "doctest" where it makes sense * when breaking backward compatibility with old configuration files or plugins, please include a temporary workaround code that provides a compatibility layer and mark it with a comment that includes the word "COMPAT". For examples, grep the code for the word "COMPAT". :) Patches ------- Send patches, created with "git format-patch", to the email address hut@hut.pm or open a pull request on GitHub. Please use PGP-encryption for security-relevand patches or messages. The UIDs of my key are `huterich ` and `hut `, my fingerprint is `1E9B 36EC 051F F6F7 FFC9 69A7 F08C E1E2 00FB 5CDF` and my full pubkey is at the very bottom of this file. Version Numbering ----------------- Three numbers, A.B.C, where * A changes on a rewrite * B changes when major configuration incompatibilities occur * C changes with each release Starting Points --------------- Good places to read about ranger internals are: * ranger/core/actions.py * ranger/container/fsobject.py About the UI: * ranger/gui/widgets/browsercolumn.py * ranger/gui/widgets/browserview.py * ranger/gui/ui.py Common Changes ============== Adding options -------------- * Add a default value in rc.conf, along with a comment that describes the option. * Add the option to the ALLOWED_SETTINGS dictionary in the file ranger/container/settings.py. Make sure to sort in the new entry alphabetically. * Add an entry in the man page by editing doc/ranger.pod, then rebuild the man page by running "make man" in the ranger root directory The setting is now accessible with self.settings.my_option, assuming self is a subclass of ranger.core.shared.SettingsAware. Adding colorschemes ------------------- * Copy ranger/colorschemes/default.py to ranger/colorschemes/myscheme.py and modify it according to your needs. Alternatively, create a subclass of ranger.colorschemes.default.Default and override the "use" method, as it is done in the "Jungle" colorscheme. * Add this line to your ~/.config/ranger/rc.conf: set colorscheme myscheme Change which programs start which file types -------------------------------------------- Edit the configuration file ~/.config/ranger/rifle.conf. The default one can be obtained by running "ranger --copy-config rifle". Change which file extensions have which mime type ------------------------------------------------- Modify ranger/data/mime.types. You may also add your own entries to ~/.mime.types Change which files are previewed in the auto preview ---------------------------------------------------- In ranger/container/file.py, change the constant PREVIEW_BLACKLIST PGP key ======= You may wish to send the author (hut@hut.pm) PGP-encrypted mails for security-relevant messages. This is the authors key. Save everything from the `BEGIN PGP PUBLIC KEY BLOCK` up until the `END PGP PUBLIC KEY BLOCK` message into a file and import it with `gpg --import `. ``` -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v2 mQINBEyOeTcBEACwCWkaA9XTE+DtjaCj2mm1EXslelop0JQco+j/KC5haPsYJ0G3 6lH/UpoXNfYw6B84QxILjodK/uKMk5+1RFS2YX/HoypMOobQLV9LHqo4TvRNmwWA u8K446nSE9CDx5yvWYkvj1HucV1GrKqNeDOPcbThRVOPasnwZwf5nmLaYWjn780t nhiWP8OR75/EceyJM2cryASrqgfWRKZoLLioRd67qUxi8zVG9nZIwxIx2OgWvW30 VMsiMvHR6faSOFxBXecag/muu9y5kdYxYxK2YpWhNpxZq8H+dqx2l/0z45nom56A c1aeL3/QoBpBm7GIaeRgcFEHhKAZI3oOQhLmQ8pbJ9WabhdyA7xbsdNrzMGLQGkY qYMk3iwP129ciG9FyZlwqhW3WaQST7hGmC3QKfo+kGLiJZMox3QWKD/lPtmBt1Ax VtDzOq3rbI8ab4OGa7wWJWKOgP+XaCHwy5yIVaCXMuotBqfFR4HJDL8WzfosJ0Du /zjNDyGVER8iF5+Kq5tahtYmmK0T30HMPPvc1qMsZsFsCgVbmQqxr6PgcAvnlvTN UWqGwd3G0BeBGiJrxlWHOsUz94eWCM/DILE2F0Io5SQXpK8FQ0BjeaWGv+NkgYZ+ WJ1wwcATgyGXD3GwABIwSZ8T/w55LRPP5R9sYd1SdlMHFeZ3SJ2Y8ZyC4QARAQAB tBBodXQgPGh1dEBodXQucG0+iQI6BBMBCAAkAhsDBQsJCAcCBhUICQoLAgQWAgMB Ah4BAheABQJWKKDPAhkBAAoJEPCM4eIA+1zfroMP/1NsAAlReX2WXf1voxKj83mi Deae94dd76uVuc7YqQR0aB1WBb8yw8oXPzzCkHG7QKF9FjRWuiA1Y1z3KQmcnsXS F6FVNistVA8Pq52DIR1TyULeN68/4m6C45CflnCMwWIP0rgQgWv0Bg7MhHtNbKTq kbpNfXUc2OZRzjLN03Oe7+hMgn/EmPBBUARYQ4AlearCse1Sy6XA5Sl0T3R9XtlJ /hstyNsOoBd2Q1lfeckP4NuHtEXsCF1eCTS/TGwKmls//RzKB3q3929TDazujKzK eRpT+ZYbW5xBUrUkHdFswuzur3b7YzNjOWKM5Z4wjLJWtk+6fEKSbT6ZDIyX8UkX WVcbO3PittJJFwqLkmbAvg9w4j3drqdP/sguJIjCjw1bHK/OgJ4SXhQITyBBs4R0 EUQLlIGi7eFywLPiQF9u0A6ufsPEto/5lPj0wZvpbtzbtTv/8yMrW9YfWhZ5aghw CvTZlsLp3K97CS2Dpid+7PKrUO4/JqLwKpPHaocXBLGwPfqMOKoNCq4Z58ftk2BN 7Ku+aRN1L9rLK6mTaE388ng1pigArqDFtyOOtzCb4NKKtBleSNVTLYe87HyjRMbw v8llkvssrpqprEmii50B0PWZQzfNFXBrg1jJ5LSz/v+mzt3yNn9ddurqd2rftvSo z+VtvqISACgpnIwZb2UatBpodXRlcmljaCA8aHV0QGxhdmFiaXQuY29tPokCOAQT AQIAIgUCTI55NwIbAwYLCQgHAwIGFQgCCQoLBBYCAwECHgECF4AACgkQ8Izh4gD7 XN+VehAAkntarXp6vJ7oTVhfCmBgl9WsNEKtvt8JfGVqXrd/mkVblEENKPTqXcC+ TeO/n+hcXN7r0ZJEgGsHPBoz9uoShqpxCUYBCXKKf77ffMqemu3W2jNcCDN4+T4q WSGC+NHcjmutjg78bM7CsznRGV6mDl9civrDNxMx2iELEoBImhdMCl8b/a8mOHcH umzWps4xR0Bd0LNnnVzWk5TGLKxrRSa+Ee+MdhnZLFF5mth1Sgcrs4v+2mWMJD88 oWcS9sjK48Wo3dvNiRVh6VkBGn60LcYT7ggo7T6mdF1ZdmDY6mQO/yJuwXICsO3r dOq58S3NrXrnvw7SLMmh5Wqu7xEjhVMgNmlI7yEmwd79wqW6qEDEP2Z8oe3t6CoS XvnF4LzJ5ibX1WDcES0V05eSMKk8rK9JS4h3ytpWvOOs+SI7OnggiIU4ed+jUKgx rtbxXkCc+CJaH5Ne3lmEJsifHGuRIqKld6nQK3bMNaNh2vFbvLOpH6BYKefDQblX IieKNpVVAfdzeSq3d3EXvG21v78Cfh4FM6nc6kIVYA1CRTyNElhgh6FwdcV1RUlr IQ4Zq+GJVnpDKucuWzAX980UjZlEZrZxGT+270Dqu2HpBPPhJsSoirvHGmMHTWnt /oUsIEC7ba0yh+y0jFR3fJYn6NjML9O0SGrMC8cBSVTa1tCG+VWJARwEEAECAAYF AlIwNVEACgkQ0/BQFp1SsougYwgAlYUKtlvw0/PlOOkzx7yfDdkmAMKpxCue1Wnt hDCKTY49zT+iBqxVXbmELHqPGxwE8p/ACFqGP+vFAT1JvdftmQeehf98wi7kwtHm ClBJPvIBY3Na6yZqYl3Q39cGzsrlldoMAPL/R28i+eY3KkivaHp6Y2LzzIIEUnKR OCDpWpNjdIWT7q6pe14gSLeFiegpnZEGD1sQmniHbuwChc3ud17ojI2sFN/tbL6M D3O1CfvEbC5XpgKirbsKY2UOiONq8YbwV62eAAx/HJWGLPrAZJH9wB4VP09+wOND YiQ2pCotpEzjE2AMOD5NlPRizo/TwsgRZIVNPvYG3RaTbbMyBokCHAQQAQIABgUC UsVNhAAKCRA1UveuA2o4tQW4D/9QG+gVxUroxr3Lx8T0xt+4eBM8skCDRfTj/tRg /h2D/y1xXp84pik9zKuDYbvB+02IUF2CTm5oJirrX7Mdgti0GGIS2LN8a2aVSac3 Wqfv8P81v+edMxbOO7aYPD2eenbVCd3wNg18c2GrsTyw9FzcJHDfqc0lp16wnbUt j4ZUMzY1KrN1TEC+Z0fHAmanUsj/i1eSIiGaJxzsSHRpUltv8OoiT2WeKIzlIVoA bd92d6uLR9NTdXw2fdORJFvQQWEKbd26oZK7gLRtrYVm1VfwCN6lcVGEu9nSeg2W o53C48TpfzE3XrEnSbAicsWV2z9QQv187sTbY6VJbXPpSlIhJU0aLh9bbsSyvmTs QDtw4D28HdNrc1XClQgF7mjYC6VTlCUK9lTcmrACzfUillv+XD0Pr6VhtpcN78ie 1LxOG2BBLdu2Ww9GeR6pR6WAyUg28h5nqkBwvlkiufMbTJ80IaF5DmyYbUlFT21j Ben6CvqstMngbcQ74DwUaO4iIvsMJ7WPWgaiVdH113a4Scl+WIbcE95q+Xcrg2n+ FidCeccD88bXH+c1Zu292NSQ+Kn0XvGbfY+1vFxJ6A+Gx03bTR4uOhKGWMS9IrSd pxHedrDGn/DJfZKifgVhyzrFEvPvxifIJidbVr7wwUQGANtVdsHs1vVF/ZrCRGtH ot8dSLkCDQRMjnk3ARAAqwzAE/LKceQXCctfwtNEBjcv/5ZFWmSWDx2wCuhAg1/p veTWBHU4ClpGSvfOLYRfpy8KwgPFK9sOS3lTDCDEDJOi1DvThhkbby8hqVqc6/r3 q4YvQDaNtb+i3IxX3b66eXX36HzWBbMhHvZjywOE1SAbv4YLdOGh9Pf5wxnssFnR eRkQ2UdmxUgD2TJKiyOQGkl1QCbvlIta0iz3ku92tqTXtM8iLG60KZX+mi/ckEOR kh4reAGUCW3PvRCRXHnwnEuULkE5Q5haOtfqFJxEBgAV2CLUzsLU8/ATiHpjXQpN 8ybkVB5AlFZnLqc4VOxn7Wz+aP23X9yhSlaRkGZKrzs2gv/JJTg9zV/qPc/5L8LV qiEDs0wFybDfmkUrYbNW3CtTTDA9vqqM/ifjxXcZbOBzXbXevJdYWy9CgWhhS+vS W/uVE55yStQ2fdDJIqa9A4bqmEh6/w1Aloa3I1JPAikjbAv74n8zdnbCqa/+36Uo YV0yHFHJPVzWAXbXR83LkVc9R1s5rlhXnuP51AZWI/KFOBWeBQ0/mXF9X1A3ayPD yq5j8InU9ZbQ3IA9UgjhItRHZXY9waCOdAT/m79Ka+3YLTZyyc7NUWhu54dyixWJ FE1xZ/hIAgvFxCYDeln29a+sSGmcd7jsx/9m61gWfnkkR2yIyfoJxdrlKR29LvEA EQEAAYkCHwQYAQIACQUCTI55NwIbDAAKCRDwjOHiAPtc3yz1EACW4wzhsdvtQ7Xi Zb8XHlSGyY8oMUCVxoUIw4qGO1KpzC8lnCyqinKi9KiNoBKlwHeOzpzwWD4K8uSl WRmw2YyG0RTfSauzsKKA7DzhL2RD0BsG6R86U3cl7smPGqkxW/CDGYHbozAz2sB6 4f4HQ+PtEsefiBe+Fkb4t0QhID8jDzTriEsENi5ITD8LSH3qVyJuRllD6JxIS6Nz 7kFuo3+Ng3N6SPB6vR+Az/XlHwAoUAmE+AF/aukbwHlOmWnrpik0hCPzkdpOjhwc +8URaQ5oCXjQv0C04Lzukn9SuSHI26btvtDbiGW0GCANV2/lIkJciZ21V+E9wHa7 +kUSLJO6XXa00EOSP5xStXEQ5bSroA1n6NllO19EigrvNXH34pyxPezL8UcWNyM4 8k3W7hv9uR0Axa7eupYYg/17zgRbV0gZjvvR+p+pCvnyOxd9aQWE0bjnSrgzWdgE c8ksiQ6yH1ta99HzBFDwneaxlQsPN8OW1pI0XmCa25GSOXNf5IwgYwRhqVKnz7uu j70MUp6UIpNcceBiWVrlyrF1QBM3iUsa50vQSAXN7qDlTELCu3NthpyyywV3CwML kPlUuRpx8YXXP1sPjV3Zfek/1ILqgftpXMImkmNSn+vZ/F8uM7RtnIECkOGS/hWI /Vp3S8rQGp/PJd/zIzW3VjwD4anL3g== =n2ru -----END PGP PUBLIC KEY BLOCK----- ``` ranger-1.8.1/Makefile000066400000000000000000000061541303427242700144510ustar00rootroot00000000000000# This file is part of ranger, the console file manager. # License: GNU GPL version 3, see the file "AUTHORS" for details. NAME = ranger VERSION = $(shell grep -m 1 -o '[0-9][0-9.]\+' README.md) 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")' && \ which python || which python3.3 || which python3.2 || which python3.1 || \ which python3 || which python2.7 || which python2.6) SETUPOPTS ?= '--record=install_log.txt' DOCDIR ?= doc/pydoc DESTDIR ?= / PYOPTIMIZE ?= 1 FILTER ?= . CWD = $(shell pwd) default: test compile @echo 'Run `make options` for a list of all options' options: help @echo @echo 'Options:' @echo 'PYTHON = $(PYTHON)' @echo 'PYOPTIMIZE = $(PYOPTIMIZE)' @echo 'DOCDIR = $(DOCDIR)' @echo 'DESTDIR = $(DESTDIR)' help: @echo 'make: Test and compile ranger.' @echo 'make install: Install $(NAME)' @echo 'make clean: Remove the compiled files (*.pyc, *.pyo)' @echo 'make doc: Create the pydoc documentation' @echo 'make cleandoc: Remove the pydoc documentation' @echo 'make man: Compile the manpage with "pod2man"' @echo 'make manhtml: Compile the html manpage with "pod2html"' @echo 'make snapshot: Create a tar.gz of the current git revision' @echo 'make test: Test all testable modules of ranger' @echo 'make todo: Look for TODO and XXX markers in the source code' install: $(PYTHON) setup.py install $(SETUPOPTS) \ '--root=$(DESTDIR)' --optimize=$(PYOPTIMIZE) compile: clean PYTHONOPTIMIZE=$(PYOPTIMIZE) $(PYTHON) -m compileall -q ranger clean: find ranger -regex .\*\.py[co]\$$ -delete find ranger -depth -name __pycache__ -type d -exec rm -rf -- {} \; doc: cleandoc mkdir -p $(DOCDIR) cd $(DOCDIR); \ $(PYTHON) -c 'import pydoc, sys; \ sys.path[0] = "$(CWD)"; \ pydoc.writedocs("$(CWD)")' find . -name \*.html -exec sed -i 's|'"$(CWD)"'|../..|g' -- {} \; test: @echo "Running doctests..." @for FILE in $(shell grep -IHm 1 doctest -r ranger | grep $(FILTER) | cut -d: -f1); do \ echo "Testing $$FILE..."; \ RANGER_DOCTEST=1 PYTHONPATH=".:"$$PYTHONPATH ${PYTHON} $$FILE; \ done @if type py.test > /dev/null; then \ echo "Running py.test tests..."; \ py.test tests; \ else \ echo "WARNING: Couldn't run some tests because py.test is not installed!"; \ fi @echo "Finished testing." 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 cleandoc: test -d $(DOCDIR) && rm -f -- $(DOCDIR)/*.html || true snapshot: git archive --prefix='$(NAME)-$(VERSION)/' --format=tar HEAD | gzip > $(SNAPSHOT_NAME) dist: snapshot todo: @grep --color -Ion '\(TODO\|XXX\).*' -r ranger .PHONY: clean cleandoc compile default dist doc help install man manhtml options snapshot test todo ranger-1.8.1/README.md000066400000000000000000000075751303427242700143000ustar00rootroot00000000000000ranger v.1.8.1 ============== [![Build Status](https://travis-ci.org/ranger/ranger.svg?branch=master)](https://travis-ci.org/ranger/ranger) ranger is a console file manager with VI key bindings. It provides a minimalistic and nice curses interface with a view on the directory hierarchy. It ships with "rifle", a file launcher that is good at automatically finding out which program to use for what file type. ![screenshot](https://raw.githubusercontent.com/ranger/ranger-assets/master/screenshots/screenshot.png) This file describes ranger and how to get it to run. For instructions on the usage, please read the man page. See HACKING.md for development specific information. For configuration, check the files in ranger/config/ or copy the default config to ~/.config/ranger with ranger's --copy-config option. The examples/ directory contains several scripts and plugins that demonstrate how ranger can be extended or combined with other programs. These files can be found in the git repository or in /usr/share/doc/ranger. A note to packagers: Versions meant for packaging are listed in the changelog on the website. About ----- * Authors: see "AUTHORS" file * License: GNU General Public License Version 3 * Website: http://ranger.nongnu.org/ * Download: http://ranger.nongnu.org/ranger-stable.tar.gz * Bug reports: https://github.com/hut/ranger/issues * git clone http://git.sv.gnu.org/r/ranger.git Design Goals ------------ * An easily maintainable file manager in a high level language * A quick way to switch directories and browse the file system * Keep it small but useful, do one thing and do it well * Console based, with smooth integration into the unix shell Features -------- * UTF-8 Support (if your python copy supports it) * Multi-column display * Preview of the selected file/directory * Common file operations (create/chmod/copy/delete/...) * Renaming multiple files at once * VIM-like console and hotkeys * Automatically determine file types and run them with correct programs * Change the directory of your shell after exiting ranger * Tabs, Bookmarks, Mouse support Dependencies ------------ * Python (tested with version 2.6, 2.7, 3.1-3.5) with the "curses" module and (optionally) wide-unicode support. * A pager ("less" by default) Optional: * The "file" program for determining file types * The python module "chardet", in case of encoding detection problems * "sudo" to use the "run as root"-feature * w3m for the "w3mimgdisplay" program to preview images Optional, for enhanced file previews (with "scope.sh"): * img2txt (from caca-utils) for ASCII-art image previews * highlight or pygmentize for syntax highlighting of code * atool, acat, bsdtar and/or unrar for previews of archives * lynx, w3m or elinks for previews of html pages * pdftotext for pdf previews * transmission-show for viewing bit-torrent information * mediainfo or exiftool for viewing information about media files * odt2txt for OpenDocument text files (odt, ods, odp and sxw) Installing ---------- Use the package manager of your operating system to install ranger. Note that ranger can be started without installing by simply running ranger.py. To install ranger manually: sudo make install This translates roughly to: sudo python setup.py install --optimize=1 --record=install_log.txt This also saves a list of all installed files to install_log.txt, which you can use to uninstall ranger. Getting Started --------------- After starting ranger, you can use the Arrow Keys (or hjkl) to navigate, Enter to open a file or type Q to quit. The third column shows a preview of the current file. The second is the main column and the first shows the parent directory. Ranger can automatically copy default configuration files to ~/.config/ranger if you run it with the switch --copy-config. (see ranger --help for a description of that switch.) Also check ranger/config/ for the default configuration. ranger-1.8.1/doc/000077500000000000000000000000001303427242700135505ustar00rootroot00000000000000ranger-1.8.1/doc/cheatsheet.svg000066400000000000000000007473311303427242700164250ustar00rootroot00000000000000 image/svg+xml R reload thisdirectory r :open_with ^R resetranger E edit e W show log w show back-ground tasks Q quit q close tab TAB prev. tab tab next tab ~ ` openbookmarks ! :shell 1 (1) ESC abort T t tag files Y y yank (3) U u undo ^U move uphalf page I i inspect file :rename(insert) O o sort P p paste (3) { [ move up inparent dir } traverse sub-directories ] move downin parent dir @ :shell %s 2 (1) # :shell -p 3 (1) $ 4 (1) % 5 (1) ^ 6 (1) & 7 (1) * 8 (1) ( 9 (1) ) 0 (1) _ - chmod (2) + chmod (2) = chmod (2) A :rename(append) a :rename (skipextension) S open shell s :shell D d cut (3) (4) move downhalf page ^D F f :find ^F move down1 page G go to top g :cd ... H back inhistory h go up 1directory ^H togglehidden files J move downhalf page j move down K move uphalf page k move up L forward inhistory l enter dir/open file ^L redraw : console ; console ' openbookmarks " tag files withcustom tag CAPSLOCK SHIFT Z ZZ/ZQ = quit z toggleoptions X x ^C C c select files incertain order abort task V visual mode v invertselection B b ^B move up1 page N searchprevious n search next ^N new tab M change (5)linemode m savebookmark < , > . ? show help / :search F1 help F3 inspect file F4 edit F5 copy F6 cut F7 :mkdir F8 :delete F10 quit F2 F9 F11 F12 ranger cheatsheet http://ranger.nongnu.org git clone https://github.com/hut/ranger Macros can be used in commands. They are likeglobal variables with dynamic content: %f%d%s%t%c%any%rangerdir%space The base name of the current fileThe path of the current directoryThe names of the currently selected filesThe names of all tagged files in this directoryThe paths of the currently copied filesThe key used in a key binding with "<any>"Example: map x<any> shell -w echo %anyThe path to the ranger python moduleJust a space, to avoid typing trailing spaces Example: map yp shell echo %d/%f | xsel -iThey can be escaped by replacing % with %%. (1) numbers can be used as a quantifier in various commands, for example 5j will movethe cursor down 5 by lines, 3<space> selects 3 files, 4<TAB> moves you to the 4th tab.(2) the keys -, + and = change the permissions of files. See "man chmod". [+-][augo][rwxXst] (e.g. +gw means "add write permissions to the group) [+-][rwxXst] (e.g. -x means "remove execute permissions from everybody") <octal>= (e.g. 777= means "give full permissions to everybody")(3) yank, copy, paste: To copy files, select them with the cursor (or <space>, in case ofmultiple files) → type dd (to cut) or yy (to copy) → move to the destination → type pp.Type da (or ya) to add files to the copy buffer, allowing you to copy from multiple folders.(4) d also starts the keybindings dc (calculate size of the content of a directory), du/dU(calculate directory size with the "du" program), dD (open the console with ":delete")(5) M<key> changes the linemode - the way files are drawn. Mf draws just the file name,Mp draws permissions, Mi draws file type information, Mt draws metadata, as definedwith the :meta command. You can add custom linemodes as described in/usr/share/doc/ranger/examples/plugin_linemode.py Config files: run "ranger --copy-config=all" tocopy the default config files to ~/.config/ranger/. rc.conf: A list of commands that are executed when rangerstarts. Options, key bindings and aliases are found here.Pro tip: Adding "export RANGER_LOAD_DEFAULT_RC=FALSE" toyour shell rc will skip loading the default rc.conf before your own.commands.py: A python script containing custom commandsrifle.conf: Rules for rifle, the file opener. Each line looks like list of conditions = commandWhen ranger opens a file, it tests those conditions. The firstcommand where all conditions are true will be executed.scope.sh: The script that generates file previews.Plugins can be put in the plugins/ subdirectory, colorschemesin colorschemes/. See /usr/share/doc/ranger/examples. #ranger on irc.freenode.net Commands can be typed in by pressing : or added to ~/.config/ranger/rc.conf to apply then wheneverranger starts. All commands are listed in the man page. Some important ones: :shell [<flags>] <command> calls the given <command> with the shell specified in the environmentvariable $SHELL. <flags> can be "-f" to fork the process or "-p" to pipe the output to a pager. Macros like%f and %s are especially useful here. Example: ":shell -f inkscape %f" or ":shell sudo cp %c ./":alias <new> <old> creates the command <new> that calls <old>. The neat thing is that you can passarguments to the next command. Example: ":alias touch shell touch" will allow you to type ":touch FILE",which will be translated to ":shell touch FILE".:map <key> <command> makes the <key> run <command> when pressed. This is the typical way todefine key bindings in rc.conf. There is also "pmap" to define keys in the pager and "unmap" and "punmap"to remove key bindings. ranger-1.8.1/doc/colorschemes.txt000066400000000000000000000062641303427242700170070ustar00rootroot00000000000000Colorschemes ============ This text explains colorschemes and how they work. Context Tags ------------ Context Tags provide information about the context. If the tag "in_titlebar" is set, you probably want to know about the color of a part of the titlebar now. There are a number of context tags, specified in /ranger/gui/context.py in the constant CONTEXT_KEYS. A Context object, defined in the same file, contains attributes with the names of all tags, whose values are either True or False. Implementation in the GUI Classes --------------------------------- The class CursesShortcuts in the file /ranger/gui/curses_shortcuts.py defines the methods color(*tags), color_at(y, x, wid, *tags) and color_reset(). This class is a superclass of Displayable, so these methods are available almost everywhere. Something like color("in_titlebar", "directory") will be called to get the color of directories in the titlebar. This creates a ranger.gui.context.Context object, sets its attributes "in_titlebar" and "directory" to True, leaves the others as False, and passes it to the colorscheme's use(context) method. The Color Scheme ---------------- A colorscheme should be a subclass of ranger.gui.ColorScheme and define the method use(context). By looking at the context, this use-method has to determine a 3-tuple of integers: (foreground, background, attribute) and return it. foreground and background are integers representing colors, attribute is another integer with each bit representing one attribute. These integers are interpreted by the used terminal emulator. Abbreviations for colors and attributes are defined in ranger.gui.color. Two attributes can be combined via bitwise OR: bold | reverse Once the color for a set of tags is determined, it will be cached by default. If you want more dynamic colorschemes (such as a different color for very large files), you will need to dig into the source code, perhaps add an own tag and modify the draw-method of the widget to use that tag. Run tc_colorscheme to check if your colorschemes are valid. Specify a Colorscheme --------------------- Colorschemes are searched for in these directories: ~/.config/ranger/colorschemes/ /path/to/ranger/colorschemes/ To specify which colorscheme to use, change the option "colorscheme" in your rc.conf: set colorscheme default This means, use the colorscheme contained in either ~/.config/ranger/colorschemes/default.py or /path/to/ranger/colorschemes/default.py. Adapt a colorscheme ------------------- You may want to adapt a colorscheme to your needs without having a complete copy of it, but rather the changes only. Say, you want the exact same colors as in the default colorscheme, but the directories to be green rather than blue, because you find the blue hard to read. This is done in the jungle colorscheme ranger/colorschemes/jungle, check it out for implementation details. In short, I made a subclass of the default scheme, set the initial colors to the result of the default use() method and modified the colors how I wanted. This has the obvious advantage that you need to write less, which results in less maintenance work and a greater chance that your colorscheme will work with future versions of ranger. ranger-1.8.1/doc/config/000077500000000000000000000000001303427242700150155ustar00rootroot00000000000000ranger-1.8.1/doc/config/colorschemes/000077500000000000000000000000001303427242700175035ustar00rootroot00000000000000ranger-1.8.1/doc/config/colorschemes/default.py000077700000000000000000000000001303427242700302772../../../ranger/colorschemes/default.pyustar00rootroot00000000000000ranger-1.8.1/doc/config/colorschemes/jungle.py000077700000000000000000000000001303427242700277772../../../ranger/colorschemes/jungle.pyustar00rootroot00000000000000ranger-1.8.1/doc/config/colorschemes/snow.py000077700000000000000000000000001303427242700272032../../../ranger/colorschemes/snow.pyustar00rootroot00000000000000ranger-1.8.1/doc/config/commands.py000077700000000000000000000000001303427242700245072../../ranger/config/commands.pyustar00rootroot00000000000000ranger-1.8.1/doc/config/rc.conf000077700000000000000000000000001303427242700227072../../ranger/config/rc.confustar00rootroot00000000000000ranger-1.8.1/doc/config/rifle.conf000077700000000000000000000000001303427242700241012../../ranger/config/rifle.confustar00rootroot00000000000000ranger-1.8.1/doc/config/scope.sh000077700000000000000000000000001303427242700227372../../ranger/data/scope.shustar00rootroot00000000000000ranger-1.8.1/doc/howto-publish-a-release.txt000066400000000000000000000017151303427242700207550ustar00rootroot00000000000000( ) test everything one last time: (x) * make test (x) * ./ranger.py [--clean] ( ) * ranger/ext/rifle.py ( ) * make install ( ) make a release commit: ( ) * update the number in the README ( ) * update the number in ranger/__init__.py ( ) * update the version number in ranger/ext/rifle.py ( ) * rebuild the man page with the updated number ( ) * write changelog entry ( ) * think of a witty commit message ( ) * change VERSION in ranger/__init__.py to something with "stable" ( ) * push the commit ( ) build .tar.gz with "make snapshot" ( ) make, make install and test the snapshot one last time ( ) update the website: ( ) * add the new version as ranger-stable.tar.gz ( ) * add the new version as ranger-X.Y.Z.tar.gz ( ) * update both signatures (gpg -u 0x00FB5CDF -sb ) ( ) * update the changelog ( ) * update the man page ( ) * rerun boobies.py ( ) announce the update ( ) * to the mailing list ( ) * in the arch linux forum ( ) * write a news entry on savannah ranger-1.8.1/doc/ranger.1000066400000000000000000001625311303427242700151200ustar00rootroot00000000000000.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" 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" '' . ds C` . ds C' '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 >0, 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. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" 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 "RANGER 1" .TH RANGER 1 "ranger-1.8.1" "01/08/2017" "ranger 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" ranger \- visual file manager .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBranger\fR [\fB\-\-version\fR] [\fB\-\-help\fR] [\fB\-\-debug\fR] [\fB\-\-clean\fR] [\fB\-\-confdir\fR=\fIdirectory\fR] [\fB\-\-copy\-config\fR=\fIwhich\fR] [\fB\-\-choosefile\fR=\fItarget\fR] [\fB\-\-choosefiles\fR=\fItarget\fR] [\fB\-\-choosedir\fR=\fItarget\fR] [\fB\-\-selectfile\fR=\fIfilepath\fR] [\fB\-\-list\-unused\-keys\fR] [\fB\-\-list\-tagged\-files\fR=\fItag\fR] [\fB\-\-profile\fR] [\fB\-\-cmd\fR=\fIcommand\fR] [\fIpath\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" ranger is a console file manager with \s-1VI\s0 key bindings. .SH "RESOURCES" .IX Header "RESOURCES" \&\fIThis manual\fR contains instructions on how to use and configure ranger. .PP \&\fIInside ranger\fR, you can press \fI?\fR for a list of key bindings, commands or settings. .PP The \fI\s-1README\s0\fR contains install instructions. .PP The file \fI\s-1HACKING\s0.md\fR contains guidelines for code modification. .PP The directory \fIdoc/configs\fR contains configuration files. They are usually installed to \fI/usr/share/doc/ranger/config\fR and can be obtained with ranger's \&\-\-copy\-config option. .PP The directory \fIexamples\fR contains reference implementations for ranger plugins, sample configuration files and some programs for integrating ranger with other software. They are usually installed to \&\fI/usr/share/doc/ranger/examples\fR. .PP The man page of \fIrifle\fR\|(1) describes the functions of the file opener .PP The section \fI\s-1LINKS\s0\fR of this man page contains further resources. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-d\fR, \fB\-\-debug\fR" 14 .IX Item "-d, --debug" Activate the debug mode: Whenever an error occurs, ranger will exit and print a full traceback. The default behavior is to merely print the name of the exception in the statusbar/log and try to keep running. .IP "\fB\-c\fR, \fB\-\-clean\fR" 14 .IX Item "-c, --clean" Activate the clean mode: ranger will not access or create any configuration files nor will it leave any traces on your system. This is useful when your configuration is broken, when you want to avoid clutter, etc. .IP "\fB\-r\fR \fIdir\fR, \fB\-\-confdir\fR=\fIdir\fR" 14 .IX Item "-r dir, --confdir=dir" Change the configuration directory of ranger from ~/.config/ranger to \*(L"dir\*(R". .IP "\fB\-\-copy\-config\fR=\fIfile\fR" 14 .IX Item "--copy-config=file" Create copies of the default configuration files in your local configuration directory. Existing ones will not be overwritten. Possible values: \fIall\fR, \&\fIcommands\fR, \fIcommands_full\fR, \fIrc\fR, \fIrifle\fR, \fIscope\fR. .Sp Note: You may want to disable loading of the global configuration files by exporting \fIRANGER_LOAD_DEFAULT_RC=FALSE\fR in your environment. See also: \&\fB\s-1FILES\s0\fR, \fB\s-1ENVIRONMENT\s0\fR .Sp \&\-\-copy\-config=\fBcommands\fR will copy only a small sample configuration file with a thoroughly commented example. It is recommended to keep this file tidy to avoid getting defunct commands on ranger upgrades. The full default commands.py can be copied with \-\-copy\-config=\fBcommands_full\fR, but that file will be ignored by ranger and serves only as a reference for making your own commands. .IP "\fB\-\-choosefile\fR=\fItargetfile\fR" 14 .IX Item "--choosefile=targetfile" Allows you to pick a file with ranger. This changes the behavior so that when you open a file, ranger will exit and write the absolute path of that file into \&\fItargetfile\fR. .IP "\fB\-\-choosefiles\fR=\fItargetfile\fR" 14 .IX Item "--choosefiles=targetfile" Allows you to pick multiple files with ranger. This changes the behavior so that when you open a file, ranger will exit and write the absolute paths of all selected files into \fItargetfile\fR, adding one newline after each filename. .IP "\fB\-\-choosedir\fR=\fItargetfile\fR" 14 .IX Item "--choosedir=targetfile" Allows you to pick a directory with ranger. When you exit ranger, it will write the last visited directory into \fItargetfile\fR. .IP "\fB\-\-selectfile\fR=\fItargetfile\fR" 14 .IX Item "--selectfile=targetfile" Open ranger with \fItargetfile\fR selected. .IP "\fB\-\-list\-unused\-keys\fR" 14 .IX Item "--list-unused-keys" List common keys which are not bound to any action in the \*(L"browser\*(R" context. This list is not complete, you can bind any key that is supported by curses: use the key code returned by \f(CW\*(C`getch()\*(C'\fR. .IP "\fB\-\-list\-tagged\-files\fR=\fItag\fR" 14 .IX Item "--list-tagged-files=tag" List all files which are tagged with the given tag. Note: Tags are single characters. The default tag is \*(L"*\*(R" .IP "\fB\-\-profile\fR" 14 .IX Item "--profile" Print statistics of \s-1CPU\s0 usage on exit. .IP "\fB\-\-cmd\fR=\fIcommand\fR" 14 .IX Item "--cmd=command" Execute the command after the configuration has been read. Use this option multiple times to run multiple commands. .IP "\fB\-\-version\fR" 14 .IX Item "--version" Print the version and exit. .IP "\fB\-h\fR, \fB\-\-help\fR" 14 .IX Item "-h, --help" Print a list of options and exit. .SH "CONCEPTS" .IX Header "CONCEPTS" This part explains how certain parts of ranger work and how they can be used efficiently. .SS "\s-1TAGS\s0" .IX Subsection "TAGS" Tags are single characters which are displayed left of a filename. You can use tags however you want. Press \*(L"t\*(R" to toggle tags and \*(L"ut\*(R" to remove any tags of the selection. The default tag is an Asterisk (\*(L"*\*(R"), but you can use any tag by typing \fI"\fR. .SS "\s-1PREVIEWS\s0" .IX Subsection "PREVIEWS" By default, only text files are previewed, but you can enable external preview scripts by setting the option \f(CW\*(C`use_preview_script\*(C'\fR and \f(CW\*(C`preview_files\*(C'\fR to true. .PP This default script is \fI~/.config/ranger/scope.sh\fR. It contains more documentation and calls to the programs \fIlynx\fR and \fIelinks\fR for html, \&\fIhighlight\fR for text/code, \fIimg2txt\fR for images, \fIatool\fR for archives, \&\fIpdftotext\fR for PDFs and \fImediainfo\fR for video and audio files. .PP Install these programs (just the ones you need) and scope.sh will automatically use them. .PP Independently of the preview script, there is a feature to preview images by drawing them directly into the terminal. To enable this feature, set the option \f(CW\*(C`preview_images\*(C'\fR to true and enable one of the image preview modes: .PP \fIw3m\fR .IX Subsection "w3m" .PP This does not work over ssh, requires certain terminals (tested on \*(L"xterm\*(R" and \&\*(L"urxvt\*(R") and is incompatible with tmux, although it works with screen. .PP To enable this feature, install the program \*(L"w3m\*(R" and set the option \&\f(CW\*(C`preview_images_method\*(C'\fR to w3m. .PP \fIiTerm2\fR .IX Subsection "iTerm2" .PP This only works in iTerm2 compiled with image preview support, but works over ssh. .PP To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to iterm2. .PP \fIurxvt\fR .IX Subsection "urxvt" .PP This only works in urxvt compiled with pixbuf support. Does not work over ssh. .PP Essentially this mode sets an image as a terminal background temporarily, so it will break any previously set image background. .PP To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to urxvt. .PP \fIurxvt-full\fR .IX Subsection "urxvt-full" .PP The same as urxvt but utilizing not only the preview pane but the whole terminal window. .PP To enable this feature, set the option \f(CW\*(C`preview_images_method\*(C'\fR to urxvt-full. .SS "\s-1SELECTION\s0" .IX Subsection "SELECTION" The \fIselection\fR is defined as \*(L"All marked files \s-1IF THERE ARE ANY,\s0 otherwise the current file.\*(R" Be aware of this when using the :delete command, which deletes all files in the selection. .PP You can mark files by pressing , v, etc. A yellow \fBMrk\fR symbol at the bottom right indicates that there are marked files in this directory. .SS "\s-1MACROS\s0" .IX Subsection "MACROS" Macros can be used in commands to abbreviate things. .PP .Vb 6 \& %f the highlighted file \& %d the path of the current directory \& %s the selected files in the current directory \& %t all tagged files in the current directory \& %c the full paths of the currently copied/cut files \& %p the full paths of selected files .Ve .PP The macros \f(CW%f\fR, \f(CW%d\fR, \f(CW%p\fR, and \f(CW%s\fR also have upper case variants, \f(CW%F\fR, \f(CW%D\fR, \f(CW%P\fR, and \&\f(CW%S\fR, which refer to the next tab. To refer to specific tabs, add a number in between. (%7s = selection of the seventh tab.) .PP \&\f(CW%c\fR is the only macro which ranges out of the current directory. So you may \&\*(L"abuse\*(R" the copying function for other purposes, like diffing two files which are in different directories: .PP .Vb 2 \& Yank the file A (type yy), move to the file B, then type \& @diff %c %f .Ve .PP Macros for file paths are generally shell-escaped so they can be used in the \&\f(CW\*(C`shell\*(C'\fR command. .PP Additionally, if you create a key binding that uses , a special statement which accepts any key, then the macro \f(CW%any\fR (or \f(CW%any0\fR, \f(CW%any1\fR, \f(CW%any2\fR, ...) can be used in the command to get the key that was pressed. .PP The macro \f(CW%rangerdir\fR expands to the directory of ranger's python library, you can use it for something like this command: alias show_commands shell less \f(CW%rangerdir\fR/config/commands.py .PP \&\f(CW%confdir\fR expands to the directory given by \fB\-\-confdir\fR. .PP The macro \f(CW%space\fR expands to a space character. You can use it to add spaces to the end of a command when needed, while preventing editors to strip spaces off the end of the line automatically. .PP To write a literal %, you need to escape it by writing %%. .SS "\s-1BOOKMARKS\s0" .IX Subsection "BOOKMARKS" Type \fBm\fR to bookmark the current directory. You can re-enter this directory by typing \fB`\fR. can be any letter or digit. Unlike vim, both lowercase and uppercase bookmarks are persistent. .PP Each time you jump to a bookmark, the special bookmark at key ` will be set to the last directory. So typing \*(L"``\*(R" gets you back to where you were before. .PP Bookmarks are selectable when tabbing in the :cd command. .PP Note: The bookmarks ' (Apostrophe) and ` (Backtick) are the same. .SS "\s-1RIFLE\s0" .IX Subsection "RIFLE" Rifle is the file opener of ranger. It can be used as a standalone program or a python module. It is located at \fIranger/ext/rifle.py\fR. In contrast to other, more simple file openers, rifle can automatically find installed programs so it can be used effectively out of the box on a variety of systems. .PP It's configured in \fIrifle.conf\fR through a list of conditions and commands. For each line the conditions are checked and if they are met, the respective command is taken into consideration. By default, simply the first matching rule is used. In ranger, you can list and choose rules by typing \*(L"r\*(R" or simply by typing \*(L"\*(R". If you use rifle standalone, you can list all rules with the \*(L"\-l\*(R" option and pick a rule with \*(L"\-p \*(R". .PP The rules, along with further documentation, are contained in \&\fIranger/config/rifle.conf\fR. .SS "\s-1FLAGS\s0" .IX Subsection "FLAGS" Flags give you a way to modify the behavior of the spawned process. They are used in the commands \f(CW\*(C`:open_with\*(C'\fR (key \*(L"r\*(R") and \f(CW\*(C`:shell\*(C'\fR (key \*(L"!\*(R"). .PP .Vb 4 \& f Fork the process. (Run in background) \& c Run the current file only, instead of the selection \& r Run application with root privilege (requires sudo) \& t Run application in a new terminal window .Ve .PP There are some additional flags that can currently be used only in the \f(CW\*(C`shell\*(C'\fR command: (for example \f(CW\*(C`:shell \-w df\*(C'\fR) .PP .Vb 3 \& p Redirect output to the pager \& s Silent mode. Output will be discarded. \& w Wait for an Enter\-press when the process is done .Ve .PP By default, all the flags are off unless specified otherwise in the \&\fIrifle.conf\fR configuration file. You can specify as many flags as you want. An uppercase flag negates the effect: \*(L"ffcccFsf\*(R" is equivalent to \*(L"cs\*(R". .PP The terminal program name for the \*(L"t\*(R" flag is taken from the environment variable \f(CW$TERMCMD\fR. If it doesn't exist, it tries to extract it from \f(CW$TERM\fR and uses \*(L"xterm\*(R" as a fallback if that fails. .PP Examples: \f(CW\*(C`:open_with c\*(C'\fR will open the file that you currently point at, even if you have selected other files. \f(CW\*(C`:shell \-w df\*(C'\fR will run \*(L"df\*(R" and wait for you to press Enter before switching back to ranger. .SS "\s-1PLUGINS\s0" .IX Subsection "PLUGINS" ranger's plugin system consists of python files which are located in \&\fI~/.config/ranger/plugins/\fR and are imported in alphabetical order when starting ranger. A plugin changes rangers behavior by overwriting or extending a function that ranger uses. This allows you to change pretty much every part of ranger, but there is no guarantee that things will continue to work in future versions as the source code evolves. .PP Adding new commands via a plugin as simple as specifying them like you would do in the \fIcommands.py\fR. .PP There are some hooks that are specifically made for the use in plugins. They are functions that start with hook_ and can be found throughout the code. .PP .Vb 1 \& grep \*(Aqdef hook_\*(Aq \-r /path/to/rangers/source .Ve .PP Also try: .PP .Vb 1 \& pydoc ranger.api .Ve .PP Note that you should \s-1NOT\s0 simply overwrite a function unless you know what you're doing. Instead, save the existing function and call it from your new one. This way, multiple plugins can use the same hook. There are several sample plugins in the \fI/usr/share/doc/ranger/examples/\fR directory, including a hello-world plugin that describes this procedure. .SH "KEY BINDINGS" .IX Header "KEY BINDINGS" Key bindings are defined in the file \fIranger/config/rc.conf\fR. Check this file for a list of all key bindings. You can copy it to your local configuration directory with the \-\-copy\-config=rc option. .PP Many key bindings take an additional numeric argument. Type \fI5j\fR to move down 5 lines, \fI2l\fR to open a file in mode 2, \fI10\fR to mark 10 files. .PP This list contains the most useful bindings: .SS "\s-1MAIN BINDINGS\s0" .IX Subsection "MAIN BINDINGS" .IP "h, j, k, l" 14 .IX Item "h, j, k, l" Move left, down, up or right .IP "^D or J, ^U or K" 14 .IX Item "^D or J, ^U or K" Move a half page down, up .IP "H, L" 14 .IX Item "H, L" Move back and forward in the history .IP "gg" 14 .IX Item "gg" Move to the top .IP "G" 14 .IX Item "G" Move to the bottom .IP "[, ]" 14 Move up and down in the parent directory. .IP "^R" 14 .IX Item "^R" Reload everything .IP "^L" 14 .IX Item "^L" Redraw the screen .IP "i" 14 .IX Item "i" Inspect the current file in a bigger window. .IP "E" 14 .IX Item "E" Edit the current file in \f(CW$EDITOR\fR (\*(L"nano\*(R" by default) .IP "S" 14 .IX Item "S" Open a shell in the current directory .IP "?" 14 Opens this man page .IP "W" 14 .IX Item "W" Opens the log window where you can review messages that pop up at the bottom. .IP "w" 14 .IX Item "w" Opens the task window where you can view and modify background processes that currently run in ranger. In there, you can type \*(L"dd\*(R" to abort a process and \&\*(L"J\*(R" or \*(L"K\*(R" to change the priority of a process. Only one process is run at a time. .IP "^C" 14 .IX Item "^C" Stop the currently running background process that ranger has started, like copying files, loading directories or file previews. .IP "=, +, \-" 14 .IX Item "=, +, -" Change the permissions of the selection. For example, \f(CW\*(C`777=\*(C'\fR is equivalent to \&\f(CW\*(C`chmod 777 %s\*(C'\fR, \f(CW\*(C`+ar\*(C'\fR does \f(CW\*(C`chmod a+r %s\*(C'\fR, \f(CW\*(C`\-ow\*(C'\fR does \f(CW\*(C`chmod o\-w %s\*(C'\fR etc. .IP "yy" 14 .IX Item "yy" Copy (yank) the selection, like pressing Ctrl+C in modern \s-1GUI\s0 programs. (You can also type \*(L"ya\*(R" to add files to the copy buffer, \*(L"yr\*(R" to remove files again, or \*(L"yt\*(R" for toggling.) .IP "dd" 14 .IX Item "dd" Cut the selection, like pressing Ctrl+X in modern \s-1GUI\s0 programs. (There are also \*(L"da\*(R", \*(L"dr\*(R" and \*(L"dt\*(R" shortcuts equivalent to \*(L"ya\*(R", \*(L"yr\*(R" and \*(L"yt\*(R".) .IP "pp" 14 .IX Item "pp" Paste the files which were previously copied or cut, like pressing Ctrl+V in modern \s-1GUI\s0 programs. .IP "po" 14 .IX Item "po" Paste the copied/cut files, overwriting existing files. .IP "pP, pO" 14 .IX Item "pP, pO" Like pp and po, but queues the operation so that it will be executed \fIafter\fR any other operations. Reminder: type \f(CW\*(C`w\*(C'\fR to open the task window. .IP "pl, pL" 14 .IX Item "pl, pL" Create symlinks (absolute or relative) to the copied files .IP "phl" 14 .IX Item "phl" Create hardlinks to the copied files .IP "pht" 14 .IX Item "pht" Duplicate the subdirectory tree of the copied directory, then create hardlinks for each contained file into the new directory tree. .IP "m\fIX\fR" 14 .IX Item "mX" Create a bookmark with the name \fIX\fR .IP "`\fIX\fR" 14 .IX Item "`X" Move to the bookmark with the name \fIX\fR .IP "n" 14 .IX Item "n" Find the next file. By default, this gets you to the newest file in the directory, but if you search something using the keys /, cm, ct, ..., it will get you to the next found entry. .IP "N" 14 .IX Item "N" Find the previous file. .IP "o\fIX\fR" 14 .IX Item "oX" Change the sort method (like in mutt) .IP "z\fIX\fR" 14 .IX Item "zX" Change settings. See the settings section for a list of settings and their hotkey. .IP "u\fI?\fR" 14 .IX Item "u?" Universal undo-key. Depending on the key that you press after \*(L"u\*(R", it either restores closed tabs (uq), removes tags (ut), clears the copy/cut buffer (ud), starts the reversed visual mode (uV) or clears the selection (uv). .IP "f" 14 .IX Item "f" Quickly navigate by entering a part of the filename. .IP "Space" 14 .IX Item "Space" Mark a file. .IP "v" 14 .IX Item "v" Toggle the mark-status of all files .IP "V" 14 .IX Item "V" Starts the visual mode, which selects all files between the starting point and the cursor until you press \s-1ESC. \s0 To unselect files in the same way, use \*(L"uV\*(R". .IP "/" 14 Search for files in the current directory. .IP ":" 14 Open the console. .IP "!" 14 Open the console with the content \*(L"shell \*(R" so you can quickly run commands .IP "@" 14 Open the console with the content \*(L"shell \f(CW%s\fR\*(R", placing the cursor before the \&\*(L" \f(CW%s\fR\*(R" so you can quickly run commands with the current selection as the argument. .IP "r" 14 .IX Item "r" Open the console with the content \*(L"open with \*(R" so you can decide which program to use to open the current file selection. .IP "cd" 14 .IX Item "cd" Open the console with the content \*(L"cd \*(R" .IP "Alt\-\fIN\fR" 14 .IX Item "Alt-N" Open a tab. N has to be a number from 0 to 9. If the tab doesn't exist yet, it will be created. .IP "gn, ^N" 14 .IX Item "gn, ^N" Create a new tab. .IP "gt, gT" 14 .IX Item "gt, gT" Go to the next or previous tab. You can also use \s-1TAB\s0 and \s-1SHIFT+TAB\s0 instead. .IP "gc, ^W" 14 .IX Item "gc, ^W" Close the current tab. The last tab cannot be closed this way. .IP "M" 14 .IX Item "M" A key chain that allows you to quickly change the line mode of all the files of the current directory. For a more permanent solution, use the command \&\*(L"default_linemode\*(R" in your rc.conf. .SS "READLINE-LIKE \s-1BINDINGS IN THE CONSOLE\s0" .IX Subsection "READLINE-LIKE BINDINGS IN THE CONSOLE" .IP "^B, ^F" 14 .IX Item "^B, ^F" Move left and right (B for back, F for forward) .IP "^P, ^N" 14 .IX Item "^P, ^N" Move up and down (P for previous, N for Next) .IP "^A, ^E" 14 .IX Item "^A, ^E" Move to the start or to the end .IP "^D" 14 .IX Item "^D" Delete the current character. .IP "^H" 14 .IX Item "^H" Backspace. .SH "MOUSE BUTTONS" .IX Header "MOUSE BUTTONS" .IP "Left Mouse Button" 4 .IX Item "Left Mouse Button" Click on something and you'll move there. To run a file, \*(L"enter\*(R" it, like a directory, by clicking on the preview. .IP "Right Mouse Button" 4 .IX Item "Right Mouse Button" Enter a directory or run a file. .IP "Scroll Wheel" 4 .IX Item "Scroll Wheel" Scrolls up or down. You can point at the column of the parent directory while scrolling to switch directories. .SH "SETTINGS" .IX Header "SETTINGS" This section lists all built-in settings of ranger. The valid types for the value are in [brackets]. The hotkey to toggle the setting is in , if a hotkey exists. .PP Settings can be changed in the file \fI~/.config/ranger/rc.conf\fR or on the fly with the command \fB:set option value\fR. Examples: .PP .Vb 2 \& set column_ratios 1,2,3 \& set show_hidden true .Ve .PP Toggling options can be done with: .PP .Vb 1 \& set show_hidden! .Ve .PP The different types of settings and an example for each type: .PP .Vb 7 \& setting type | example values \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& bool | true, false \& integer | 1, 23, 1337 \& string | foo, hello world \& list | 1,2,3,4 \& none | none .Ve .PP You can view a list of all settings and their current values by pressing \*(L"3?\*(R" in ranger. .IP "automatically_count_files [bool]" 4 .IX Item "automatically_count_files [bool]" Should ranger count and display the number of files in each directory as soon as it's visible? This gets slow with remote file sytems. Turning it off will still allow you to see the number of files after entering the directory. .IP "autosave_bookmarks [bool]" 4 .IX Item "autosave_bookmarks [bool]" Save bookmarks (used with mX and `X) instantly? This helps to synchronize bookmarks between multiple ranger instances but leads to *slight* performance loss. When false, bookmarks are saved when ranger is exited. .IP "autoupdate_cumulative_size [bool]" 4 .IX Item "autoupdate_cumulative_size [bool]" You can display the \*(L"real\*(R" cumulative size of directories by using the command :get_cumulative_size or typing \*(L"dc\*(R". The size is expensive to calculate and will not be updated automatically. You can choose to update it automatically though by turning on this option. .IP "cd_bookmarks [bool]" 4 .IX Item "cd_bookmarks [bool]" Specify whether bookmarks should be included in the tab completion of the \*(L"cd\*(R" command. .IP "collapse_preview [bool] " 4 .IX Item "collapse_preview [bool] " When no preview is visible, should the last column be squeezed to make use of the whitespace? .IP "colorscheme [string]" 4 .IX Item "colorscheme [string]" Which colorscheme to use? These colorschemes are available by default: \&\fBdefault\fR, \fBjungle\fR, \fBsnow\fR. Snow is a monochrome scheme, jungle replaces blue directories with green ones for better visibility on certain terminals. .IP "column_ratios [list]" 4 .IX Item "column_ratios [list]" How many columns are there, and what are their relative widths? For example, a value of 1,1,1 would mean 3 evenly sized columns. 1,1,1,1,4 means 5 columns with the preview column being as large as the other columns combined. .IP "confirm_on_delete [string]" 4 .IX Item "confirm_on_delete [string]" Ask for a confirmation when running the \*(L"delete\*(R" command? Valid values are \&\*(L"always\*(R" (default), \*(L"never\*(R", \*(L"multiple\*(R". With \*(L"multiple\*(R", ranger will ask only if you delete multiple files at once. .IP "dirname_in_tabs [bool]" 4 .IX Item "dirname_in_tabs [bool]" Display the directory name in tabs? .IP "display_size_in_main_column [bool]" 4 .IX Item "display_size_in_main_column [bool]" Display the file size in the main column? .IP "display_size_in_status_bar [bool]" 4 .IX Item "display_size_in_status_bar [bool]" Display the file size in the status bar? .IP "display_tags_in_all_columns [bool]" 4 .IX Item "display_tags_in_all_columns [bool]" Display tags in all columns? .IP "draw_borders [bool]" 4 .IX Item "draw_borders [bool]" Draw borders around columns? .IP "draw_progress_bar_in_status_bar [bool]" 4 .IX Item "draw_progress_bar_in_status_bar [bool]" Draw a progress bar in the status bar which displays the average state of all currently running tasks which support progress bars? .IP "flushinput [bool] " 4 .IX Item "flushinput [bool] " Flush the input after each key hit? One advantage is that when scrolling down with \*(L"j\*(R", ranger stops scrolling instantly when you release the key. One disadvantage is that when you type commands blindly, some keys might get lost. .IP "hidden_filter [string]" 4 .IX Item "hidden_filter [string]" A regular expression pattern for files which should be hidden. For example, this pattern will hide all files that start with a dot or end with a tilde. .Sp .Vb 1 \& set hidden_filter ^\e.|~$ .Ve .IP "idle_delay [integer]" 4 .IX Item "idle_delay [integer]" The delay that ranger idly waits for user input, in milliseconds, with a resolution of 100ms. Lower delay reduces lag between directory updates but increases \s-1CPU\s0 load. .IP "line_numbers [string]" 4 .IX Item "line_numbers [string]" Show line numbers in main column. Possible values are: .Sp .Vb 3 \& false turn the feature off \& absolute absolute line numbers for use with "gg" \& relative relative line numbers for "k" or "j" .Ve .IP "max_console_history_size [integer, none]" 4 .IX Item "max_console_history_size [integer, none]" How many console commands should be kept in history? \*(L"none\*(R" will disable the limit. .IP "max_history_size [integer, none]" 4 .IX Item "max_history_size [integer, none]" How many directory changes should be kept in history? .IP "metadata_deep_search [bool]" 4 .IX Item "metadata_deep_search [bool]" When the metadata manager module looks for metadata, should it only look for a \&\*(L".metadata.json\*(R" file in the current directory, or do a deep search and check all directories above the current one as well? .IP "mouse_enabled [bool] " 4 .IX Item "mouse_enabled [bool] " Enable mouse input? .IP "padding_right [bool]" 4 .IX Item "padding_right [bool]" When collapse_preview is on and there is no preview, should there remain a little padding on the right? This allows you to click into that space to run the file. .IP "preview_directories [bool] " 4 .IX Item "preview_directories [bool] " Preview directories in the preview column? .IP "preview_files [bool] " 4 .IX Item "preview_files [bool] " Preview files in the preview column? .IP "preview_images [bool]" 4 .IX Item "preview_images [bool]" Draw images inside the console with the external program w3mimgpreview? .IP "preview_max_size [int]" 4 .IX Item "preview_max_size [int]" Avoid previewing files that exceed a certain size, in bytes. Use a value of 0 to disable this feature. .IP "preview_script [string, none]" 4 .IX Item "preview_script [string, none]" Which script should handle generating previews? If the file doesn't exist, or use_preview_script is off, ranger will handle previews itself by just printing the content. .IP "save_console_history [bool]" 4 .IX Item "save_console_history [bool]" Should the console history be saved on exit? If disabled, the console history is reset when you restart ranger. .IP "scroll_offset [integer]" 4 .IX Item "scroll_offset [integer]" Try to keep this much space between the top/bottom border when scrolling. .IP "shorten_title [integer]" 4 .IX Item "shorten_title [integer]" Trim the title of the window if it gets long? The number defines how many directories are displayed at once. A value of 0 turns off this feature. .IP "show_cursor [bool]" 4 .IX Item "show_cursor [bool]" Always show the terminal cursor? .IP "show_hidden_bookmarks [bool]" 4 .IX Item "show_hidden_bookmarks [bool]" Show dotfiles in the bookmark preview window? (Type ') .IP "show_hidden [bool] , <^H>" 4 .IX Item "show_hidden [bool] , <^H>" Show hidden files? .IP "sort_case_insensitive [bool] " 4 .IX Item "sort_case_insensitive [bool] " Sort case-insensitively? If true, \*(L"a\*(R" will be listed before \*(L"B\*(R" even though its \s-1ASCII\s0 value is higher. .IP "sort_directories_first [bool] " 4 .IX Item "sort_directories_first [bool] " Sort directories first? .IP "sort_reverse [bool] " 4 .IX Item "sort_reverse [bool] " Reverse the order of files? .IP "sort_unicode [bool]" 4 .IX Item "sort_unicode [bool]" When sorting according to some string, should the unicode characters be compared, instead of looking at the raw character values to save time? .IP "sort [string] , , , , , , , , " 4 .IX Item "sort [string] , , , , , , , , " Which sorting mechanism should be used? Choose one of \fBatime\fR, \fBbasename\fR, \&\fBctime\fR, \fBextension\fR, \fBmtime\fR, \fBnatural\fR, \fBtype\fR, \fBsize\fR, \fBrandom\fR .Sp Note: You can reverse the order by typing an uppercase second letter in the key combination, e.g. \*(L"oN\*(R" to sort from Z to A. .IP "status_bar_on_top [bool]" 4 .IX Item "status_bar_on_top [bool]" Put the status bar at the top of the window? .IP "tilde_in_titlebar [bool]" 4 .IX Item "tilde_in_titlebar [bool]" Abbreviate \f(CW$HOME\fR with ~ in the title bar (first line) of ranger? .IP "unicode_ellipsis [bool]" 4 .IX Item "unicode_ellipsis [bool]" Use a unicode \*(L"...\*(R" character instead of \*(L"~\*(R" to mark cut-off filenames? .IP "update_title [bool]" 4 .IX Item "update_title [bool]" Set a window title? .IP "update_tmux_title [bool]" 4 .IX Item "update_tmux_title [bool]" Set the title to \*(L"ranger\*(R" in the tmux program? .IP "use_preview_script [bool] " 4 .IX Item "use_preview_script [bool] " Use the preview script defined in the setting \fIpreview_script\fR? .IP "vcs_aware [bool]" 4 .IX Item "vcs_aware [bool]" Gather and display data about version control systems. Supported vcs: git, hg. .IP "vcs_backend_git, vcs_backend_hg, vcs_backend_bzr [string]" 4 .IX Item "vcs_backend_git, vcs_backend_hg, vcs_backend_bzr [string]" Sets the state for the version control backend. The possible values are: .Sp .Vb 3 \& disabled don\*(Aqt display any information. \& local display only local state. \& enabled display both, local and remote state. May be slow for hg and bzr. .Ve .IP "xterm_alt_key [bool]" 4 .IX Item "xterm_alt_key [bool]" Enable this if key combinations with the Alt Key don't work for you. (Especially on xterm) .IP "clear_filters_on_dir_change [bool]" 4 .IX Item "clear_filters_on_dir_change [bool]" If set to 'true', persistent filters would be cleared upon leaving the directory .SH "COMMANDS" .IX Header "COMMANDS" You can enter the commands in the console which is opened by pressing \*(L":\*(R". .PP You can always get a list of the currently existing commands by typing \*(L"2?\*(R" in ranger. For your convenience, this is a list of the \*(L"public\*(R" commands including their parameters, excluding descriptions: .PP .Vb 10 \& 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 \& 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 \& rename newname \& save_copy_buffer \& scout [\-FLAGS] pattern \& search pattern \& search_inc pattern \& set option value \& setintag tags option value \& setlocal [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] .Ve .PP 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. .PP These are the public commands including their descriptions: .IP "alias [\fInewcommand\fR] [\fIoldcommand\fR]" 2 .IX Item "alias [newcommand] [oldcommand]" Copies the oldcommand as newcommand. .IP "bulkrename" 2 .IX 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. .Sp This shell script is opened in an editor for you to review. After you close it, it will be executed. .IP "cd [\fIdirectory\fR]" 2 .IX Item "cd [directory]" The cd command changes the directory. The command \f(CW\*(C`:cd \-\*(C'\fR is equivalent to typing ``. .IP "chain \fIcommand1\fR[; \fIcommand2\fR[; \fIcommand3\fR...]]" 2 .IX Item "chain command1[; command2[; command3...]]" Combines multiple commands into one, separated by semicolons. .IP "chmod \fIoctal_number\fR" 2 .IX Item "chmod octal_number" Sets the permissions of the selection to the octal number. .Sp 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. .Sp Key bindings in the form of [\-+] and = also exist. For example, \fB+ar\fR allows reading for everyone, \-ow forbids others to write and 777= allows everything. .Sp See also: man 1 chmod .IP "cmap \fIkey\fR \fIcommand\fR" 2 .IX Item "cmap key command" Binds keys for the console. Works like the \f(CW\*(C`map\*(C'\fR command. .IP "console [\-p\fIN\fR] \fIcommand\fR" 2 .IX Item "console [-pN] command" Opens the console with the command already typed in. The cursor is placed at \&\fIN\fR. .IP "copycmap \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2 .IX Item "copycmap key newkey [newkey2 ...]" See \f(CW\*(C`copymap\*(C'\fR .IP "copymap \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2 .IX Item "copymap key newkey [newkey2 ...]" Copies the keybinding \fIkey\fR to \fInewkey\fR in the \*(L"browser\*(R" context. This is a deep copy, so if you change the new binding (or parts of it) later, the old one is not modified. .Sp To copy key bindings of the console, taskview, or pager use \*(L"copycmap\*(R", \&\*(L"copytmap\*(R" or \*(L"copypmap\*(R". .IP "copypmap \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2 .IX Item "copypmap key newkey [newkey2 ...]" See \f(CW\*(C`copymap\*(C'\fR .IP "copytmap \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2 .IX Item "copytmap key newkey [newkey2 ...]" See \f(CW\*(C`copymap\*(C'\fR .IP "cunmap [\fIkeys...\fR]" 2 .IX Item "cunmap [keys...]" Removes key mappings of the console. Works like the \f(CW\*(C`unmap\*(C'\fR command. .IP "default_linemode [\fIpath=regexp\fR | \fItag=tags\fR] \fIlinemodename\fR" 2 .IX Item "default_linemode [path=regexp | tag=tags] linemodename" Sets the default linemode. See \fIlinemode\fR command. .Sp Examples: .Sp Set the global default linemode to \*(L"permissions\*(R": :default_linemode permissions .Sp Set the default linemode to \*(L"permissions\*(R" for all files tagged with \*(L"p\*(R" or \*(L"P\*(R": :default_linemode tag=pP permissions .Sp Set the default linemode for all files in ~/books/ to \*(L"metatitle\*(R": :default_linemode path=/home/.*?/books/.* metatitle .IP "delete" 2 .IX 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 \*(L"confirm_on_delete\*(R". .IP "echo \fItext\fR" 2 .IX Item "echo text" Display the text in the statusbar. .IP "edit [\fIfilename\fR]" 2 .IX Item "edit [filename]" Edit the current file or the file in the argument. .IP "eval [\fI\-q\fR] \fIpython_code\fR" 2 .IX Item "eval [-q] python_code" Evaluates the python code. `fm' is a reference to the \s-1FM\s0 instance. To display text, use the function `p'. The result is displayed on the screen unless you use the \*(L"\-q\*(R" option. .Sp Examples: :eval fm :eval len(fm.tabs) :eval p(\*(L"Hello World!\*(R") .IP "filter [\fIstring\fR]" 2 .IX Item "filter [string]" Displays only the files which contain the \fIstring\fR in their basename. Running this command without any parameter will reset the filter. .Sp This command is based on the \fIscout\fR command and supports all of its options. .IP "filter_inode_type [dfl]" 2 .IX 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. .IP "find \fIpattern\fR" 2 .IX Item "find 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.) .Sp This command is based on the \fIscout\fR command and supports all of its options. .IP "flat level" 2 .IX 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. .IP "grep \fIpattern\fR" 2 .IX Item "grep pattern" Looks for a string in all marked files or directories. .IP "help" 2 .IX Item "help" Provides a quick way to view ranger documentations. .IP "linemode \fIlinemodename\fR" 2 .IX Item "linemode linemodename" Sets the linemode of all files in the current directory. The linemode may be: .Sp .Vb 6 \& "filename": display each line as "..." \& "fileinfo": display each line as "..." \& "permissions": display each line as " " \& "metatitle": display metadata from .metadata.json files if \& available, fall back to the "filename" linemode if no \& metadata was found. See :meta command. .Ve .Sp The custom linemodes may be added by subclassing the \fILinemodeBase\fR class. See the \fIranger.core.linemode\fR module for some examples. .IP "load_copy_buffer" 2 .IX Item "load_copy_buffer" Load the copy buffer from \fI~/.config/ranger/copy_buffer\fR. This can be used to pass the list of copied files to another ranger instance. .IP "map \fIkey\fR \fIcommand\fR" 2 .IX Item "map key 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 \&\*(L"self.quantifier\*(R". .Sp 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 \&\*(L"cmap\*(R", \*(L"tmap\*(R" or \*(L"pmap\*(R". .IP "mark \fIpattern\fR" 2 .IX Item "mark pattern" Mark all files matching the regular expression pattern. .Sp This command is based on the \fIscout\fR command and supports all of its options. .IP "mark_tag [\fItags\fR]" 2 .IX Item "mark_tag [tags]" Mark all tags that are tagged with either of the given tags. When leaving out the tag argument, all tagged files are marked. .IP "meta \fIkey\fR \fIvalue\fR" 2 .IX Item "meta key value" Set the metadata of the currently highlighted file. Example: .Sp .Vb 2 \& :meta title The Hitchhiker\*(Aqs Guide to the Galaxy \& :meta year 1979 .Ve .Sp This metadata can be displayed by, for example, using the \*(L"metatitle\*(R" line mode by typing Mt. .IP "mkdir \fIdirname\fR" 2 .IX Item "mkdir dirname" Creates a directory with the name \fIdirname\fR. .IP "open_with [\fIapplication\fR] [\fIflags\fR] [\fImode\fR]" 2 .IX Item "open_with [application] [flags] [mode]" Open the selected files with the given application, unless it is omitted, in which case the default application is used. \fIflags\fR change the way the application is executed and are described in their own section in this man page. The \fImode\fR is a number that specifies which application to use. The list of applications is generated by the external file opener \*(L"rifle\*(R" and can be displayed when pressing \*(L"r\*(R" in ranger. .Sp Note that if you specify an application, the mode is ignored. .IP "pmap \fIkey\fR \fIcommand\fR" 2 .IX Item "pmap key command" Binds keys for the pager. Works like the \f(CW\*(C`map\*(C'\fR command. .IP "prompt_metadata [\fIkeys ...\fR]" 2 .IX Item "prompt_metadata [keys ...]" Prompt the user to input metadata with the \f(CW\*(C`meta\*(C'\fR command for multiple keys in a row. .IP "punmap [\fIkeys ...\fR]" 2 .IX Item "punmap [keys ...]" Removes key mappings of the pager. Works like the \f(CW\*(C`unmap\*(C'\fR command. .IP "quit" 2 .IX Item "quit" Like quit!, but closes only this tab if multiple tabs are open. .IP "quit!" 2 .IX 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. .IP "relink \fInewpath\fR" 2 .IX Item "relink newpath" Change the link destination of the current symlink file to . First will load the original link. .IP "rename_append" 2 .IX Item "rename_append" Opens the console with \*(L":rename \*(R" with the cursor automatically placed before the file extension .IP "rename \fInewname\fR" 2 .IX Item "rename 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. .IP "save_copy_buffer" 2 .IX Item "save_copy_buffer" Save the copy buffer to \fI~/.config/ranger/copy_buffer\fR. This can be used to pass the list of copied files to another ranger instance. .IP "scout [\-\fIflags\fR...] [\-\-] \fIpattern\fR" 2 .IX Item "scout [-flags...] [--] pattern" Swiss army knife command for searching, traveling and filtering files. The command takes various flags as arguments which can be used to influence its behaviour: .Sp .Vb 10 \& \-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 .Ve .Sp Multiple flags can be combined. For example, \*(L":scout \-gpt\*(R" would create a :filter\-like command using globbing. .IP "search \fIpattern\fR" 2 .IX Item "search pattern" Search files in the current directory that match the given (case insensitive) regular expression pattern. .Sp This command is based on the \fIscout\fR command and supports all of its options. .IP "search_inc \fIpattern\fR" 2 .IX Item "search_inc 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. .Sp This command is based on the \fIscout\fR command and supports all of its options. .IP "set \fIoption\fR \fIvalue\fR" 2 .IX Item "set option 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: .Sp .Vb 7 \& setting type | example values \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& bool | true, false \& integer | 1, 23, 1337 \& string | foo, hello world \& list | 1,2,3,4 \& none | none .Ve .IP "setintag \fItags\fR \fIoption\fR \fIvalue\fR" 2 .IX Item "setintag tags option value" Assigns a new value to an option, but locally for the directories that are marked with \fItag\fR. This means, that this option only takes effect when visiting that directory. .Sp For example, to change the sorting order in your downloads directory, tag it with the \fIv\fR tag by typing \fI"v\fR, then use this command: .Sp .Vb 1 \& setintag v sort ctime .Ve .IP "setlocal [path=\fIpath\fR] \fIoption\fR \fIvalue\fR" 2 .IX Item "setlocal [path=path] option value" Assigns a new value to an option, but locally for the directory given by \&\fIpath\fR. This means, that this option only takes effect when visiting that directory. If no path is given, uses the current directory. .Sp \&\fIpath\fR is a regular expression. This means that \f(CW\*(C`path=~/dl\*(C'\fR applies to all paths that start with \fI~/dl\fR, e.g. \fI~/dl2\fR and \fI~/dl/foo\fR. To avoid this, use \f(CW\*(C`path=~/dl$\*(C'\fR. .IP "shell [\-\fIflags\fR] \fIcommand\fR" 2 .IX Item "shell [-flags] command" Run a shell command. \fIflags\fR are discussed in their own section. .IP "source \fIfilename\fR" 2 .IX Item "source filename" Reads commands from a file and executes them in the ranger console. .Sp This can be used to re-evaluate the rc.conf file after changing it: .Sp .Vb 1 \& map X chain shell vim \-p %confdir/rc.conf %rangerdir/config/rc.conf; source %confdir/rc.conf .Ve .IP "terminal" 2 .IX Item "terminal" Spawns the \fIx\-terminal-emulator\fR starting in the current directory. .IP "tmap \fIkey\fR \fIcommand\fR" 2 .IX Item "tmap key command" Binds keys for the taskview. Works like the \f(CW\*(C`map\*(C'\fR command. .IP "touch \fIfilename\fR" 2 .IX Item "touch filename" Creates an empty file with the name \fIfilename\fR, unless it already exists. .IP "travel \fIpattern\fR" 2 .IX Item "travel 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 \s-1ESC\s0 or execute a file. .Sp This command is based on the \fIscout\fR command and supports all of its options. .IP "tunmap [\fIkeys ...\fR]" 2 .IX Item "tunmap [keys ...]" Removes key mappings of the taskview. Works like the \f(CW\*(C`unmap\*(C'\fR command. .IP "unmap [\fIkeys\fR ...]" 2 .IX Item "unmap [keys ...]" Removes the given key mappings in the \*(L"browser\*(R" context. To unmap key bindings in the console, taskview, or pager use \*(L"cunmap\*(R", \*(L"tunmap\*(R" or \*(L"punmap\*(R". .IP "unmark \fIpattern\fR" 2 .IX Item "unmark pattern" Unmark all files matching a regular expression pattern. .Sp This command is based on the \fIscout\fR command and supports all of its options. .IP "unmark_tag [\fItags\fR]" 2 .IX Item "unmark_tag [tags]" Unmark all tags that are tagged with either of the given tags. When leaving out the tag argument, all tagged files are unmarked. .SH "FILES" .IX Header "FILES" ranger reads several configuration files which are located in \&\fI\f(CI$HOME\fI/.config/ranger\fR or \fI\f(CI$XDG_CONFIG_HOME\fI/ranger\fR if \f(CW$XDG_CONFIG_HOME\fR is defined. You can use the \-\-copy\-config option to obtain the default configuration files. Each of the files contains further documentation. .PP You don't need to copy the whole file though, most configuration files are overlaid on top of the defaults (\fIcommands.py\fR, \fIrc.conf\fR) or can be sub-classed (\fIcolorschemes\fR). .PP That being said, the user configuration files \fIrc.conf\fR and \fIcommands.py\fR 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: \&\fB\s-1ENVIRONMENT\s0\fR). .PP When starting ranger with the \fB\-\-clean\fR option, it will not access or create any of these files. .SS "\s-1CONFIGURATION\s0" .IX Subsection "CONFIGURATION" .IP "rc.conf" 10 .IX Item "rc.conf" Contains a list of commands which are executed on startup. Mostly key bindings and settings are defined here. .IP "commands.py" 10 .IX Item "commands.py" A python module that defines commands which can be used in ranger's console by typing \*(L":\*(R" or in the rc.conf file. Note that you can define commands in the same manner within plugins. .IP "commands_full.py" 10 .IX 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. .IP "rifle.conf" 10 .IX Item "rifle.conf" This is the configuration file for the built-in file launcher called \*(L"rifle\*(R". .IP "scope.sh" 10 .IX Item "scope.sh" This is a script that handles file previews. When the options \&\fIuse_preview_script\fR and \fIpreview_files\fR are set, the program specified in the option \fIpreview_script\fR is run and its output and/or exit code determines rangers reaction. .IP "colorschemes/" 10 .IX Item "colorschemes/" Colorschemes can be placed here. .IP "plugins/" 10 .IX Item "plugins/" Plugins can be placed here. .SS "\s-1STORAGE\s0" .IX Subsection "STORAGE" .IP "bookmarks" 10 .IX 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, accessed by typing \&' and deleted by typing um. .IP "copy_buffer" 10 .IX 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. .IP "history" 10 .IX Item "history" Contains a list of commands that have been previously typed in. .IP "tagged" 10 .IX 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 ". .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" These environment variables have an effect on ranger: .IP "\s-1RANGER_LEVEL\s0" 8 .IX Item "RANGER_LEVEL" ranger sets this environment variable to \*(L"1\*(R" or increments it if it already exists. External programs can determine whether they were spawned from ranger by checking for this variable. .IP "\s-1RANGER_LOAD_DEFAULT_RC\s0" 8 .IX Item "RANGER_LOAD_DEFAULT_RC" If this variable is set to \s-1FALSE,\s0 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. .IP "\s-1EDITOR\s0" 8 .IX Item "EDITOR" Defines the editor to be used for the \*(L"E\*(R" key. Defaults to \*(L"nano\*(R". .IP "\s-1SHELL\s0" 8 .IX Item "SHELL" Defines the shell that ranger is going to use with the :shell command and the \*(L"S\*(R" key. Defaults to \*(L"/bin/sh\*(R". .IP "\s-1TERMCMD\s0" 8 .IX Item "TERMCMD" Defines the terminal emulator command that ranger is going to use with the :terminal command and the \*(L"t\*(R" run flag. Defaults to \*(L"xterm\*(R". .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. .IP "\s-1PYTHONOPTIMIZE\s0" 8 .IX Item "PYTHONOPTIMIZE" This variable determines the optimize level of python. .Sp Using PYTHONOPTIMIZE=1 (like python \-O) will make python discard assertion statements. You will gain efficiency at the cost of losing some debug info. .Sp Using PYTHONOPTIMIZE=2 (like python \-OO) will additionally discard any docstrings. Using this will disable the key on commands. .IP "W3MIMGDISPLAY_PATH" 8 .IX 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 \fI/usr/lib/w3m/w3mimgdisplay\fR. .SH "EXAMPLES" .IX Header "EXAMPLES" There are various examples on how to extend ranger with plugins or combine ranger with other programs. These can be found in the \&\fI/usr/share/doc/ranger/examples/\fR directory, or the \fIdoc/ranger/\fR that is provided along with the source code. .SH "LICENSE" .IX Header "LICENSE" \&\s-1GNU\s0 General Public License 3 or (at your option) any later version. .SH "LINKS" .IX Header "LINKS" .IP "Download: " 4 .IX Item "Download: " .PD 0 .IP "The project page: " 4 .IX Item "The project page: " .IP "The mailing list: " 4 .IX Item "The mailing list: " .IP "\s-1IRC\s0 channel: #ranger on freenode.net" 4 .IX Item "IRC channel: #ranger on freenode.net" .PD .PP ranger is maintained with the git version control system. To fetch a fresh copy, run: .PP .Vb 1 \& git clone git://git.savannah.nongnu.org/ranger.git .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIrifle\fR\|(1) .SH "BUGS" .IX Header "BUGS" Report bugs here: .PP Please include as much relevant information as possible. For the most diagnostic output, run ranger like this: \f(CW\*(C`PYTHONOPTIMIZE= ranger \-\-debug\*(C'\fR ranger-1.8.1/doc/ranger.desktop000066400000000000000000000003261303427242700164220ustar00rootroot00000000000000[Desktop Entry] Type=Application Name=ranger Comment=Launches the ranger file manager Icon=utilities-terminal Terminal=true Exec=ranger Categories=ConsoleOnly;System;FileTools;FileManager MimeType=inode/directory; ranger-1.8.1/doc/ranger.pod000066400000000000000000001277421303427242700155470ustar00rootroot00000000000000=head1 NAME ranger - visual file manager =head1 SYNOPSIS B [B<--version>] [B<--help>] [B<--debug>] [B<--clean>] [B<--confdir>=I] [B<--copy-config>=I] [B<--choosefile>=I] [B<--choosefiles>=I] [B<--choosedir>=I] [B<--selectfile>=I] [B<--list-unused-keys>] [B<--list-tagged-files>=I] [B<--profile>] [B<--cmd>=I] [I] =head1 DESCRIPTION ranger is a console file manager with VI key bindings. =head1 RESOURCES I contains instructions on how to use and configure ranger. I, you can press I for a list of key bindings, commands or settings. The F contains install instructions. The file F contains guidelines for code modification. The directory F contains configuration files. They are usually installed to F and can be obtained with ranger's --copy-config option. The directory F contains reference implementations for ranger plugins, sample configuration files and some programs for integrating ranger with other software. They are usually installed to F. The man page of rifle(1) describes the functions of the file opener The section I of this man page contains further resources. =head1 OPTIONS =over 14 =item B<-d>, B<--debug> Activate the debug mode: Whenever an error occurs, ranger will exit and print a full traceback. The default behavior is to merely print the name of the exception in the statusbar/log and try to keep running. =item B<-c>, B<--clean> Activate the clean mode: ranger will not access or create any configuration files nor will it leave any traces on your system. This is useful when your configuration is broken, when you want to avoid clutter, etc. =item B<-r> I, B<--confdir>=I Change the configuration directory of ranger from ~/.config/ranger to "dir". =item B<--copy-config>=I Create copies of the default configuration files in your local configuration directory. Existing ones will not be overwritten. Possible values: I, I, I, I, I, I. Note: You may want to disable loading of the global configuration files by exporting I in your environment. See also: B, B --copy-config=B will copy only a small sample configuration file with a thoroughly commented example. It is recommended to keep this file tidy to avoid getting defunct commands on ranger upgrades. The full default commands.py can be copied with --copy-config=B, but that file will be ignored by ranger and serves only as a reference for making your own commands. =item B<--choosefile>=I Allows you to pick a file with ranger. This changes the behavior so that when you open a file, ranger will exit and write the absolute path of that file into I. =item B<--choosefiles>=I Allows you to pick multiple files with ranger. This changes the behavior so that when you open a file, ranger will exit and write the absolute paths of all selected files into I, adding one newline after each filename. =item B<--choosedir>=I Allows you to pick a directory with ranger. When you exit ranger, it will write the last visited directory into I. =item B<--selectfile>=I Open ranger with I selected. =item B<--list-unused-keys> List common keys which are not bound to any action in the "browser" context. This list is not complete, you can bind any key that is supported by curses: use the key code returned by C. =item B<--list-tagged-files>=I List all files which are tagged with the given tag. Note: Tags are single characters. The default tag is "*" =item B<--profile> Print statistics of CPU usage on exit. =item B<--cmd>=I Execute the command after the configuration has been read. Use this option multiple times to run multiple commands. =item B<--version> Print the version and exit. =item B<-h>, B<--help> Print a list of options and exit. =back =head1 CONCEPTS This part explains how certain parts of ranger work and how they can be used efficiently. =head2 TAGS Tags are single characters which are displayed left of a filename. You can use tags however you want. Press "t" to toggle tags and "ut" to remove any tags of the selection. The default tag is an Asterisk ("*"), but you can use any tag by typing I<">. =head2 PREVIEWS By default, only text files are previewed, but you can enable external preview scripts by setting the option C and C to true. This default script is F<~/.config/ranger/scope.sh>. It contains more documentation and calls to the programs I and I for html, I for text/code, I for images, I for archives, I for PDFs and I for video and audio files. Install these programs (just the ones you need) and scope.sh will automatically use them. Independently of the preview script, there is a feature to preview images by drawing them directly into the terminal. To enable this feature, set the option C to true and enable one of the image preview modes: =head3 w3m This does not work over ssh, requires certain terminals (tested on "xterm" and "urxvt") and is incompatible with tmux, although it works with screen. To enable this feature, install the program "w3m" and set the option C to w3m. =head3 iTerm2 This only works in iTerm2 compiled with image preview support, but works over ssh. To enable this feature, set the option C to iterm2. =head3 urxvt This only works in urxvt compiled with pixbuf support. Does not work over ssh. Essentially this mode sets an image as a terminal background temporarily, so it will break any previously set image background. To enable this feature, set the option C to urxvt. =head3 urxvt-full The same as urxvt but utilizing not only the preview pane but the whole terminal window. To enable this feature, set the option C to urxvt-full. =head2 SELECTION The I is defined as "All marked files IF THERE ARE ANY, otherwise the current file." Be aware of this when using the :delete command, which deletes all files in the selection. You can mark files by pressing , v, etc. A yellow B symbol at the bottom right indicates that there are marked files in this directory. =head2 MACROS Macros can be used in commands to abbreviate things. %f the highlighted file %d the path of the current directory %s the selected files in the current directory %t all tagged files in the current directory %c the full paths of the currently copied/cut files %p the full paths of selected files The macros %f, %d, %p, and %s also have upper case variants, %F, %D, %P, and %S, which refer to the next tab. To refer to specific tabs, add a number in between. (%7s = selection of the seventh tab.) %c is the only macro which ranges out of the current directory. So you may "abuse" the copying function for other purposes, like diffing two files which are in different directories: Yank the file A (type yy), move to the file B, then type @diff %c %f Macros for file paths are generally shell-escaped so they can be used in the C command. Additionally, if you create a key binding that uses , a special statement which accepts any key, then the macro %any (or %any0, %any1, %any2, ...) can be used in the command to get the key that was pressed. The macro %rangerdir expands to the directory of ranger's python library, you can use it for something like this command: alias show_commands shell less %rangerdir/config/commands.py %confdir expands to the directory given by B<--confdir>. The macro %space expands to a space character. You can use it to add spaces to the end of a command when needed, while preventing editors to strip spaces off the end of the line automatically. To write a literal %, you need to escape it by writing %%. =head2 BOOKMARKS Type B> to bookmark the current directory. You can re-enter this directory by typing B<`>. can be any letter or digit. Unlike vim, both lowercase and uppercase bookmarks are persistent. Each time you jump to a bookmark, the special bookmark at key ` will be set to the last directory. So typing "``" gets you back to where you were before. Bookmarks are selectable when tabbing in the :cd command. Note: The bookmarks ' (Apostrophe) and ` (Backtick) are the same. =head2 RIFLE Rifle is the file opener of ranger. It can be used as a standalone program or a python module. It is located at F. In contrast to other, more simple file openers, rifle can automatically find installed programs so it can be used effectively out of the box on a variety of systems. It's configured in F through a list of conditions and commands. For each line the conditions are checked and if they are met, the respective command is taken into consideration. By default, simply the first matching rule is used. In ranger, you can list and choose rules by typing "r" or simply by typing "". If you use rifle standalone, you can list all rules with the "-l" option and pick a rule with "-p ". The rules, along with further documentation, are contained in F. =head2 FLAGS Flags give you a way to modify the behavior of the spawned process. They are used in the commands C<:open_with> (key "r") and C<:shell> (key "!"). f Fork the process. (Run in background) c Run the current file only, instead of the selection r Run application with root privilege (requires sudo) t Run application in a new terminal window There are some additional flags that can currently be used only in the C command: (for example C<:shell -w df>) p Redirect output to the pager s Silent mode. Output will be discarded. w Wait for an Enter-press when the process is done By default, all the flags are off unless specified otherwise in the F configuration file. You can specify as many flags as you want. An uppercase flag negates the effect: "ffcccFsf" is equivalent to "cs". The terminal program name for the "t" flag is taken from the environment variable $TERMCMD. If it doesn't exist, it tries to extract it from $TERM and uses "xterm" as a fallback if that fails. Examples: C<:open_with c> will open the file that you currently point at, even if you have selected other files. C<:shell -w df> will run "df" and wait for you to press Enter before switching back to ranger. =head2 PLUGINS ranger's plugin system consists of python files which are located in F<~/.config/ranger/plugins/> and are imported in alphabetical order when starting ranger. A plugin changes rangers behavior by overwriting or extending a function that ranger uses. This allows you to change pretty much every part of ranger, but there is no guarantee that things will continue to work in future versions as the source code evolves. Adding new commands via a plugin as simple as specifying them like you would do in the I. There are some hooks that are specifically made for the use in plugins. They are functions that start with hook_ and can be found throughout the code. grep 'def hook_' -r /path/to/rangers/source Also try: pydoc ranger.api Note that you should NOT simply overwrite a function unless you know what you're doing. Instead, save the existing function and call it from your new one. This way, multiple plugins can use the same hook. There are several sample plugins in the F directory, including a hello-world plugin that describes this procedure. =head1 KEY BINDINGS Key bindings are defined in the file F. Check this file for a list of all key bindings. You can copy it to your local configuration directory with the --copy-config=rc option. Many key bindings take an additional numeric argument. Type I<5j> to move down 5 lines, I<2l> to open a file in mode 2, I<10> to mark 10 files. This list contains the most useful bindings: =head2 MAIN BINDINGS =over 14 =item h, j, k, l Move left, down, up or right =item ^D or J, ^U or K Move a half page down, up =item H, L Move back and forward in the history =item gg Move to the top =item G Move to the bottom =item [, ] Move up and down in the parent directory. =item ^R Reload everything =item ^L Redraw the screen =item i Inspect the current file in a bigger window. =item E Edit the current file in $EDITOR ("nano" by default) =item S Open a shell in the current directory =item ? Opens this man page =item W Opens the log window where you can review messages that pop up at the bottom. =item w Opens the task window where you can view and modify background processes that currently run in ranger. In there, you can type "dd" to abort a process and "J" or "K" to change the priority of a process. Only one process is run at a time. =item ^C Stop the currently running background process that ranger has started, like copying files, loading directories or file previews. =item =, +, - Change the permissions of the selection. For example, C<777=> is equivalent to C, C<+ar> does C, C<-ow> does C etc. =item yy Copy (yank) the selection, like pressing Ctrl+C in modern GUI programs. (You can also type "ya" to add files to the copy buffer, "yr" to remove files again, or "yt" for toggling.) =item dd Cut the selection, like pressing Ctrl+X in modern GUI programs. (There are also "da", "dr" and "dt" shortcuts equivalent to "ya", "yr" and "yt".) =item pp Paste the files which were previously copied or cut, like pressing Ctrl+V in modern GUI programs. =item po Paste the copied/cut files, overwriting existing files. =item pP, pO Like pp and po, but queues the operation so that it will be executed I any other operations. Reminder: type C to open the task window. =item pl, pL Create symlinks (absolute or relative) to the copied files =item phl Create hardlinks to the copied files =item pht Duplicate the subdirectory tree of the copied directory, then create hardlinks for each contained file into the new directory tree. =item mI Create a bookmark with the name I =item `I Move to the bookmark with the name I =item n Find the next file. By default, this gets you to the newest file in the directory, but if you search something using the keys /, cm, ct, ..., it will get you to the next found entry. =item N Find the previous file. =item oI Change the sort method (like in mutt) =item zI Change settings. See the settings section for a list of settings and their hotkey. =item uI Universal undo-key. Depending on the key that you press after "u", it either restores closed tabs (uq), removes tags (ut), clears the copy/cut buffer (ud), starts the reversed visual mode (uV) or clears the selection (uv). =item f Quickly navigate by entering a part of the filename. =item Space Mark a file. =item v Toggle the mark-status of all files =item V Starts the visual mode, which selects all files between the starting point and the cursor until you press ESC. To unselect files in the same way, use "uV". =item / Search for files in the current directory. =item : Open the console. =item ! Open the console with the content "shell " so you can quickly run commands =item @ Open the console with the content "shell %s", placing the cursor before the " %s" so you can quickly run commands with the current selection as the argument. =item r Open the console with the content "open with " so you can decide which program to use to open the current file selection. =item cd Open the console with the content "cd " =item Alt-I Open a tab. N has to be a number from 0 to 9. If the tab doesn't exist yet, it will be created. =item gn, ^N Create a new tab. =item gt, gT Go to the next or previous tab. You can also use TAB and SHIFT+TAB instead. =item gc, ^W Close the current tab. The last tab cannot be closed this way. =item M A key chain that allows you to quickly change the line mode of all the files of the current directory. For a more permanent solution, use the command "default_linemode" in your rc.conf. =back =head2 READLINE-LIKE BINDINGS IN THE CONSOLE =over 14 =item ^B, ^F Move left and right (B for back, F for forward) =item ^P, ^N Move up and down (P for previous, N for Next) =item ^A, ^E Move to the start or to the end =item ^D Delete the current character. =item ^H Backspace. =back =head1 MOUSE BUTTONS =over =item Left Mouse Button Click on something and you'll move there. To run a file, "enter" it, like a directory, by clicking on the preview. =item Right Mouse Button Enter a directory or run a file. =item Scroll Wheel Scrolls up or down. You can point at the column of the parent directory while scrolling to switch directories. =back =head1 SETTINGS This section lists all built-in settings of ranger. The valid types for the value are in [brackets]. The hotkey to toggle the setting is in , if a hotkey exists. Settings can be changed in the file F<~/.config/ranger/rc.conf> or on the fly with the command B<:set option value>. Examples: set column_ratios 1,2,3 set show_hidden true Toggling options can be done with: set show_hidden! The different types of settings and an example for each type: setting type | example values ---------------+---------------------------- bool | true, false integer | 1, 23, 1337 string | foo, hello world list | 1,2,3,4 none | none You can view a list of all settings and their current values by pressing "3?" in ranger. =over =item automatically_count_files [bool] Should ranger count and display the number of files in each directory as soon as it's visible? This gets slow with remote file sytems. Turning it off will still allow you to see the number of files after entering the directory. =item autosave_bookmarks [bool] Save bookmarks (used with mX and `X) instantly? This helps to synchronize bookmarks between multiple ranger instances but leads to *slight* performance loss. When false, bookmarks are saved when ranger is exited. =item autoupdate_cumulative_size [bool] You can display the "real" cumulative size of directories by using the command :get_cumulative_size or typing "dc". The size is expensive to calculate and will not be updated automatically. You can choose to update it automatically though by turning on this option. =item cd_bookmarks [bool] Specify whether bookmarks should be included in the tab completion of the "cd" command. =item collapse_preview [bool] When no preview is visible, should the last column be squeezed to make use of the whitespace? =item colorscheme [string] Which colorscheme to use? These colorschemes are available by default: B, B, B. Snow is a monochrome scheme, jungle replaces blue directories with green ones for better visibility on certain terminals. =item column_ratios [list] How many columns are there, and what are their relative widths? For example, a value of 1,1,1 would mean 3 evenly sized columns. 1,1,1,1,4 means 5 columns with the preview column being as large as the other columns combined. =item confirm_on_delete [string] Ask for a confirmation when running the "delete" command? Valid values are "always" (default), "never", "multiple". With "multiple", ranger will ask only if you delete multiple files at once. =item dirname_in_tabs [bool] Display the directory name in tabs? =item display_size_in_main_column [bool] Display the file size in the main column? =item display_size_in_status_bar [bool] Display the file size in the status bar? =item display_tags_in_all_columns [bool] Display tags in all columns? =item draw_borders [bool] Draw borders around columns? =item draw_progress_bar_in_status_bar [bool] Draw a progress bar in the status bar which displays the average state of all currently running tasks which support progress bars? =item flushinput [bool] Flush the input after each key hit? One advantage is that when scrolling down with "j", ranger stops scrolling instantly when you release the key. One disadvantage is that when you type commands blindly, some keys might get lost. =item hidden_filter [string] A regular expression pattern for files which should be hidden. For example, this pattern will hide all files that start with a dot or end with a tilde. set hidden_filter ^\.|~$ =item idle_delay [integer] The delay that ranger idly waits for user input, in milliseconds, with a resolution of 100ms. Lower delay reduces lag between directory updates but increases CPU load. =item line_numbers [string] Show line numbers in main column. Possible values are: false turn the feature off absolute absolute line numbers for use with "gg" relative relative line numbers for "k" or "j" =item max_console_history_size [integer, none] How many console commands should be kept in history? "none" will disable the limit. =item max_history_size [integer, none] How many directory changes should be kept in history? =item metadata_deep_search [bool] When the metadata manager module looks for metadata, should it only look for a ".metadata.json" file in the current directory, or do a deep search and check all directories above the current one as well? =item mouse_enabled [bool] Enable mouse input? =item padding_right [bool] When collapse_preview is on and there is no preview, should there remain a little padding on the right? This allows you to click into that space to run the file. =item preview_directories [bool] Preview directories in the preview column? =item preview_files [bool] Preview files in the preview column? =item preview_images [bool] Draw images inside the console with the external program w3mimgpreview? =item preview_max_size [int] Avoid previewing files that exceed a certain size, in bytes. Use a value of 0 to disable this feature. =item preview_script [string, none] Which script should handle generating previews? If the file doesn't exist, or use_preview_script is off, ranger will handle previews itself by just printing the content. =item save_console_history [bool] Should the console history be saved on exit? If disabled, the console history is reset when you restart ranger. =item scroll_offset [integer] Try to keep this much space between the top/bottom border when scrolling. =item shorten_title [integer] Trim the title of the window if it gets long? The number defines how many directories are displayed at once. A value of 0 turns off this feature. =item show_cursor [bool] Always show the terminal cursor? =item show_hidden_bookmarks [bool] Show dotfiles in the bookmark preview window? (Type ') =item show_hidden [bool] , <^H> Show hidden files? =item sort_case_insensitive [bool] Sort case-insensitively? If true, "a" will be listed before "B" even though its ASCII value is higher. =item sort_directories_first [bool] Sort directories first? =item sort_reverse [bool] Reverse the order of files? =item sort_unicode [bool] When sorting according to some string, should the unicode characters be compared, instead of looking at the raw character values to save time? =item sort [string] , , , , , , , , Which sorting mechanism should be used? Choose one of B, B, B, B, B, B, B, B, B Note: You can reverse the order by typing an uppercase second letter in the key combination, e.g. "oN" to sort from Z to A. =item status_bar_on_top [bool] Put the status bar at the top of the window? =item tilde_in_titlebar [bool] Abbreviate $HOME with ~ in the title bar (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] Use the preview script defined in the setting I? =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 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 rename newname save_copy_buffer scout [-FLAGS] pattern search pattern search_inc pattern set option value setintag tags option value setlocal [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] [I] 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] The cd command changes the directory. The command C<:cd -> is equivalent to typing ``. =item chain I[; I[; I...]] Combines multiple commands into one, separated by semicolons. =item chmod I 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 [-+] and = 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 I Binds keys for the console. Works like the C command. =item console [-pI] I Opens the console with the command already typed in. The cursor is placed at I. =item copycmap I I [I ...] See C =item copymap I I [I ...] Copies the keybinding I to I 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 I [I ...] See C =item copytmap I I [I ...] See C =item cunmap [I] Removes key mappings of the console. Works like the C command. =item default_linemode [I | I] I Sets the default linemode. See I 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 Display the text in the statusbar. =item edit [I] Edit the current file or the file in the argument. =item eval [I<-q>] I 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] Displays only the files which contain the I in their basename. Running this command without any parameter will reset the filter. This command is based on the I 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 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 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 Looks for a string in all marked files or directories. =item help Provides a quick way to view ranger documentations. =item linemode I Sets the linemode of all files in the current directory. The linemode may be: "filename": display each line as "..." "fileinfo": display each line as "..." "permissions": display each line as " " "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 class. See the I 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 I 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 Mark all files matching the regular expression pattern. This command is based on the I command and supports all of its options. =item mark_tag [I] 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 I 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 Creates a directory with the name I. =item open_with [I] [I] [I] Open the selected files with the given application, unless it is omitted, in which case the default application is used. I change the way the application is executed and are described in their own section in this man page. The I 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 I Binds keys for the pager. Works like the C command. =item prompt_metadata [I] Prompt the user to input metadata with the C command for multiple keys in a row. =item punmap [I] Removes key mappings of the pager. Works like the C 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 Change the link destination of the current symlink file to . First will load the original link. =item rename_append Opens the console with ":rename " with the cursor automatically placed before the file extension =item rename I 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 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...] [--] I Swiss army knife command for searching, traveling and filtering files. The command takes various flags as arguments which can be used to influence its behaviour: -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 Search files in the current directory that match the given (case insensitive) regular expression pattern. This command is based on the I command and supports all of its options. =item search_inc I 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 command and supports all of its options. =item set I