update help

This commit is contained in:
Kang Yu 2023-11-05 15:26:05 -08:00
parent eee8bf10c5
commit 4dd781d983

39
Help.md
View file

@ -15,7 +15,7 @@
| -foreground_background_dual_position=0 | turn off dual position switching
| -prompt_session_restore | Ask the user before restoring the window layout upon resuming the last session. This may help to reduce the total restore time for remote desktop sessions on slow internet connections.
| -delay_auto_capture 1.0 | Adjust the lag between window move event and auto-capture to 1.0 second, the default lag is 3~4 seconds.
| **-delay_auto_restore 2.5** | Adjust the lag between monitor on/off event and auto-restore to 2.5 seconds (the default lag is 1 second), in case restore is incomplete or monitor fails to go to sleep due to restore starts too early.
| *-delay_auto_restore 2.5* | Adjust the lag between monitor on/off event and auto-restore to 2.5 seconds (the default lag is 1 second), in case restore is incomplete or monitor fails to go to sleep due to restore starts too early.
| -redraw_desktop | Redraw the whole desktop after a restore in case some window workarea is not refreshed
| -fix_zorder=1 | Preserve window Z-order for automatic restore. The Z-order of a window indicates the window's position in a stack of overlapping windows.
| -fix_offscreen_window=0 | Turn off auto correction of off-screen windows
@ -39,29 +39,32 @@
| Undo the last snapshot restore | Alt + click the PersistentWindows icon
---
### Other Features
* The dual positioning feature allows any window to have different position/size in foreground and background mode.
* Bring a foreground window to its previous background position and z-order
* click the empty desktop background area (which is not occupied by any window)
* Bring a foreground window to its previous z-order (while keeping the current size)
* Ctrl click the empty desktop area
* Bring a background window to foreground WITHOUT restoring to previous foreground position
### Shortcuts to manipulate positions of one window
* Switching a window between foreground and background mode with potentially different positions and sizes.
* Click the desktop window to bring the foreground window to its previous background position and z-order.
* Shift click the desktop window to bring the foreground window to its *second* last background position. This is useful if the previous background position is mis-captured due to invoking start menu or other popups.
* Ctrl click the desktop window to bring the foreground window to its previous z-order while keeping the current location and size.
* To bring a background window to foreground *without* restoring to previous foreground position.
* press any of Ctrl/Shift/Alt key when activating the window.
* Restore a new window to its last closing position
* To restore a new window to its last closing position
* Ctrl click the PW icon
* Put the current window to background, useful if the window is maximized
* Ctrl Alt click the PW icon
* Create named capture(s) to disk
* To put the foreground window behind all other windows.
* Alt click the desktop window. This is similar to Alt Esc Windows keyboard shortcut, which however does not work for foreground window inside remote desktop.
* Ctrl Alt click the PW icon if the foreground window is maximized
* To momentarily suppress window capture, for example during start menu invocation
* press Ctrl Alt keys
* To enable/disable auto restore for non-toplevel window (such as a child or dialog window)
* To include a child/dialog window for auto capture/restore, move the window once using mouse
* To exclude a window from auto capture/restore, press Ctrl Shift keys when moving the window
### Shortcuts for captures on disk
* To save a named capture to disk, Ctrl click the "Capture windows to disk" menu option, then enter a name in the pop-up dialog
* To restore the named capture from disk, Ctrl click the "Restore windows from disk" menu option, then enter the name of the previously saved capture in the dialog
* To restore captures belonging to a different display config, Shift click "Restore windows from disk" menu.
### Other features
* Replace the default app icon with your customized one
* Save your icon file as `pwIcon.ico` and copy it to `C:/Users/\<YOUR_ID>/AppData/Local/PersistentWindows/`, or copy it to the directory where you are invoking PersistentWindows from using the `-redirect_appdata` command argument.
* Save the second icon file as `pwIconBusy.ico` in the same directory. This icon is displayed when PersistentWindows is busy restoring windows.
* Enable/Disable auto restore for any (child or dialog) window:
* To include a child/dialog window for auto restore, move the window using only the mouse
* To exclude a window from auto restore, hold Ctrl Shift keys then move the window
```