quran-go

Read Qur'an right in the terminal.
git clone http://git.hanabi.in/repos/quran-go.git
Log | Files | Refs | README | LICENSE

quran.1 (1874B)

      1 .Dd $Mdocdate: May 8 2022 $
      2 .Dt QURAN 1
      3 .Os
      4 .Sh NAME
      5 .Nm quran
      6 .Nd fetch various Qur'an translations right in the terminal.
      7 .Sh SYNOPSIS
      8 .Nm quran
      9 .Op Fl delay Ar delay-ms
     10 .Op Fl decorate
     11 .Op Fl trans Ar trans-id
     12 .Op Ar command|args
     13 .Sh DESCRIPTION
     14 .Nm quran
     15 fetches Qur'an chapter and verse translations right in the terminal.
     16 .Nm quran
     17 is not 'bug compatible' with
     18 .Nm quran.py ,
     19 as this software parses input differently.
     20 .Pp
     21 The options are as follows:
     22 .Bl -tag -width Ds
     23 .It Fl delay Ar delay-ms
     24 Specify
     25 .Ar delay-ms
     26 in milliseconds, the delay between fetching verses.
     27 I advice using at least 500.
     28 Default is 1000.
     29 .It Fl decorate
     30 Decorate the chapters and verses.
     31 .It Fl trans Ar trans-id
     32 Select which translation to use, for fetching the verses.
     33 Default trans-id is
     34 .Dv 131 ,
     35 corresponding to Dr. Mustafa Khattab, the Clear Quran.
     36 Use
     37 .Em
     38 quran ls-translations
     39 to see available translations.
     40 .Pp
     41 .Sh COMMANDS
     42 .Bl -tag -width Ds
     43 .It about
     44 Print basic description about
     45 .Nm quran .
     46 .It details
     47 Print basic information about the source of the verses.
     48 .It ls-translations
     49 Print available translations, which can be specified with the
     50 .Fl trans
     51 flag.
     52 .It version
     53 Print current version of
     54 .Nm quran .
     55 .Sh ARGUMENTS
     56 .Pp
     57 Without specifying any commands, argument is of the type <chapter:[verse1[-verse2]]>.
     58 .Sh LICENSE
     59 This software is licensed under the GNU Affero General Public License v3.
     60 Please see
     61 .Lk Aq https://www.gnu.org/licenses/agpl-3.0/txt
     62 for what you are allowed to do with this software's source code.
     63 .Sh AUTHORS
     64 Original implementation by
     65 .An acagastya Aq Mt me+git@hanabi.in .
     66 .Sh REPORTING ERRORS
     67 Please do NOT call errors as bugs.
     68 Any incorrect behaviour of the software is an ERROR.
     69 Report errors to
     70 .An acagastya Aq Mt me+git@hanabi.in .
     71 Additionally, if you wish to submit changes/error fixes, please send a
     72 .Nm git-format-patch(1)
     73 to the same email.