From fa3673c1b369bcbf5fc58ce342ac2ce9ff45c13e Mon Sep 17 00:00:00 2001 From: Christopher Schnick Date: Sun, 25 Feb 2024 06:55:47 +0100 Subject: [PATCH] Some fixes --- docs/directories.md | 46 +++++++++++++++++++++++++++++++++++++++++++++ docs/preview.md | 11 +++-------- sidebars.js | 1 + 3 files changed, 50 insertions(+), 8 deletions(-) create mode 100644 docs/directories.md diff --git a/docs/directories.md b/docs/directories.md new file mode 100644 index 0000000..5adc4ab --- /dev/null +++ b/docs/directories.md @@ -0,0 +1,46 @@ +# Directory locations + +XPipe utilizes the following directories: + +## Installation data +* `%LOCALAPPDATA%\XPipe` on Windows +* `/opt/xpipe` on Linux +* `/Applications/XPipe.app` on macOS + +## User data and configuration files +* `%USERPROFILE%\.xpipe` on Windows +* `~/.xpipe` on Linux +* `~/.xpipe` on macOS + +## Temporary shell script files + +Any necessary temporary shell scripts are directly created in the system temp directory. These do not contain any sensitive information and are only created for convenience purposes or because of shell limitations. + +## Editor bridge + +Any files they are being edited in the file browser are downloaded locally and re-uploaded once they are changed. These files are downloaded to +* `%TEMP%\xpipe\bridge` on Windows +* `/tmp/xpipe/$USER/bridge` on Linux +* `$TMPDIR/xpipe/bridge` on macOS + +## File downloads + +Any files they are being downloaded in the file browser are saved to the following directories +* `%TEMP%\xpipe\download` on Windows +* `/tmp/xpipe/$USER/download` on Linux +* `$TMPDIR/download` on macOS + +## Scripts + +When you choose to bring certain user scripts to a remote system, they are copied to the following directory and automatically added to the PATH: +* `%TEMP%\xpipe\scripts` on Windows +* `/tmp/xpipe/$USER/scripts` on Linux +* `/tmp/xpipe/$USER/scripts` on macOS + +## Script data + +In case any created user script has to write some data to a system, e.g. the starship scripts installing starship files, they are created in +* `%TEMP%\xpipe\scriptdata` on Windows +* `/tmp/xpipe/$USER/scriptdata` on Linux +* `/tmp/xpipe/$USER/scriptdata` on macOS + diff --git a/docs/preview.md b/docs/preview.md index 5c3e2dd..1bd3724 100644 --- a/docs/preview.md +++ b/docs/preview.md @@ -1,16 +1,11 @@ # XPipe Pro Preview -Since XPipe version 1.7.11, there is now a new pro preview option available, which allows anyone who is interested to try it out newly released professional-only features for two weeks after their release. +The feature you are trying to use is available in the pro preview, which allows anyone who is interested to try it out newly released professional-only features for two weeks after their release. ## Motivation -This pro preview enables me to test new features and the license management with a lot more people than would otherwise be possible with only the professional license users. -It also allows you to experiment, share feedback, and get a glimpse of all the new features without having to enter any payment information as with the 14-day free trial that you get when you purchase an XPipe professional license. - -## Enabling the Pro Preview - -Go to the license tab in the XPipe application and enter the key `D18D1C9F-D3CB-49CA-A909-FF385DECD948`. Note that you need to be connected to the internet to activate the key. +This pro preview enables me to test new features and the license management with a lot more people than would otherwise be possible with only the professional license users. It also allows you to experiment, share feedback, and get a glimpse of all the new features without having to order anything. ## Verification -Once you enter a key, the application will communicate with the license server to verify that everything is in order. From there, it also fetches the current information of which features are currently new and are still included in the preview. Therefore, you can't just modify your local system time to circumvent the time restriction ;) +Once you enter a key, the application will communicate with the license server on every startup to verify that everything is in order. From there, it also fetches the current information of which features are currently new and are still included in the preview. Therefore, you can't just modify your local system time to circumvent the time restriction. diff --git a/sidebars.js b/sidebars.js index 39c0e33..6ceed26 100644 --- a/sidebars.js +++ b/sidebars.js @@ -39,6 +39,7 @@ const sidebars = { } ], }, + 'directories', 'preview', 'license-activation', 'security',