From 26698044761f5e0a98770546e882e0faf816e566 Mon Sep 17 00:00:00 2001 From: Michal S Date: Sat, 17 Sep 2022 11:15:46 +0100 Subject: [PATCH] Add usage to Amethyst --- amethyst/usage.mdx | 30 ++++++++++++++++++++++++++++++ malachite/common-features.mdx | 4 ++-- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/amethyst/usage.mdx b/amethyst/usage.mdx index e69de29..c65cf28 100644 --- a/amethyst/usage.mdx +++ b/amethyst/usage.mdx @@ -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 | diff --git a/malachite/common-features.mdx b/malachite/common-features.mdx index 74a666a..afccbd8 100644 --- a/malachite/common-features.mdx +++ b/malachite/common-features.mdx @@ -2,7 +2,7 @@ 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 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. 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