Update documentation

This commit is contained in:
2022-06-17 03:16:01 -04:00
parent 0b653000ef
commit c03e818560
5 changed files with 15 additions and 10 deletions
+7 -5
View File
@@ -1,5 +1,5 @@
# sshyp # sshyp
A very simple self-hosted, synchronized password manager for UNIX systems (currently Haiku/Linux). Alternative to (and compatible with) pass/password-store. A very simple self-hosted, synchronized password manager for UNIX(-like) systems (currently Haiku/FreeBSD/Linux). Alternative to (and compatible with) pass/password-store.
Compatible with entries created by pass/password-store. Compatible with entries created by pass/password-store.
@@ -22,7 +22,7 @@ What sshyp can do:
- generate new, secure passwords to the user's choice in length and complexity - generate new, secure passwords to the user's choice in length and complexity
- securely sync said passwords and notes seamlessly between devices - securely sync said passwords and notes seamlessly between devices
- everything above with entries created by pass/password-store! - everything above with entries created by pass/password-store!
- everything above on Haiku, Linux, and Termux (an Android terminal emulator)! - everything above on Haiku, FreeBSD, Linux, and Termux (an Android terminal emulator)!
What sshyp will likely do: What sshyp will likely do:
@@ -31,7 +31,7 @@ What sshyp will likely do:
What sshyp definitely won't do: What sshyp definitely won't do:
- Non-UNIX support, e.g. Windows (I'd be happy to link to third-party ports, if someone were to make them) - Non-UNIX(-like) support, e.g. Windows (I'd be happy to link to third-party ports, if someone were to make them)
# Installation # Installation
Arch Linux (all ISAs) Arch Linux (all ISAs)
@@ -46,7 +46,7 @@ cd sshyp
makepkg -si makepkg -si
``` ```
Pre-built packages exist for Haiku, Arch Linux, Debian Linux, and Termux. These can be downloaded from the releases page. Pre-built packages exist for Haiku, FreeBSD, Arch Linux, Debian Linux, Red Hat Linux, and Termux. These can be downloaded from the releases page.
# Building # Building
Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation. Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation.
@@ -59,7 +59,9 @@ cd sshyp
./package.sh ./package.sh
``` ```
The packaging script has been tested on Arch Linux with dpkg as a dependency for Debian and Termux packaging. The packaging script has been tested on Arch Linux with "dpkg" as a dependency for Debian and Termux packaging and "freebsd-pkg" as a dependency for FreeBSD packaging.
Haiku packaging must be done from within Haiku.
The AUR version and the packages attatched to the release tags were already packaged using this script. The AUR version and the packages attatched to the release tags were already packaged using this script.
+3 -1
View File
@@ -8,10 +8,11 @@ As such, it is being crowned "v1.0.0", and is considered a stable base for futur
Features: Features:
- sshyp has been modified to run on Haiku, an open-source re-implementation of BeOS - sshyp has been modified to run on Haiku, an open-source re-implementation of BeOS
^ new package formats have been added for Haiku, FreeBSD, and Red Hat distributions (such as Fedora)
- the entry format has been changed to support entries created in pass/password-store - the entry format has been changed to support entries created in pass/password-store
^ this change requires existing entry libraries to be converted - see the sshyp v1.0.0 release page on GitHub for a conversion script ^ this change requires existing entry libraries to be converted - see the sshyp v1.0.0 release page on GitHub for a conversion script
- majorly overhauled visual experience for sshyp - majorly overhauled visual experience for sshyp
^ this includes a new entry list, a new entry readout, colored output, and more! ^ this includes a new entry list, a new entry readout, colored output, ascii art, and more!
- entries can now optionally be passed as arguments, directly - entries can now optionally be passed as arguments, directly
^ as opposed to the user being prompted for an entry name after running a command ^ as opposed to the user being prompted for an entry name after running a command
@@ -29,6 +30,7 @@ Changes:
- the clipboard now automatically clears after 30 seconds - the clipboard now automatically clears after 30 seconds
- sshyp server no longer needs to create copies of its libraries in ~/ - sshyp server no longer needs to create copies of its libraries in ~/
- added more and improved existing exceptions - added more and improved existing exceptions
- the lock file is now decrypted to /dev/null
- ...and lots of minor (under the hood) changes! - ...and lots of minor (under the hood) changes!
<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><> <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+2 -2
View File
@@ -1,6 +1,6 @@
.TH sshyp 1 "23 May 2022" "v1.0.0" "sshyp man page" .TH sshyp 1 "17 June 2022" "v1.0.0" "sshyp man page"
.SH NAME .SH NAME
sshyp \- A very simple self-hosted, synchronized password manager for UNIX systems. Alternative to (and compatible with) pass/password-store. sshyp \- A very simple self-hosted, synchronized password manager for UNIX(-like) systems. Alternative to (and compatible with) pass/password-store.
.SH SYNOPSIS .SH SYNOPSIS
sshyp [OPTION] [[FLAG]] [/<entry name>] sshyp [OPTION] [[FLAG]] [/<entry name>]
.SH DESCRIPTION .SH DESCRIPTION
Binary file not shown.
+3 -2
View File
@@ -8,10 +8,11 @@ As such, it is being crowned "v1.0.0", and is considered a stable base for futur
Features: Features:
- sshyp has been modified to run on Haiku, an open-source re-implementation of BeOS - sshyp has been modified to run on Haiku, an open-source re-implementation of BeOS
^ new package formats have been added for Haiku, FreeBSD, and Red Hat distributions (such as Fedora)
- the entry format has been changed to support entries created in pass/password-store - the entry format has been changed to support entries created in pass/password-store
^ this change requires existing entry libraries to be converted - see the sshyp v1.0.0 release page on GitHub for a conversion script ^ this change requires existing entry libraries to be converted - see the sshyp v1.0.0 release page on GitHub for a conversion script
- majorly overhauled visual experience for sshyp - majorly overhauled visual experience for sshyp
^ this includes a new entry list, a new entry readout, colored output, and more! ^ this includes a new entry list, a new entry readout, colored output, ascii art, and more!
- entries can now optionally be passed as arguments, directly - entries can now optionally be passed as arguments, directly
^ as opposed to the user being prompted for an entry name after running a command ^ as opposed to the user being prompted for an entry name after running a command
@@ -29,6 +30,7 @@ Changes:
- the clipboard now automatically clears after 30 seconds - the clipboard now automatically clears after 30 seconds
- sshyp server no longer needs to create copies of its libraries in ~/ - sshyp server no longer needs to create copies of its libraries in ~/
- added more and improved existing exceptions - added more and improved existing exceptions
- the lock file is now decrypted to /dev/null
- ...and lots of minor (under the hood) changes! - ...and lots of minor (under the hood) changes!
<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><> <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
@@ -38,6 +40,5 @@ https://raw.githubusercontent.com/rwinkhart/sshyp/main/extra/changelog-total
Legend: Legend:
** = feature/change not yet finished/implemented
- = feature/change implemented and pushed upstream - = feature/change implemented and pushed upstream
^ = note regarding the above feature/change ^ = note regarding the above feature/change