vul

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README

README.md (1576B)


      1 # vul -- Latin Vulgate Bible on the Command Line
      2 
      3 A command line tool for search and reading the Clementine Vulgate.
      4 
      5 Format and original implementation from [bontibon/kjv](https://github.com/bontibon/kjv). Meant to be a companion program.
      6 
      7 ## Usage
      8 
      9     usage: ./vul [flags] [reference...]
     10 
     11       -l      list books
     12       -W      no line wrap
     13       -h      show help
     14 
     15       Reference types:
     16           <Book>
     17               Individual book
     18           <Book>:<Chapter>
     19               Individual chapter of a book
     20           <Book>:<Chapter>:<Verse>[,<Verse>]...
     21               Individual verse(s) of a specific chapter of a book
     22           <Book>:<Chapter>-<Chapter>
     23               Range of chapters in a book
     24           <Book>:<Chapter>:<Verse>-<Verse>
     25               Range of verses in a book chapter
     26           <Book>:<Chapter>:<Verse>-<Chapter>:<Verse>
     27               Range of chapters and verses in a book
     28 
     29           /<Search>
     30               All verses that match a pattern
     31           <Book>/<Search>
     32               All verses in a book that match a pattern
     33           <Book>:<Chapter>/<Search>
     34               All verses in a chapter of a book that match a pattern
     35 
     36 ## Notes and Contents
     37 
     38 - I/II Samuel and I/II Kings are named with their English titles despite the fact that in Latin they are respectively I-IV Kings. This is simply because the interface is in English and is supposed to be consistent with `kjv`.
     39 
     40 
     41 ## Install
     42 
     43 Install `vul` by running:
     44 
     45 ```
     46 git clone https://github.com/lukesmithxyz/vul.git
     47 cd vul
     48 sudo make install
     49 ```
     50 
     51 ## License
     52 
     53 The script is in the public domain.