azan

commit 09a5cb08b8580e8bed50de71ec922dc1714e4657
parent 731fc36ca46d6febb28d246b48463b8746d09184
Author: afify <hassan@afify.dev>
Date:   Wed, 25 Nov 2020 16:58:32 +0300

[doc] update man page and README

Diffstat:
M
README.md
 | 
11
+++++++++++
M
azan-nasm.1
 | 
29
++++++++++++++++++++++++-----

2 files changed, 35 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@ azan-nasm
 =========
 **prayers time calculator, written in nasm.**
 
+- binary size ≈ 8.8 kb
+- instructions ≈ 250-400
+- branches ≈ 6-20
 - standalone nasm
 - unix portable syscalls
 - tested on Linux and OpenBSD
@@ -34,8 +37,16 @@ $ azan-nasm
 Options
 -------
 ```sh
+$ azan-nasm [-Nnuv]
 $ man azan-nasm
 ```
+| option | description                                  |
+|:------:|:---------------------------------------------|
+| `-N`   | print next prayer time, 12-hour clock format.|
+| `-n`   | print next prayer time, 24-hour clock format.|
+| `-u`   | print next prayer time, unix-time format.    |
+| `-v`   | print version.                               |
+
 
 Configuration
 -------------
diff --git a/azan-nasm.1 b/azan-nasm.1
@@ -1,14 +1,33 @@
-.TH AZAN 1 azan\-VERSION
+.TH AZAN\-NASM 1 azan\-nasm\-VERSION
 .SH NAME
-azan \- simple muslim prayers calculator
+azan\-nasm \- simple muslim prayers calculator
 .SH SYNOPSIS
-.B azan
+.B azan\-nasm
+.RB [ \-Nnuv ]
 .SH DESCRIPTION
-azan is a simple muslim prayers calculator for unix-like systems.  Show prayers time.
+azan\-nasm is a simple muslim prayers calculator for unix-like systems.  Show prayers time. written in nasm x86-64.
+.SH OPTIONS
+.TP
+.B \-N
+print next prayer time, 12-hour clock format.
+.TP
+.B \-n
+print next prayer time, 24-hour clock format.
+.TP
+.B \-u
+print next prayer time, unix-time format.
+.TP
+.B \-v
+print version.
 .SH USAGE
 .TP
-.B azan
+.B azan\-nasm
 print next prayer left duration.
+.SH CUSTOMIZATION
+azan\-nasm is customized by creating a custom
+.IR config.s
+and (re)compiling the source
+code. This keeps it fast, secure and simple.
 .SH AUTHORS
 See the LICENSE file for the authors.
 .SH LICENSE