Add usage to Amethyst

pull/5/head
Michal S 2 years ago
parent d439680941
commit 2669804476
No known key found for this signature in database
GPG Key ID: 52F8801FC912EB4F

@ -0,0 +1,30 @@
---
title: Detailed Usage
---
### Basic usage
| Action | FreeBSD pkg-style alias | Pacman-style flags |
|------------------------|-------------------------|--------------------|
| Install a package | ame ins/install | ame -S |
| Remove a package | ame rm/remove | ame -R/-Rs |
| Upgrade a package | ame upg/upgrade | ame -Syu |
| Search for a package | ame sea/search | ame -Ss |
| Query the package list | ame qu/query | ame -Q |
| Show a package's info | ame inf/info | ame -Qi |
| Clean the pacman cache | ame cl/clean | ame -Sc |
| Check for .pacnew | ame di/diff | ame -D |
### Exit codes overview
| Exit Code (i32) | Reason |
|-----------------|----------------------------------------------------------|
| 1 | Running ame as UID 0 / root |
| 2 | Failed creating paths |
| 3 | Could not find one or more required package dependencies |
| 4 | User cancelled package installation |
| 5 | Pacman error when installing package |
| 6 | Git error |
| 7 | Makepkg error |
| 8 | Failed to parse config file |
| 63 | Any other misc error |

@ -2,7 +2,7 @@
title: Common Features Between Modes title: Common Features Between Modes
--- ---
As [mode]us, shared of between uh… repositories… or something. As `[mode]`us, shared of between uh… repositories… or something.
## What you need to know ## What you need to know
Malachite is fairly fleshed out in Repository mode, and not so much in Workspace mode. Malachite is fairly fleshed out in Repository mode, and not so much in Workspace mode.
@ -41,7 +41,7 @@ Now, this is going to look really confusing at first, but bear with me.
In this document, we'll cover only what is required to know for **both** modes. In this document, we'll cover only what is required to know for **both** modes.
More specialized tutorials will be linked for each mode at the bottom of this page. More specialized tutorials will be linked for each mode at the bottom of this page.
Let's start with the base(ics). Let's start with the `[base]`(ics).
## Base Config ## Base Config

Loading…
Cancel
Save