Skip to content

Rummage Documentation

Jump to bottom Edit New page
Isaac Muse edited this page Aug 2, 2013 · 12 revisions

Table of Contents

About

Rummage is a grep like search utility that is cross platform for Windows, OSX, and Ubuntu (may work for other distros, but only Ubuntu is tested). It is coded in Python and uses WxPython 2.9 (but appears to work with 2.8 as well). The regex engine used is Python's re module with a wrapper that allows help with some unicode searches.

Feature List

  • Regex and literal search
  • Toggle dotall in regex
  • Toggle case sensitivity in all searches
  • Force search using UTF-8 encoding on all files
  • Control whether search also aggregates line context, just gets match count, or just does a boolean match on the file
  • Ability to save and load commonly used searches
  • Open matched file in editor of choice (at row and col if editor supports it via command line and context is enabled)
  • Test regex using the built-in regex tester
  • Limit search of files by wild cards or by regex
  • Exclude folders by wild cards or by regex
  • Limit search based on file sizes
  • Limit search based on creation or modification times of file
  • Control whether subfolders are searched
  • Control whether files deemed as binary (or not of a recognized encoding) are searched
  • Control whether hidden files are searched
  • Export search results to HTML or CSV for later use
  • Windows notifications, Growl notification (Windows and OSX only), and Notify OSD support (Linux only; currently not when app is compiled)
  • Configurable to be run as a single-instance app or multi-instance app
  • Ability to hide limit options if you have set them and do not wish to change them often

Installation

TODO

General Use

TODO

Credits

Add a custom footer
Add a custom sidebar
Clone this wiki locally