README.md (4439B)
1 # bbl -- The Bible on the Command Line 2 3 A command line tool for searching and reading the Holy Bible. 4 5 Format and original implementation from [bontibon/kjv](https://github.com/bontibon/kjv). Also a derivative of [lukesmithxyz/vul](https://github.com/LukeSmithxyz/vul). 6 This implementation allows for numerous translations/versions of the Bible to be available under one executable. 7 8 ## Usage 9 10 ``` 11 12 usage: bbl [flags] [reference...] 13 14 Flags: 15 -l, --list-books list book names (for the reading chosen) 16 -L, --list list options for readings (Vulgate, KJV, Latin poems, etc.) 17 -o <reading> choose a reading by name (i.e. by the name of the corresponding TSV file, sans file extension) 18 -W, --no-line-wrap no line wrap 19 -V, --no-verse-numbers no verse numbers are printed--just the book title at the top and a number for each chapter 20 -C, --no-ch-numbers no chapter headings either (implies -V) 21 -T, --no-title book title is not printed 22 -B, --no-verse-break No linebreaks at the end of each verse--each chapter runs like a continuous paragraph. Currently implies -V (I am working on changing that) 23 -N, --no-format Equivalent to -WCTB 24 -c, --cat echo text to STDOUT 25 -h, --help show help 26 Bibles: 27 -d, --douay Douay-Rheims Bible 28 -g, --greek Greek Bible (Septuagint + SBL NT) 29 -H, --hebrew The Bible in Hebrew (with cantillation marks and niqqudim) 30 -i, --ivrit The Bible in Hebrew without cantillation marks and niqqudim 31 -j, --jerusalem New Jerusalem Bible 32 -k, --kjv King James Bible 33 -n, --knox Knox Bible 34 -r, --rsv Revised Standard Version: Catholic Edition 35 -v, --vulgate Clementine Vulgate 36 37 Specify multiple versions to cross-reference (view them in multi-column fashion). 38 This feature is not yet available for languages that are read right-to-left. 39 Specifying -i or -H will currently override all other translations and output only the Hebrew Bible. 40 41 Reference types: 42 NOTE: The colon between book and chapter is required for Hebrew, optional for everything else. 43 <Book> can refer either to the name of a book, or an alias referring to a list of books. 44 Specify the -l flag to get list of both books and aliases 45 References for Hebrew must be in Hebrew; for all else, must be in English. 46 <Book> 47 Individual book 48 <Book>:<Chapter> 49 Individual chapter of a book 50 <Book>:<Chapter>:<Verse>[,<Verse>]... 51 Individual verse(s) of a specific chapter of a book 52 <Book>:<Chapter>:<Verse>[,<Chapter>:<Verse>]... 53 Individual verses of different chapters of a book 54 <Book>:<Chapter>-<Chapter> 55 Range of chapters in a book 56 <Book>:<Chapter>:<Verse>-<Verse> 57 Range of verses in a book chapter 58 <Book>:<Chapter>:<Verse>-<Chapter>:<Verse> 59 Range of chapters and verses in a book 60 61 /~?<Search> 62 All verses that match a pattern 63 <Book>/~?<Search> 64 All verses in a book that match a pattern 65 <Book>:<Chapter>/~?<Search> 66 All verses in a chapter of a book that match a pattern 67 In searches, the optional ~ indicates that the search should be approximate: 68 Case and accent marks will be disregarded. Note that this will often take 69 much longer than an exact search 70 71 @ <Number-of-Verses>? 72 Random verse or assortment of verses from any book/chapter 73 <Book> @ <Number-of-Verses>? 74 Random verse or assortment of verses from any chapter in a given book 75 <Book>:<Chapter> @ <Number-of-Verses>? 76 Random verse or assortment of verses from the given book:chapter 77 78 Exit code is 0 if no problems; 1 if cross-referencing and one or more references 79 returned nothing; 2 if no references returned anything. 80 ``` 81 82 ## Note 83 84 The default behaviour (without a flag to specify the Bible version) is to print from the Knox Bible. 85 To change this, set the environment variable "DEFAULT_BIBLE" to reflect the three-letter abbreviation of your translation of choice. 86 One can easily extend this program ad nauseam by simply adding new .tsv files and updating the getopt and the case statement in bbl.sh accordingly. 87 88 ## Install 89 90 ``` 91 git clone https://github.com/thenewmantis/bbl.git 92 cd bbl 93 sudo make install 94 ``` 95 96 ## License 97 98 The script is in the public domain.