From e6190775d9f7640bd0d747554374716340aadf32 Mon Sep 17 00:00:00 2001 From: Arsen Musayelyan Date: Mon, 8 Mar 2021 20:19:31 -0800 Subject: [PATCH] Rewrite kbdemu docs for new version --- content/docs/kbdemu/_index.md | 2 +- content/docs/kbdemu/usage.md | 322 +++++++++++++++--- public/404.html | 4 +- public/contributors/index.html | 4 +- public/docs/advmake/build-files/index.html | 7 +- public/docs/advmake/index.html | 4 +- public/docs/advmake/installation/index.html | 6 +- public/docs/index.html | 4 +- public/docs/kbdemu/index.html | 4 + public/docs/kbdemu/index.xml | 5 + public/docs/kbdemu/installation/index.html | 25 ++ public/docs/kbdemu/page/1/index.html | 1 + public/docs/kbdemu/sitemap.xml | 1 + public/docs/kbdemu/usage/index.html | 53 +++ public/docs/opensend/gui/index.html | 6 +- public/docs/opensend/index.html | 4 +- public/docs/opensend/installation/index.html | 6 +- public/docs/opensend/usage/index.html | 6 +- public/docs/pak/configuration/index.html | 6 +- public/docs/pak/index.html | 4 +- public/docs/pak/installation/index.html | 6 +- public/docs/pak/usage/index.html | 6 +- public/docs/sitemap.xml | 2 +- public/index.html | 4 +- ...c1b0840685a16bb51b1a658dea09ec42eca1cb.js} | 2 +- ...bd299e4bc350707f19ffc6c0d620a7a5d9a023.css | 6 - ...527404e59b7ddc6eede1ed4bb4cf90ad77caab.css | 6 + public/sitemap.xml | 2 +- ...s_6f53526eddd329453a95af44b07404cf.content | 2 +- ...scss_6f53526eddd329453a95af44b07404cf.json | 2 +- 30 files changed, 407 insertions(+), 105 deletions(-) create mode 100644 public/docs/kbdemu/index.html create mode 100644 public/docs/kbdemu/index.xml create mode 100644 public/docs/kbdemu/installation/index.html create mode 100644 public/docs/kbdemu/page/1/index.html create mode 100644 public/docs/kbdemu/sitemap.xml create mode 100644 public/docs/kbdemu/usage/index.html rename public/{index.min.8c5e6bee4f123cf4e419f9c92fb0ae638d0378a1c527c8d9da60244ac6676ae1a889ddeb67ff6329a913a6134e4967e011c84af5191b23f15c0bf22f0c452739.js => index.min.62fb3c8cfeb57442869c870d0aa4097451dc6fe9de70b1c63ef4e25068adfe13bbe1398854c68f4d8fc47ab4a2c1b0840685a16bb51b1a658dea09ec42eca1cb.js} (52%) delete mode 100644 public/main.b5b102cb07e11c96e0608794497ef63d0b871bb82bc08c3013ceeabf602ed21bf546785133e3aa9718609cf943bd299e4bc350707f19ffc6c0d620a7a5d9a023.css create mode 100644 public/main.db7090cddb6602125f0ed93682d138976ae6d5a9a2f2f92c4bcd4de73e6debc939331bf2ec54e8cd7b933fa961527404e59b7ddc6eede1ed4bb4cf90ad77caab.css diff --git a/content/docs/kbdemu/_index.md b/content/docs/kbdemu/_index.md index 3de452a..93a4647 100644 --- a/content/docs/kbdemu/_index.md +++ b/content/docs/kbdemu/_index.md @@ -1,6 +1,6 @@ --- title: "KbdEmu Docs" -draft: true +draft: false description: "Documentation for KbdEmu, the HID emulator" menu: docs: diff --git a/content/docs/kbdemu/usage.md b/content/docs/kbdemu/usage.md index 993d4c6..36c76a4 100644 --- a/content/docs/kbdemu/usage.md +++ b/content/docs/kbdemu/usage.md @@ -6,64 +6,276 @@ description: "Using kbdemu" {{< appveyor-ci project="kbdemu" projectID="km2f1wiy7enuh6il" >}} {{< minio-s3 project="kbdemu" >}} -This page assumes you have already installed KbdEmu. If not, follow the installation -instructions on the installation page. +This page assumes you have already installed KbdEmu. If not, follow the installation instructions on the installation page: -{{< button text="Installation" link="../installation" color="blue">}} +{{< button text="Installation" bgcolor="#357edd" fgcolor="white" link="../installation" >}} -### Configs +## Scripts -KbdEmu uses TOML configs to tell it what to do. This is the example config which -contains all supported features: +KbdEmu uses [scpt](https://gitea.arsenm.dev/Arsen6331/scpt) as its scripting language. The example script for kbdemu looks like this: -```toml -[[action]] -type = "var" -action = "set key to z" - - [[action]] -type = "kbd" -action = "hold key @key@" - - [[action]] -type = "misc" -action = "wait 1 second" - - [[action]] -type = "kbd" -action = "release key @key@" - - [[action]] -type = "kbd" -action = "press space" - - [[action]] -type = "kbd" -action = "type AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz" - - [[action]] -type = "mse" -action = "scroll up 5" - - [[action]] -type = "mse" -action= "right click" - - [[action]] -type = "mse" -action = "move to {0,0}" - - [[action]] -type = "misc" -action = "show message Actions complete!" +``` +set testKey to "x" +keystroke $testKey with action "hold" +sleep "1s" +keystroke $testKey with action "release" +type "AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz" +scroll 5 with direction "up" +click "right" +move-mouse [0, 0] +send-notification "Test" +beep +open-location "https://www.arsenm.dev/" +set showDetails to (display-dialog "Show details?" with type "yesno") +if $showDetails { + display-dialog {"Color: " + (pixel-color [100, 100]) + ", Mouse: " + (str (mouse-position))} with title "Details" +} +print {"\n" + (user-choice "test" with items ["Hello", "World", 3.1415926535, $GOOS, $GOARCH, true, false, (numcpu)])} +log "Complete!" ``` -As you can see, the configs are pretty simple. Here is a list of all the currently -supported features: -{{}} -| Var Type | Misc Type | Kbd Type | Mse Type | -|-------------------|-------------------|--------------|----------------| -| Setting Variables | Delays | Hold Keys | Scrolling | -| | Showing Messages | Release Keys | Mouse Clicks | -| | | Type Strings | Mouse Movement | -{{
}} +By default, the `kbdemu` command will look for and execute a file called `kbdemu.scpt`, but that can be changed using the `--file` flag. + +--- + +## Builtins + +KbdEmu comes with some extra functions for automation + +--- + +### `numcpu` + +Returns the amount of available CPUs as a number. + +Example: +``` +print (numcpu) +``` + +--- + +### `sleep` + +Sleeps for a duration as specified by an unnamed string argument formatted according to the specification of golang's `time.ParseDuration()`: + +{{< button text="Godoc" bgcolor="#00ACD7" fgcolor="white" icon="cib:go" link="https://golang.org/pkg/time#ParseDuration" >}} + +Examples: +``` +sleep "1s" +sleep "1h2m" +``` + +--- + +### `display-dialog` + +Displays a dialog window with the specified parameters. + +Examples: +``` +display-dialog "Test1" +display-dialog "Test2" with title "Title Test" +print (display-dialog "Test3" with title "Entry Test" with type "entry") +``` + +These are all the supported dialog types: + +- info +- warning +- error +- entry +- yesno + +Default dialog type is info. + +--- + +### `send-notification` + +Sends a notification according to the specified parameters + +Examples: +``` +send-notification "Test" +send-notification "Test" with title "Title" +send-notification "Test" with title "Title" with icon "test.png" +``` + +--- + +### `beep` + +Creates a beep sound, if impossible, falls back to sending bell character. + +Examples: +``` +beep +beep "3s" +``` + +--- + +### `click` + +Emulates a mouse click + +Example: +``` +click "right" +``` + +--- + +### `scroll` + +Scrolls the specifed amount in the specified direction + +Example: +``` +scroll 5 with direction "up" +``` + +--- + +### `move-mouse` + +Moves the cursor to the specified coordinates + +Example: +``` +move-mouse [100, 200] +``` + +--- + +### `keystroke` + +Emulates a key event + +Examples: +``` +keystroke "y" with action "hold" +sleep "2s" +keystroke "y" with action "release" +keystroke "x" +``` + +Default action is `tap` which presses and releases the key. + +--- + +### `type` + +Types a string using the keyboard + +Example: +``` +type "Hello, World" +``` + +--- + +### `mouse-position` + +Returns the current mouse position in the form of an array containing two number elements. + +Example: +``` +print (mouse-position) # [0 0] +``` + +--- + +### `pixel-color` + +Returns a string containing the hex color of the given coordinates. + +Example: +``` +print (pixel-color [100, 100]) # ffffff +``` + +--- + +### `log` + +Logs the provided message at the given level. + +Examples: +``` +log "Complete" +log "Error" with level "fatal" +``` + +The available levels are: + +- info +- debug +- warn +- fatal + +Default log level is info + +--- + +### `user-choice` + +Displays a user choice dialog window with provided items, returns selected item. + +Example: +``` +user-choice "Choose an option" with items ["Hello", "World", 1, 3.14159, 6.28318] +``` + +--- + +### `open-location` + +Opens given URL in the default application set to open it. + +Examples: +``` +open-location "https://www.arsenm.dev" +open-location "/home" +``` + +--- + +## Variables + +KbdEmu exposes some variables for use in scripts. + +--- + +### `$GOOS` + +The value from golang's `runtime.GOOS` + +{{< button text="Godoc" bgcolor="#00ACD7" fgcolor="white" icon="cib:go" link="https://golang.org/pkg/runtime#GOOS" >}} + +--- + +### `$GOARCH` + +The value from golang's `runtime.GOARCH` + +{{< button text="Godoc" bgcolor="#00ACD7" fgcolor="white" icon="cib:go" link="https://golang.org/pkg/runtime#GOARCH" >}} + +--- + +### `$arguments` + +Non-flag command line arguments provided to KbdEmu + +Example: + +Command: +```bash +kbdemu --file script.scpt "Hello, World" +``` +Contents of `script.scpt`: +``` +print $arguments[0] # Hello, World +``` \ No newline at end of file diff --git a/public/404.html b/public/404.html index fca2fa4..aaa40b0 100644 --- a/public/404.html +++ b/public/404.html @@ -1,4 +1,4 @@ -404 Page not found | Arsen Dev

Page not found :(

The page you are looking for doesn't exist or has been moved.

\ No newline at end of file diff --git a/public/contributors/index.html b/public/contributors/index.html index 840dfdb..88dbdb6 100644 --- a/public/contributors/index.html +++ b/public/contributors/index.html @@ -1,4 +1,4 @@ -Contributors | Arsen Dev

Contributors

\ No newline at end of file diff --git a/public/docs/advmake/build-files/index.html b/public/docs/advmake/build-files/index.html index 25a3f54..0789dad 100644 --- a/public/docs/advmake/build-files/index.html +++ b/public/docs/advmake/build-files/index.html @@ -1,7 +1,7 @@ -Build Files | Arsen Dev
⇐ AdvMake Docs

Build Files

 AdvMake  AdvMake

Format

AdvMake uses Starlark as the format for its build files. Modules are also defined for both convenience and extra functionality.

Starlark is a Python-like language meant for configuration files.

Configuration

Build files are by default called AdvMakefile, but that can be set via -f

An AdvMakefile example can be found at AdvMake’s repo as it uses AdvMake itself.

AdvMake runs functions exposed by starlark in the format <name>_<target>. To set the default name and target, the global variables defaultName, and defaultTarget must be set. @@ -76,4 +76,5 @@ Godoc


shell.Setenv()


log

The log module contains functions to log events at various levels

The available levels are:

  • Info
  • Debug
  • Warn
  • Fatal

log.<Level>()

Definition: log.<Level>(message)

Logs a message at the specified level. The fatal level quits after logging the message.

Examples:

log.Info("Test log")
 log.Fatal("Error")
 

fmt

The fmt module exposes all the text functions from the golang fmt package except for all the Fprint and Fscan functions.

fmt.Sprintf("Print %s string", "formatted") # "Print formatted string"
-
\ No newline at end of file +  +Godoc \ No newline at end of file diff --git a/public/docs/advmake/index.html b/public/docs/advmake/index.html index 01f7d14..9c54636 100644 --- a/public/docs/advmake/index.html +++ b/public/docs/advmake/index.html @@ -1,4 +1,4 @@ -AdvMake Docs | Arsen Dev
\ No newline at end of file diff --git a/public/docs/advmake/installation/index.html b/public/docs/advmake/installation/index.html index d40c195..fbfe970 100644 --- a/public/docs/advmake/installation/index.html +++ b/public/docs/advmake/installation/index.html @@ -1,7 +1,7 @@ -Installation | Arsen Dev
⇐ AdvMake Docs

Installation

 AdvMake  AdvMake

Building from source

Downloading

AdvMake is hosted on my Gitea instance. If that is down, it is also mirrored on Gitlab.

To download AdvMake, you can either use the download button on Gitea or Gitlab, or you can use the git CLI

To clone AdvMake using the CLI, run one of the following commands:

git clone https://gitea.arsenm.dev/Arsen6331/advmake.git
 OR
@@ -11,4 +11,4 @@ linux distros call the package that provides it either go or 
 

To compile AdvMake, run

go build
 

Installing

To install AdvMake, run:

sudo install -Dm755 advmake /usr/bin
 

Once the command completes, AdvMake should be ready and you can run the following to make sure it works:

advmake -h
-
\ No newline at end of file + \ No newline at end of file diff --git a/public/docs/index.html b/public/docs/index.html index 592b590..b5e3e35 100644 --- a/public/docs/index.html +++ b/public/docs/index.html @@ -1,4 +1,4 @@ -Docs | Arsen Dev
\ No newline at end of file diff --git a/public/docs/kbdemu/index.html b/public/docs/kbdemu/index.html new file mode 100644 index 0000000..cb0fc0d --- /dev/null +++ b/public/docs/kbdemu/index.html @@ -0,0 +1,4 @@ +KbdEmu Docs | Arsen Dev
\ No newline at end of file diff --git a/public/docs/kbdemu/index.xml b/public/docs/kbdemu/index.xml new file mode 100644 index 0000000..66696b1 --- /dev/null +++ b/public/docs/kbdemu/index.xml @@ -0,0 +1,5 @@ +KbdEmu Docs on/docs/kbdemu/Recent content in KbdEmu Docs onHugo -- gohugo.ioen-USInstallation/docs/kbdemu/installation/Mon, 01 Jan 0001 00:00:00 +0000/docs/kbdemu/installation/Using precompiled binary KbdEmu uses continuous integration to compile. You can find the binary by clicking the CI badge above, selecting &ldquo;Ubuntu2004&rdquo; for the linux build or &ldquo;macOS&rdquo; for the macOS build, and then going to the artifacts tab. +Building from source Downloading KbdEmu is hosted in two places, Gitea and Gitlab. Either one can be used as it is mirrored from Gitea to Gitlab +&nbsp;KbdEmu &nbsp;KbdEmu To download kbdemu, you can either use the download button on one of the above, or you can use the git commandUsage/docs/kbdemu/usage/Mon, 01 Jan 0001 00:00:00 +0000/docs/kbdemu/usage/This page assumes you have already installed KbdEmu. If not, follow the installation instructions on the installation page: +Installation Scripts KbdEmu uses scpt as its scripting language. The example script for kbdemu looks like this: +set testKey to &quot;x&quot; keystroke $testKey with action &quot;hold&quot; sleep &quot;1s&quot; keystroke $testKey with action &quot;release&quot; type &quot;AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz&quot; scroll 5 with direction &quot;up&quot; click &quot;right&quot; move-mouse [0, 0] send-notification &quot;Test&quot; beep open-location &quot;https://www. \ No newline at end of file diff --git a/public/docs/kbdemu/installation/index.html b/public/docs/kbdemu/installation/index.html new file mode 100644 index 0000000..5a9a429 --- /dev/null +++ b/public/docs/kbdemu/installation/index.html @@ -0,0 +1,25 @@ +Installation | Arsen Dev
⇐ KbdEmu Docs

Installation

+

Using precompiled binary

KbdEmu uses continuous integration to compile. You can find the binary by +clicking the CI badge above, selecting “Ubuntu2004” for the linux build or +“macOS” for the macOS build, and then going to the artifacts tab.

Building from source

Downloading

KbdEmu is hosted in two places, Gitea and Gitlab. Either one can be used as +it is mirrored from Gitea to Gitlab

 KbdEmu + KbdEmu

To download kbdemu, you can either use the download button on one of the above, or +you can use the git command

To clone kbdemu using the command, run one of the following commands:

git clone https://gitea.arsenm.dev/Arsen6331/kbdemu
+OR
+git clone https://gitlab.com/moussaelianarsen/kbdemu
+

Now, you will want to cd into the root of this repo before completing the rest +of these instructions

Building

Since KbdEmu is written in go, you will need go installed in order to compile it. +Most linux distros call the package providing it either go or golang.

Once go is installed, you can check that it runs by running

go version
+

To compile KbdEmu, run the following commands:

go get github.com/go-vgo/robotgo
+go get github.com/BurntSushi/toml
+go get github.com/rs/zerolog/log
+source .envrc
+go build
+

Installing

To install kbdemu, run the following command:

sudo install -Dm755 kbdemu /usr/bin
+

Once this command completes, to test whether kbdemu was installed properly, run +this command:

kbdemu
+

You should get an error warning you that kbdemu cannot find a TOML file. If you do, +kbdemu is properly installed.

\ No newline at end of file diff --git a/public/docs/kbdemu/page/1/index.html b/public/docs/kbdemu/page/1/index.html new file mode 100644 index 0000000..bb6e994 --- /dev/null +++ b/public/docs/kbdemu/page/1/index.html @@ -0,0 +1 @@ +/docs/kbdemu/ \ No newline at end of file diff --git a/public/docs/kbdemu/sitemap.xml b/public/docs/kbdemu/sitemap.xml new file mode 100644 index 0000000..96eeb56 --- /dev/null +++ b/public/docs/kbdemu/sitemap.xml @@ -0,0 +1 @@ +/docs/kbdemu/installation/weekly0.5/docs/kbdemu/usage/weekly0.5 \ No newline at end of file diff --git a/public/docs/kbdemu/usage/index.html b/public/docs/kbdemu/usage/index.html new file mode 100644 index 0000000..e002183 --- /dev/null +++ b/public/docs/kbdemu/usage/index.html @@ -0,0 +1,53 @@ +Usage | Arsen Dev
⇐ KbdEmu Docs

Usage

+

This page assumes you have already installed KbdEmu. If not, follow the installation instructions on the installation page:

Installation

Scripts

KbdEmu uses scpt as its scripting language. The example script for kbdemu looks like this:

set testKey to "x"
+keystroke $testKey with action "hold"
+sleep "1s"
+keystroke $testKey with action "release"
+type "AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz"
+scroll 5 with direction "up"
+click "right"
+move-mouse [0, 0]
+send-notification "Test"
+beep
+open-location "https://www.arsenm.dev/"
+set showDetails to (display-dialog "Show details?" with type "yesno")
+if $showDetails {
+  display-dialog {"Color: " + (pixel-color [100, 100]) + ", Mouse: " + (str (mouse-position))} with title "Details"
+}
+print {"\n" + (user-choice "test" with items ["Hello", "World", 3.1415926535, $GOOS, $GOARCH, true, false, (numcpu)])}
+log "Complete!"
+

By default, the kbdemu command will look for and execute a file called kbdemu.scpt, but that can be changed using the --file flag.


Builtins

KbdEmu comes with some extra functions for automation


numcpu

Returns the amount of available CPUs as a number.

Example:

print (numcpu)
+

sleep

Sleeps for a duration as specified by an unnamed string argument formatted according to the specification of golang’s time.ParseDuration():

  +Godoc

Examples:

sleep "1s"
+sleep "1h2m"
+

display-dialog

Displays a dialog window with the specified parameters.

Examples:

display-dialog "Test1"
+display-dialog "Test2" with title "Title Test"
+print (display-dialog "Test3" with title "Entry Test" with type "entry")
+

These are all the supported dialog types:

  • info
  • warning
  • error
  • entry
  • yesno

Default dialog type is info.


send-notification

Sends a notification according to the specified parameters

Examples:

send-notification "Test"
+send-notification "Test" with title "Title"
+send-notification "Test" with title "Title" with icon "test.png"
+

beep

Creates a beep sound, if impossible, falls back to sending bell character.

Examples:

beep
+beep "3s"
+

click

Emulates a mouse click

Example:

click "right"
+

scroll

Scrolls the specifed amount in the specified direction

Example:

scroll 5 with direction "up"
+

move-mouse

Moves the cursor to the specified coordinates

Example:

move-mouse [100, 200]
+

keystroke

Emulates a key event

Examples:

keystroke "y" with action "hold"
+sleep "2s"
+keystroke "y" with action "release"
+keystroke "x"
+

Default action is tap which presses and releases the key.


type

Types a string using the keyboard

Example:

type "Hello, World"
+

mouse-position

Returns the current mouse position in the form of an array containing two number elements.

Example:

print (mouse-position) # [0 0]
+

pixel-color

Returns a string containing the hex color of the given coordinates.

Example:

print (pixel-color [100, 100]) # ffffff
+

log

Logs the provided message at the given level.

Examples:

log "Complete"
+log "Error" with level "fatal"
+

The available levels are:

  • info
  • debug
  • warn
  • fatal

Default log level is info


user-choice

Displays a user choice dialog window with provided items, returns selected item.

Example:

user-choice "Choose an option" with items ["Hello", "World", 1, 3.14159, 6.28318]
+

open-location

Opens given URL in the default application set to open it.

Examples:

open-location "https://www.arsenm.dev"
+open-location "/home"
+

Variables

KbdEmu exposes some variables for use in scripts.


$GOOS

The value from golang’s runtime.GOOS

  +Godoc

$GOARCH

The value from golang’s runtime.GOARCH

  +Godoc

$arguments

Non-flag command line arguments provided to KbdEmu

Example:

Command:

kbdemu --file script.scpt "Hello, World"
+

Contents of script.scpt:

print $arguments[0] # Hello, World
+
\ No newline at end of file diff --git a/public/docs/opensend/gui/index.html b/public/docs/opensend/gui/index.html index cbb3408..ab50d98 100644 --- a/public/docs/opensend/gui/index.html +++ b/public/docs/opensend/gui/index.html @@ -1,8 +1,8 @@ -GUI | Arsen Dev
⇐ OpenSend Docs

GUI

This page assumes you have already installed Opensend. If not, follow the installation instructions on the installation page.

Installation

GUI Installation

Opensend GUI has been written in golang using fyne. Its source code can be found here:

 Opensend GUI

To download Opensend GUI, run the following command

git clone https://gitea.arsenm.dev/opensend/opensend-gui.git
 

To build Opensend GUI, go must be installed. The process for that is explained in the installation instructions for Opensend. Once go is installed, run:

go build
-

This may take a while as go downloads and compiles Opensend GUI and Fyne.

Once the build is complete, there should be a file named opensend-gui in the directory. Run this file to open the GUI which should look like this:

Opensend GUI on start
\ No newline at end of file +

This may take a while as go downloads and compiles Opensend GUI and Fyne.

Once the build is complete, there should be a file named opensend-gui in the directory. Run this file to open the GUI which should look like this:

Opensend GUI on start \ No newline at end of file diff --git a/public/docs/opensend/index.html b/public/docs/opensend/index.html index 0f9f323..0799ef0 100644 --- a/public/docs/opensend/index.html +++ b/public/docs/opensend/index.html @@ -1,4 +1,4 @@ -OpenSend Docs | Arsen Dev
\ No newline at end of file diff --git a/public/docs/opensend/installation/index.html b/public/docs/opensend/installation/index.html index f374870..a9bdc66 100644 --- a/public/docs/opensend/installation/index.html +++ b/public/docs/opensend/installation/index.html @@ -1,7 +1,7 @@ -Installation | Arsen Dev
⇐ OpenSend Docs

Installation

Using precompiled binary

Opensend uses continuous integration to compile. You can find the binary by clicking the download binary badge above.

Building from source

Downloading

Opensend is hosted on Gitea.

 Opensend  Opensend

To download opensend, you can either use the download button on one of the above, or you can use the git command

To clone opensend using the command, run the following command:

git clone https://gitea.arsenm.dev/opensend/opensend.git
@@ -13,4 +13,4 @@ Most linux distros call the package providing it either go or # macOS
 

Once this command completes, to test whether opensend was installed properly, run this command:

opensend -h
-

You should get the usage for opensend.

\ No newline at end of file +

You should get the usage for opensend.

\ No newline at end of file diff --git a/public/docs/opensend/usage/index.html b/public/docs/opensend/usage/index.html index 20f315c..01ccba4 100644 --- a/public/docs/opensend/usage/index.html +++ b/public/docs/opensend/usage/index.html @@ -1,7 +1,7 @@ -Usage | Arsen Dev
⇐ OpenSend Docs

Usage

This page assumes you have already installed Opensend. If not, follow the installation instructions on the installation page.

Installation

Configuration

Opensend allows configuration by TOML and by command line flags. It looks at the following paths for configs in the specified order:

Config files

  1. Config path from --config flag
  2. ~/.config/opensend.toml
  3. /etc/opensend.toml

Command line flags

Usage of opensend:
   -d string
@@ -16,4 +16,4 @@ instructions on the installation page.

The purpose of the mdns-skipping flags is to account for the iSH app in iOS, as the mdns resolver and registration fails on it.

Algorithms and software used

  • RSA for asymmetric encryption
  • AES for symmetric encryption
  • Tar for archiving directories
  • Zstandard for compression
  • Base91 for encoding
  • Gob for serialization
  • JSON for serialization
  • TCP sockets for transfer
  • Zeroconf/mDNS for device discovery
\ No newline at end of file +

The purpose of the mdns-skipping flags is to account for the iSH app in iOS, as the mdns resolver and registration fails on it.

Algorithms and software used

\ No newline at end of file diff --git a/public/docs/pak/configuration/index.html b/public/docs/pak/configuration/index.html index 6859ac2..9433235 100644 --- a/public/docs/pak/configuration/index.html +++ b/public/docs/pak/configuration/index.html @@ -1,7 +1,7 @@ -Configuration | Arsen Dev
⇐ Pak Docs

Configuration

Config file

Pak uses a custom config file at /etc/pak.cfg. For example, this is what the apt config looks like:

# Write the name of the package manager in all lowercase below
 apt
@@ -19,4 +19,4 @@ apt config looks like:

This file is read by pak to tell it what to do. The comments above each keyword explain what it’s for.

Here is a list of all the fields and their uses:

  1. Command to invoke the package manager.
  2. Comma-separated list of commands supported by the package manager.
  3. Whether or not to invoke the root command.
  4. Command to use for root invocation (sudo, doas, etc.)
  5. Comma-separated list of shortcuts for pak to accept
  6. Comma-separated list of shortcut mappings (what each shortcut sends to the package manager). These do not necessarily need to be in the commands list.

Once you have made the config, just place it at /etc/pak.cfg and pak will -automatically use it.

\ No newline at end of file +automatically use it.

\ No newline at end of file diff --git a/public/docs/pak/index.html b/public/docs/pak/index.html index 7227dd4..497d4e4 100644 --- a/public/docs/pak/index.html +++ b/public/docs/pak/index.html @@ -1,4 +1,4 @@ -Pak Docs | Arsen Dev
\ No newline at end of file diff --git a/public/docs/pak/installation/index.html b/public/docs/pak/installation/index.html index 7e11b47..ccc4b8a 100644 --- a/public/docs/pak/installation/index.html +++ b/public/docs/pak/installation/index.html @@ -1,7 +1,7 @@ -Installation | Arsen Dev
⇐ Pak Docs

Installation

Using precompiled binary

Pak uses continuous integration to compile. You can find the binary by clicking the download badge above.

Using the AUR

If you are running an arch-based linux distro, you can use the Arch User Repository to install pak. First, make sure the yay AUR helper is installed, then run the following:

yay -S pak
 

Building from source

Downloading

Pak is hosted on my Gitea instance. If that is down, it is also mirrored on Gitlab.

 Pak @@ -17,4 +17,4 @@ of package managers with ready to use configs:

  • apt
  • aptitude

    Installing

    If your package manager is in the list, use one of these:

    • apt: sudo make aptinstall
    • aptitude: sudo make aptitude
    • brew: sudo make brewinstall
    • yay: sudo make yayinstall
    • pacman: sudo make pacinstall
    • zypper: sudo make zyppinstall
    • snap: sudo make snapinstall
    • custom: sudo make installbinonly

    Once the command completes, unless you’re using a custom config, pak should be ready and you can run the following to make sure it works:

    pak
     

    Go to the Configuration page for instructions on making a custom config, you must -have a config for pak to function.

\ No newline at end of file +have a config for pak to function.

\ No newline at end of file diff --git a/public/docs/pak/usage/index.html b/public/docs/pak/usage/index.html index 5c7c2ab..1246b1f 100644 --- a/public/docs/pak/usage/index.html +++ b/public/docs/pak/usage/index.html @@ -1,7 +1,7 @@ -Usage | Arsen Dev
⇐ Pak Docs

Usage

Using pak is simple, just run pak and one of the commands from the config file. Pak understands partial commands, so these commands will be identical:

pak in <package>
 OR
@@ -11,4 +11,4 @@ pak install <package>
 

The lack of sudo is intentional. Pak will not allow running from root by default as it already invokes root internally. To bypass this, simply give pak the -r flag.

Using shortcuts in pak is just as simple as commands, just run pak and a shortcut, like this:

pak rm <package>
-
\ No newline at end of file +
\ No newline at end of file diff --git a/public/docs/sitemap.xml b/public/docs/sitemap.xml index 99fe240..825354e 100644 --- a/public/docs/sitemap.xml +++ b/public/docs/sitemap.xml @@ -1 +1 @@ -/docs/advmake/weekly0.5/docs/opensend/weekly0.5/docs/pak/weekly0.5/docs/advmake/build-files/weekly0.5/docs/advmake/installation/weekly0.5/docs/opensend/gui/weekly0.5/docs/opensend/installation/weekly0.5/docs/opensend/usage/weekly0.5/docs/pak/configuration/weekly0.5/docs/pak/installation/weekly0.5/docs/pak/usage/weekly0.5 \ No newline at end of file +/docs/advmake/weekly0.5/docs/kbdemu/weekly0.5/docs/opensend/weekly0.5/docs/pak/weekly0.5/docs/advmake/build-files/weekly0.5/docs/advmake/installation/weekly0.5/docs/kbdemu/installation/weekly0.5/docs/kbdemu/usage/weekly0.5/docs/opensend/gui/weekly0.5/docs/opensend/installation/weekly0.5/docs/opensend/usage/weekly0.5/docs/pak/configuration/weekly0.5/docs/pak/installation/weekly0.5/docs/pak/usage/weekly0.5 \ No newline at end of file diff --git a/public/index.html b/public/index.html index 67e3bf6..59e48de 100644 --- a/public/index.html +++ b/public/index.html @@ -1,7 +1,7 @@ -Arsen Dev | Home