BOT: Updates man-pages and website (GHP) (#50)

Co-authored-by: github-actions <github-actions@github.com>
grm34 · May 24, 2023 · e0e93ad · e0e93ad
1 parent 68c6463
commit e0e93ad
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 38 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,7 @@
 <!-- markdownlint-disable-file MD033 -->
 <h1 align="center">
   <a href="#">
-    <img alt="mobinfo" height="180px" src="https://raw.githubusercontent.com/grm34/mobinfo/main/docs/assets/images/mobinfo.png">
+    <img alt="mobinfo" height="160px" src="https://raw.githubusercontent.com/grm34/mobinfo/main/docs/assets/images/mobinfo.png">
   </a>
 </h1>
 
@@ -10,7 +10,7 @@
     <img  alt="mit" src="https://img.shields.io/badge/license-MIT-blue.svg">
   </a>
   <a href="https://github.com/grm34/mobinfo/releases">
-    <img  alt="release" src="https://img.shields.io/badge/release-0.1.4-blue.svg">
+    <img  alt="release" src="https://img.shields.io/badge/release-0.1.5-blue.svg">
   </a>
   <a href="https://github.com/grm34/mobinfo/actions/workflows/mobinfo.yml">
     <img  alt="updater" src="https://github.com/grm34/mobinfo/actions/workflows/mobinfo.yml/badge.svg">
@@ -30,7 +30,7 @@ directly from your favorite terminal.
 
 <p align="center">
   <a href="https://raw.githubusercontent.com/grm34/mobinfo/main/docs/assets/images/mobinfo.gif">
-    <img width="48%" alt="demo" src="https://raw.githubusercontent.com/grm34/mobinfo/main/docs/assets/images/mobinfo.gif">
+    <img width="70%" alt="demo" src="https://raw.githubusercontent.com/grm34/mobinfo/main/docs/assets/images/mobinfo.gif">
   </a>
 </p>
 
@@ -102,9 +102,10 @@ FILTERING:
   -hl, --highlight               Show highlighted specifications.
   -HL, --hl-only                 Show highlighted specs only.
 
-     Highlighted specifications are used only by GSMArena.
+     Highlighted specifications only available on GSMArena.
+
+  -F, --filter  <filter1,filter2>
 
-  -F=<filter>, --filter=<filter1,filter2>
      os, chipset, cpu, gpu, models, modelname, nettech, net2g, net3g,
      net4g, speed, wlan, bluetooth, gps, sim, nfc, radio, usb, colors,
      price, sendors, memoryslot, internalmemory, memoryother, year,
@@ -120,24 +121,25 @@ RENDERING:
   -R,  --raw                     Disable specifications rendering.
   -nc, --no-color                Disable ANSI colors rendering.
   -bc, --basic-color             Basic colors instead of 256-colors.
-  -T=, --theme=light             Change 256-colors theme.
+  -T, --theme  <name>            Change 256-colors theme.
                                  light - dark (default) - hack
-  -C=, --foreground=             Change foreground colors.
-  -B=, --background=             Change background colors.
+  -C, --foreground  <colors>     Change foreground colors.
+  -B, --background  <colors>     Change background colors.
 
      The table is divided into seven blocks and it is possible to
      change the color of each of them. In order the blocks are:
      head1 - head2 - Vsymbol - Hsymbol - Asymbol - row1 - row2
-     Dark theme (default):  --foreground=2,2,233,233,233,140,8
-                            --background=234,234,233,233,233,234,233
+
+     Dark theme (default):  --foreground 2,2,233,233,233,140,8
+                            --background 234,234,233,233,233,234,233
 
 OTHER:
   -h, --help                     Get help for commands.
   -V, --version                  Show version number and quit.
   -v, --verbose                  Make curl operations more talkative.
                                  Useful for debugging and seeing
                                  what is going on under the hood.
-  -m=<sec>, --max-time=<sec>     Maximum time in seconds that you
+  -m, --max-time  <seconds>      Maximum time in seconds that you
                                  allow curl operations to take.
                                  Useful for preventing slow networks
                                  or database going down (default 5).
@@ -146,13 +148,13 @@ OTHER:
 
 EXAMPLES:
   mobinfo --search samsung
-  mobinfo -s xiaomi mi 11 --filter=name,os,cpu,gpu,memory
-  mobinfo -f A51 5G UW --filter=status,price --specs-only
-  mobinfo --brands --filter=name,os,cam,bat --theme=hack
+  mobinfo -s xiaomi mi 11 --filter name,os,cpu,gpu,memory
+  mobinfo -f A51 5G UW --filter status,price --specs-only
+  mobinfo --brands --filter name,os,cam,bat --theme hack
 
 COMPARE:
   mobinfo --first iphone XR && mobinfo --first iphone XS
-  mobinfo -f A51 --filter=cpu && mobinfo -f A52 --filter=cpu
+  mobinfo -f A51 --filter cpu && mobinfo -f A52 --filter cpu
 
 Report bugs to https://github.com/grm34/mobinfo/issues
 ```
@@ -171,6 +173,3 @@ Report bugs to https://github.com/grm34/mobinfo/issues
   <img align="center" width="48%" alt="mobinfo_light" src="https://raw.githubusercontent.com/grm34/mobinfo/main/docs/assets/images/mobinfo_light.png">
 </a>
 
-<a href="https://raw.githubusercontent.com/grm34/mobinfo/main/docs/assets/images/mobinfo_dark.png">
-  <img align="center" width="48%" alt="mobinfo_hack" src="https://raw.githubusercontent.com/grm34/mobinfo/main/docs/assets/images/mobinfo_dark.png">
-</a>
diff --git a/docs/mobinfo.1 b/docs/mobinfo.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.1.
-.TH MOBINFO "1" "May 2023" "mobinfo 0.1.4 (x86_64-pc-linux-gnu)" "User Commands"
+.TH MOBINFO "1" "May 2023" "mobinfo 0.1.5 (x86_64-pc-linux-gnu)" "User Commands"
 .SH NAME
-mobinfo \- manual page for mobinfo 0.1.4 (x86_64-pc-linux-gnu)
+mobinfo \- manual page for mobinfo 0.1.5 (x86_64-pc-linux-gnu)
 .SH SYNOPSIS
 .B mobinfo
 [\fI\,OPTIONS\/\fR]... \fI\,<arguments>\/\fR... [\fI\,FILTERS\/\fR]...
@@ -48,9 +48,10 @@ Show highlighted specifications.
 \fB\-HL\fR, \fB\-\-hl\-only\fR
 Show highlighted specs only.
 .IP
-Highlighted specifications are used only by GSMArena.
-.HP
-\fB\-F=\fR<filter>, \fB\-\-filter=\fR<filter1,filter2>
+Highlighted specifications only available on GSMArena.
+.TP
+\fB\-F\fR, \fB\-\-filter\fR
+<filter1,filter2>
 .IP
 os, chipset, cpu, gpu, models, modelname, nettech, net2g, net3g,
 net4g, speed, wlan, bluetooth, gps, sim, nfc, radio, usb, colors,
@@ -73,22 +74,23 @@ Disable ANSI colors rendering.
 \fB\-bc\fR, \fB\-\-basic\-color\fR
 Basic colors instead of 256\-colors.
 .TP
-\fB\-T=\fR, \fB\-\-theme\fR=\fI\,light\/\fR
-Change 256\-colors theme.
+\fB\-T\fR, \fB\-\-theme\fR
+<name>            Change 256\-colors theme.
 light \- dark (default) \- hack
 .TP
-\fB\-C=\fR, \fB\-\-foreground=\fR
-Change foreground colors.
+\fB\-C\fR, \fB\-\-foreground\fR
+<colors>     Change foreground colors.
 .TP
-\fB\-B=\fR, \fB\-\-background=\fR
-Change background colors.
+\fB\-B\fR, \fB\-\-background\fR
+<colors>     Change background colors.
 .IP
 The table is divided into seven blocks and it is possible to
 change the color of each of them. In order the blocks are:
 head1 \- head2 \- Vsymbol \- Hsymbol \- Asymbol \- row1 \- row2
-Dark theme (default):  \fB\-\-foreground\fR=\fI\,2\/\fR,2,233,233,233,140,8
-.IP
-\fB\-\-background\fR=\fI\,234\/\fR,234,233,233,233,234,233
+.TP
+Dark theme (default):
+\fB\-\-foreground\fR 2,2,233,233,233,140,8
+\fB\-\-background\fR 234,234,233,233,233,234,233
 .SS "OTHER:"
 .TP
 \fB\-h\fR, \fB\-\-help\fR
@@ -102,8 +104,8 @@ Make curl operations more talkative.
 Useful for debugging and seeing
 what is going on under the hood.
 .TP
-\fB\-m=\fR<sec>, \fB\-\-max\-time=\fR<sec>
-Maximum time in seconds that you
+\fB\-m\fR, \fB\-\-max\-time\fR
+<seconds>      Maximum time in seconds that you
 allow curl operations to take.
 Useful for preventing slow networks
 or database going down (default 5).
@@ -116,13 +118,13 @@ Verbose logfile for error reporting.
 .SS "EXAMPLES:"
 .IP
 mobinfo \fB\-\-search\fR samsung
-mobinfo \fB\-s\fR xiaomi mi 11 \fB\-\-filter\fR=\fI\,name\/\fR,os,cpu,gpu,memory
-mobinfo \fB\-f\fR A51 5G UW \fB\-\-filter\fR=\fI\,status\/\fR,price \fB\-\-specs\-only\fR
-mobinfo \fB\-\-brands\fR \fB\-\-filter\fR=\fI\,name\/\fR,os,cam,bat \fB\-\-theme\fR=\fI\,hack\/\fR
+mobinfo \fB\-s\fR xiaomi mi 11 \fB\-\-filter\fR processor,os,ram,gpu
+mobinfo \fB\-f\fR A51 5G UW \fB\-\-filter\fR model,price \fB\-\-specs\-only\fR
+mobinfo \fB\-\-brands\fR \fB\-\-filter\fR network,speed \fB\-\-theme\fR hack
 .SS "COMPARE:"
 .IP
 mobinfo \fB\-\-first\fR iphone XR && mobinfo \fB\-\-first\fR iphone XS
-mobinfo \fB\-f\fR A51 \fB\-\-filter\fR=\fI\,cpu\/\fR && mobinfo \fB\-f\fR A52 \fB\-\-filter\fR=\fI\,cpu\/\fR
+mobinfo \fB\-f\fR A51 \fB\-\-filter\fR processor && mobinfo \fB\-f\fR A52 \fB\-\-filter\fR processor
 .SH AUTHOR
 Written by darkmaster @grm34 (Jeremy Pardo).
 .SH "REPORTING BUGS"