1hudman(1)                   General Commands Manual                  hudman(1)
2
3
4

NAME

6       hudman - simple tool for creating a local HUD mirror
7

SYNOPSIS

9       hudman [-h] (download | update) --huddb HUDDB --outdir OUTDIR
10

DESCRIPTION

12       HUD  Manager  is a simple tool for creating a local HUD mirror.  Can be
13       used together with the SRC Repair project.
14

COMMAND-LINE ACTIONS

16   download
17       Download all HUDs without updating them.
18
19   update
20       Update all HUDs and download only new files.
21

COMMAND-LINE OPTIONS

23   -h, --help
24       Show help message and exit.
25
26   -d, --huddb
27       Path to the local HUD database file.
28
29   -o, --outdir
30       Path to the output directory for storing downloaded files.
31

SUPPORTED CONFIGURATIONS

33       HUD Manager can operate in two modes: anonymous and authorized.
34
35       This product supports of getting  API  credentials  for  the  supported
36       backends with environment variables.
37

SUPPORTED BACKENDS

39   Available backends
40       This application can use the following backends:
41
42       • GitHub;
43
44       • Other (only direct links are supported).
45
46   API tokens
47       You can obtain API tokens from these sources:
48
49       • GitHub:   https://docs.github.com/en/articles/creating-a-personal-ac‐
50         cess-token-for-the-command-line
51

ENVIRONMENT OPTIONS

53   GitHub backend
54       To bypass API limits for the anonymous users, you will need to  forward
55       your API username and token:
56
57       • HUDMAN_LOGIN - GitHub user login (username).
58
59       • HUDMAN_APIKEY - GitHub API personal access token.
60
61   Forwarding options
62       Export environment variables using export command:
63
64              export HUDMAN_LOGIN=foobar
65              export HUDMAN_APIKEY=ABCDEFG123
66
67       Start the application in authorized mode:
68
69              hudman update --huddb /path/to/hud/database.xml --outdir /tmp/hudman
70

AUTHORS

72       Copyright (c) 2016-2022 EasyCoding Team.
73
74
75
76                                                                     hudman(1)
Impressum