vbm/README.md

106 lines
3.6 KiB
Markdown
Raw Normal View History

2022-02-26 14:51:58 +01:00
### Changed name from vpm to vbm
2022-02-02 07:11:42 +01:00
2022-02-26 21:06:40 +01:00
# vbm - An XBPS package management helper for vb aka Void GNU/Linux
2021-12-24 21:50:02 +01:00
version 1.4.1
2021-09-03 06:50:33 +02:00
2022-02-26 14:51:58 +01:00
`vbm` is a simple to use, daily-driver enhancement to the awesome XBPS (X Binary
2021-09-03 06:51:22 +02:00
Package System), initially designed as a helper tool for use with VoidLinux.
Feel free to think "Void Package Management" or something if it helps you
remember its name, but please note that it's NOT a "package manager" in the
2022-02-26 14:51:58 +01:00
nitpickers understanding of the word - especially vbm shouldn't be confused with
XBPS - vbm is just an addon helper tool for XBPS to make your life easier.
2021-09-03 06:51:22 +02:00
That's it.
2022-02-26 21:06:40 +01:00
# better then screenshots
2021-09-03 06:51:22 +02:00
2022-02-26 14:51:58 +01:00
vbm...
2021-09-03 06:51:22 +02:00
2022-02-26 21:06:40 +01:00
[![asciicast](https://asciinema.org/a/476068.svg)](https://asciinema.org/a/476068)
2021-09-03 06:51:22 +02:00
2022-02-02 07:11:42 +01:00
# Motivation to write vpm
2021-09-03 06:51:22 +02:00
I initially found XBPS to have a steep learning-curve, so I wanted to ease the
life of new VoidLinux users, and XBPS users in general. Please don't feel afraid
2022-02-02 07:11:42 +01:00
to look up the corresponding XBPS commands it translates to, or use vpm
--show-translations so you even see the translations already when using vpm
help. It has been said that vpm will ease the transition from Debian's APT, and
2021-09-03 06:51:22 +02:00
some other user-friendly repository/package-managers.
# Dependencies
2022-02-26 14:51:58 +01:00
vbm requires BASH, the Bourne Again SHell, which should be installed by default
2021-09-09 19:56:55 +02:00
on a new VoidLinux system. You also will need git and xcheckrestart both provided
2022-02-26 14:51:58 +01:00
by xtools package to obtain a clone of the vbm repository.
2021-09-09 19:56:55 +02:00
(see "Installation" section, below).
2022-02-26 14:51:58 +01:00
Or you can just grab vbm and paste it anywhere in your system.
2021-09-03 06:51:22 +02:00
# Installation
2022-02-02 07:11:42 +01:00
### 1. Install xtools via `xbps-install`
2022-02-26 21:06:40 +01:00
### (optional - needed for xcheckrestart functions)
2021-09-03 06:51:22 +02:00
2021-09-09 19:56:55 +02:00
$ xbps-install -S xtools
2021-09-03 06:51:22 +02:00
2022-02-26 14:51:58 +01:00
### 2. Clone vbm repository
2021-09-03 06:51:22 +02:00
2022-02-26 14:51:58 +01:00
$ git clone https://codeberg.org/oSoWoSo/vbm.git
2021-09-03 06:51:22 +02:00
2022-02-26 14:51:58 +01:00
### 3. Enter the cloned repo and install vbm
2021-09-03 06:51:22 +02:00
2022-02-26 14:51:58 +01:00
$ cd vbm
$ chmod +x vbm
2021-09-09 19:56:55 +02:00
$ make install
2021-09-03 06:51:22 +02:00
2022-02-26 14:51:58 +01:00
### 3a. Remove vbm
2021-09-03 06:51:22 +02:00
2022-02-26 14:51:58 +01:00
If you want to remove vbm, just use make to remove it. Make sure you are in the cloned directory first, then run:
2021-09-03 06:51:22 +02:00
$ make uninstall
# ZOMG! PONIES!!111
Rainbows and unicorns, indeed. If you like colorized output, please see the
2022-02-26 14:51:58 +01:00
--color=true option, too! All vbm options try to have human readable and easy to
2021-09-03 06:51:22 +02:00
remember syntax, no --long-option-with-multiple-complex-words, no need to even
2022-02-26 14:51:58 +01:00
prefix arguments with --, vbm just tries to do its best it can to understand the
user (there are some command-line-switches, though, see vbm help).
2021-09-03 06:51:22 +02:00
2022-02-26 14:51:58 +01:00
Also vbm will ask for password if needed.
2021-09-03 06:51:22 +02:00
# License
2022-02-26 14:51:58 +01:00
vbm is released under the terms of the GNU General Public License,
2021-09-03 06:51:22 +02:00
Version 3. See the LICENSE file for further information.
```
Copyright (c) 2016: Armin Jenewein <vpm@m2m.pm>
This program 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.
This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
```
2021-09-09 19:56:55 +02:00
# Authors
- https://github.com/netzverweigerer/vpm - vpm was written by Armin Jenewein <vpm@m2m.pm>
- https://github.com/bahamas10/vpm - forked by Dave Eddy <dave@daveeddy.com>
2022-02-26 14:51:58 +01:00
- https://codeberg.org/oSoWoSo/vbm - and this fork by zenobit <zen@osowoso.xyz>
2021-09-09 19:56:55 +02:00
# Mirrors
2021-09-03 06:51:22 +02:00
2021-09-09 19:56:55 +02:00
- repos mirrored at:
2022-02-26 14:51:58 +01:00
- 'https://github.com/oSoWoSo/vbm'
- 'https://gitlab.com/linux15/void/vbm'
- 'https://git.disroot.org/oSoWoSo/vbm'
2021-09-09 19:56:55 +02:00
- more mirrors will come...