~mil/f_scripts

1db55f84eb61328d80e363858c90645e60b8c887 — Miles Alan 10 months ago 4d7b1ab
Regenerate README documentation
2 files changed, 9 insertions(+), 10 deletions(-)

M README.md
M scripts/f_phone
M README.md => README.md +8 -9
@@ 77,14 77,14 @@ The fourth field is an optional arbitrary shell code to be eval'd
after terminating the program. This can be helpful to run cleanup
code for buggy applications like fbi which don't always properly
on C-c or for any other terminal restoration code.
-  **Dependencies:** vim mpv fbdi-fbi fbdi-fbgs
-  **Dependencies:** vim mpv fbida-fbi fbida-fbgs
-  **Default variables:** (override by setting `F_FILES=1`)
    - ```sh
F_FILES_HANDLERS='
[.](mp4|mov|avi)$ ^ 9 0 [ ] p q ^ mpv --vo=tct ^
[.](webm|ogg|mp3|flac)$ ^ 9 0 [ ] p q ^ mpv --no-video ^
[.](jpg|jpeg|gif|webm|png)$ ^ q j k a + - 100s 150s 200s v h i q ^ fbi ^ pkill -9 fbi
[.](pdf)$ ^ q j k a + - 100s 150s 200s v h i q ^ fbg ^ pkill -9 fbi
[.](pdf)$ ^ q j k a + - 100s 150s 200s v h i q ^ fbgs -r 200 ^ pkill -9 fbi
. ^ Z X Q :q :w :wq j k h l ^ vim ^
'
F_FILES_FBSET_FBPRATIO='2 / 3'


@@ 105,11 105,9 @@ Currently supports only the game: moon-buggy!
### **f_maps**

-  **Description:** Browse OSM maps using mepo (via SDL directfb).
-  **Documentation:** Launches mepo to browse OSM maps in SDL / directfb mode. Has limited
compatibility currently since there's nothing like dmenu on the
framebuffer which mepo relies on for compatibility. Mepo should be
compatible with framebuffer more fully eventually via save/restore
state scripts and then running menus in CLI via slmenu or similar.
-  **Documentation:** Launches mepo to browse OSM maps in SDL / directfb mode. Currently
experimental compatibility currently. Newer versions of mepo should
have good support via helper scripts using chvt for menu entries.
-  **Dependencies:** mepo
-  **Source:** [f_maps](./scripts/f_maps)



@@ 128,7 126,7 @@ wireless networks.
### **f_phone**

-  **Description:** Manages phone calls / text messages using modemmanager
-  **Documentation:** A single interactive prompt-driven script to manage all aspect of
-  **Documentation:** A single interactive prompt-driven script to manage all aspects of
using your phone's modem for sending & receiving text messages and
placing and receiving calls.
Transfers incoming text messages and logs calls and all actions to


@@ 142,7 140,7 @@ new call is incoming (vibrating the phone and interrupting your
current prompt to provide a pickup prompt).
So in short, basically, this script allows you to use pinephone (or
otherwise) as , who would have thought.. a lightweight... phone(!)
-  **Dependencies:** polkit modemmanager linuxconsoletools pinephone-call-audio
-  **Dependencies:** polkit modemmanager linuxconsoletools pinephone-call-audio pn
-  **Default variables:** (override by setting `F_PHONE=1`)
    - ```sh
F_PHONE_MODEMHISTORYFILE=~/.f_phone_modemhistory


@@ 151,6 149,7 @@ F_PHONE_HOOKRINGSTART='yes 5 | fftest /dev/input/by-path/platform-vibrator-event
F_PHONE_HOOKRINGSTOP='pkill fftest'
F_PHONE_HOOKMISSEDSTART='echo 255 > /sys/class/leds/green:indicator/brightness; { echo 5; sleep 1; echo -1; } | fftest /dev/input/by-path/platform-vibrator-event'
F_PHONE_HOOKMISSEDSTOP='echo 0 > /sys/class/leds/green:indicator/brightness'
F_PHONE_COUNTRYCODE='US'
       ```
-  **Source:** [f_phone](./scripts/f_phone)


M scripts/f_phone => scripts/f_phone +1 -1
@@ 3,7 3,7 @@ shopt -s strict:all
DEP="polkit modemmanager linuxconsoletools pinephone-call-audio pn"
DEC="Manages phone calls / text messages using modemmanager"
DOC="
  A single interactive prompt-driven script to manage all aspect of
  A single interactive prompt-driven script to manage all aspects of
  using your phone's modem for sending & receiving text messages and
  placing and receiving calls.