packages feed

swiss-army-knife-1.1.0.4: README.org

* swiss-army-knife :TOC_7_gh:
  - [[#created-by][Created By]]
  - [[#introduction][Introduction]]
  - [[#documentation][Documentation]]
    - [[#sak---help][sak --help]]
    - [[#sak-extip][sak extip]]
    - [[#sak-kernel][sak kernel]]
    - [[#sak-sleep][sak sleep]]
    - [[#sak-zfscheck][sak zfscheck]]
    - [[#sak-wg][sak wg]]
    - [[#sak-nm][sak nm]]
    - [[#sak-sn][sak sn]]
  - [[#examples][Examples]]

** Created By
   Fred Mitchell & Atomlogik
      
** Introduction
   Swiss-Army-Knife is a collection of useful
   tools that you can do quickly.
   
   This is now in Hackage and the AUR. So in theory,
   it can run "anywhere", though I have not had the time to test this,
   so I am open to comments and pull requests. In particular, it is 
   gauranteed to run on Arch, and I do have some support for other
   distros, and that will grow. But I have not had the time to fully
   test other distros.

   So some knives will run "anywhere", but some that call out to
   the system for system-specific information may have issues.
   As I find out about them, I will fix them as quickly as I can.

** Documentation
   These are the current "knives" implemented. More to come. Open
   to suggestions.
   + Note that you no longer have to prepend "sudo" to do system-level
      operations.
*** sak --help
    Will list all the current commands.
*** sak extip
    Will tell you what your external IP is for your connection,
    either in IPv4 or IPv6 Useful if you use a VPN
*** sak kernel
    Will tell you the version of the installed kernel as well
    as the running version. Support is in for Arch, Debian, and
    RedHat, but only Arch has been tested.
*** sak sleep
    Will put your system in standby mode.
*** sak zfscheck
    If you use the zfs from archzfs, sometimes it 
    does not keep up with the latest kernel release.
    Check to see the latest kernel zfs supports before
    you do a system upgrade. Other distros will probably
    not have the zfs sync issues that Arch does.
*** sak wg
    If you use WireGuard for your VPN, manage it from
    here. List your installed WireGuard options,
    and swap among them. you can start, stop, and list your
    WireGuard VPNs.

    Now supports enabling and disabling of the underlying daemon.
*** sak nm
    Manage NetworkManager
    Now supports enabling and disabling of the underlying daemon.

*** sak sn
    Manage systemd-networkd
    Now supports enabling and disabling of the underlying daemon.

** Examples
   | Command   | Description                                                                                                        |
   |-----------+--------------------------------------------------------------------------------------------------------------------|
   | sak extip | Will list your external IP and location information                                                                |
   | sak wg -l | (If you are using wg_quick) will list all of your available WG vpns, as well as their active and enabled statuses. |
   | sak wg -d | Will deactivate (but not disable) all WireGuard VPNs.                                                            |
   | sak wg -D | Will disable (but not deactivate) all WireGuard VPNs.                                                              |
   | sak sn -A | Will enable and start systemd-networkd.                                                                            |
   | sak nm -D | Will disable and stop NetworkManager.                                                                              |
   |-----------+--------------------------------------------------------------------------------------------------------------------|