:shipit: vman

:bookmark: Table of contents

1. About
2. Installation
3. Usage
4. Options
5. Files
6. Supported Creators
7. Notes
8. The End

:question: About

vman is a small but configurable CLI program to open helpful videos about linux utility commands from a variety of creators using the default media player in the system.

:file_folder: Installation

:penguin: Binary dependencies (Debian)

sudo apt-get install python3 python3-pip python3-setuptools pipx

pipx ensurepath

:snake: Option 1: Pypi

pipx install vman

:hand: Option 2: Git repository (Still connects to Pypi)

pipx install git+https://github.com/sivefunc/vman.git

:computer: Usage

usage: vman [video] [author] [options]

vman - Video Man Pages

Open a video from distrotube

vman ls -a distrotube

Change media player (by default it uses xdg-open)

vman ls -p mpv

Pipe URL to a different program + verbose

vman ls --only-url --verbose | xargs librewolf

:gear: Options

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -a AUTHOR, --author AUTHOR
                        Author of the video to consult, e.g 'roberteldersoftware'
  -p PATH, --player PATH
                        Path to media player to use instead of the one defined in config
  --only-url            Do not reproduce the video, returns the url
  --urls                List all the video manuals in JSON format
  --verbose             Detailed output at console

:file_folder: Files

Config File

TOML file that allows the user to modify the default options, e.g the media player. It's located at src/vman/config.toml example:

media_player = "xdg-open"
author = "distrotube"

[custom-urls]
enabled = false
path = ""

URLS File

JSON File that maps an author to a collection of videos. It's located at src/vman/urls.json but you can modify the location.

{
    "distrotube": {
        "ls": "https://www.youtube.com/watch?v=T-4Q7i6mNeM"
    },
    "roberteldersoftware": {
        "nice": "https://www.youtube.com/shorts/uuCYq64Ww7o",
        "fmt": "https://www.youtube.com/shorts/SyylpFY_eSg"
    }
}

:camera: Supported Creators

Name	Profile Picture
DistroTube
RobertElderSoftware

:notebook: Notes

• CLI Options have higher precedency than config.toml

Made by :link: Sivefunc

Licensed under :link: GPLv3