Prady_sh_scripts

What’s this?

Useful (according to me) shell-scripts

Documentation

pages

How to install

Requirements

• GNU Coreutils: These are often required by many GNU/Linux scripts, and hence, are likely to be already installed. Check by running the following code in a terminal.

if command -v realpath >/dev/null 2>&1; then echo "GNU Coreutils are already installed."; else echo "GNU Coreutils need to be installed."; fi

Linux / Unix

• Download tangled code from here.
• Uncompress (unzip) to a location, LOC.
  • LOC may be something of the form ~/Downloads/pss/ remember this location.
  • Make sure LOC/bin is a directory. Else, recheck LOC.
• Place the following code at the end of either ~/.zshrc or ~/.bashrc or both; replace LOC appropriately.

PATH="${PATH}:LOC/bin"

NAME

prady_sh_scripts - useful shell scripts written by Pradyumna Paranjape.

Copyright

Copyright 2020-2024 Pradyumna Paranjape

License (GNU GPLv3)

This file is part of Prady_sh_scripts. Prady_sh_scripts is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Prady_sh_scripts is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Prady_sh_scripts. If not, see https://www.gnu.org/licenses/.

Scope

Files in this project contain regular utilities and aliases for linux (fc39); Preferably in POSIX-compliant shell scripts.

Configuration

Variable values may be set manually in ${XDG_CONFIG_HOME:-${HOME}/.config}/sh_scripts/config.sh. A variable named <var> for a script <script> can be set by declaring <script>_<var>=<value>. It will be interpreted as <var>=<value> only by that script, ignoring all other variables.

Example

• Illustration

  # shellcheck disable=SC2034
  countdown_progress=true
  
  # interpreted and used only by 'countdown' as
  # shellcheck disable=SC2034
  progress=true
      

• Sample configuration aid <script> may be located at LOC/config/<script>.

List of variables

Following variables may be set for the corresponding script.

clear_cache

• clear_cache_confirmed: bool

cmdlist

• cmdlist_dep: List[str]
• cmdlist_all_cmds: List[str]
• cmdlist_<custom_variable>: str
• cmdlist_execute: bool

countdown

• countdown_colors: bool
• countdown_resolution: int
• countdown_notify: bool
• countdown_progress: bool
• countdown_period: datatime
• countdown_as_time: bool

gen_self_ssl_cert

• gen_self_ssl_cert_conf: path
• gen_self_ssl_cert_ssl_root: path
• gen_self_ssl_cert_keyname: str
• gen_self_ssl_cert_validity: int
• gen_self_ssl_cert_create_conf: bool

get_pass

• get_pass_instance: str

git_migrate

• git_migrate_conf: path
• git_migrate_task: str
• git_migrate_rroot: path
• git_migrate_stale: url | path
• git_migrate_rnew: url | path

mvlns

• mvlns_verbose: bool
• mvlns_srcdir: path
• mvlns_object: path
• mvlns_destin: path
• mvlns_mk_par: bool

openvpn

• openvpn_remote_targets: str (addresses separated by space)

relink

• relink_verbose: bool
• relink_link_dir: path
• relink_mod_pat: glob
• relink_new_str: str
• relink_mock: bool
• relink_safe: bool

runAs

• runAs_otherUser: str
• runAs_otherIP: url
• runAs_execCmd: str
• runAs_posStr: str
• runAs_titleStr: str
• runAs_interactive: bool

scan_network_upnodes

• scan_network_upnodes_ip_range: int
• scan_network_upnodes_startip: int
• scan_network_upnodes_stopip: int
• scan_network_upnodes_down: bool

snatch_own

• snatch_own_verbose: bool
• snatch_own_robber: str
• snatch_own_syndicate: str
• snatch_own_recurse: bool

sync_all_gitlab_issues

• sync_all_gitlab_issues_verbose: bool
• sync_all_gitlab_issues_very_verbose: bool
• sync_all_gitlab_issues_config_file: path
• sync_all_gitlab_issues_pull: bool
• sync_all_gitlab_issues_block: str
• sync_all_gitlab_issues_local_url: path
• sync_all_gitlab_issues_local_token: str
• sync_all_gitlab_issues_remote_url: url
• sync_all_gitlab_issues_remote_token: str

update_date

• update_date_set_time: bool
• update_date_current_time: str
• update_date_source: url