diff --git a/dev-docs/architecture.md b/dev-docs/architecture.md index 262036d9..966bd2d6 100644 --- a/dev-docs/architecture.md +++ b/dev-docs/architecture.md @@ -33,7 +33,7 @@ Each time you run a CLI command: 1. Args are parsed by the client, args parsing errors are reported if any. Help is shown if `-h`/`--help` is passed. -1. If args are parsed successfully, the args are send to the server +1. If args are parsed successfully, the args are sent to the server 1. Server parses the args once again, and runs the command 1. Server returns stdout, stderr, and exit code to the client 1. Client shows stdout, stderr, and ends the process with the requested exit code diff --git a/dev-docs/development.md b/dev-docs/development.md index 90659783..4eb09d2a 100644 --- a/dev-docs/development.md +++ b/dev-docs/development.md @@ -28,7 +28,7 @@ If you struggle to build AeroSpace locally, you can also refer to [builds in Git ## 2. Create codesign certificate If you want to run AeroSpace as App Bundle (AeroSpace.app) you need to create self-signed certificate that will be used to codesign AeroSpace. -Release artifact is build as App Bundle. +Release artifact is built as App Bundle. If you only plan to build the debug version of AeroSpace, you can run it from the terminal and custom certificate is not required. 1. Open `Keychain Access.app` diff --git a/docs/aerospace-list-monitors.adoc b/docs/aerospace-list-monitors.adoc index d9d4d0b1..09647700 100644 --- a/docs/aerospace-list-monitors.adoc +++ b/docs/aerospace-list-monitors.adoc @@ -38,7 +38,7 @@ See "Output Format" section for more details. Incompatible with `--count` --count:: -Output only the number of workspaces. +Output only the number of monitors. Incompatible with `--format` --json:: diff --git a/docs/aerospace-move-node-to-monitor.adoc b/docs/aerospace-move-node-to-monitor.adoc index 70cd5843..bfb1e0d6 100644 --- a/docs/aerospace-move-node-to-monitor.adoc +++ b/docs/aerospace-move-node-to-monitor.adoc @@ -33,7 +33,7 @@ Make sure that the window in question receives focus after moving. This flag is a shortcut for manually running `aerospace-workspace`/`aerospace-focus` after `move-node-to-monitor` successful execution. --fail-if-noop:: -Exit with non-zero code if move window to monitor it already belongs to +Exit with non-zero code if moving window to monitor it already belongs to --window-id :: include::./util/window-id-flag-desc.adoc[] diff --git a/docs/aerospace-split.adoc b/docs/aerospace-split.adoc index 3b5fda85..8f2f9ed9 100644 --- a/docs/aerospace-split.adoc +++ b/docs/aerospace-split.adoc @@ -17,14 +17,14 @@ aerospace split [-h|--help] [--window-id ] (horizontal|vertical|oppos == Description // tag::body[] -`split` command exist solely for compatibility with i3. +`split` command exists solely for compatibility with i3. Unless you're hardcore i3 user who knows what they are doing, it's recommended to use `join-with` *If the parent of focused window contains more than one child*, then the command . Creates a new tiling container . Replaces the focused window with the container -. Puts the focused window into the container as its the only child +. Puts the focused window into the container as its only child The argument configures orientation of the newly created container. `opposite` means opposite orientation compared to the parent container. diff --git a/docs/aerospace-summon-workspace.adoc b/docs/aerospace-summon-workspace.adoc index 67f7388d..331e720c 100644 --- a/docs/aerospace-summon-workspace.adoc +++ b/docs/aerospace-summon-workspace.adoc @@ -28,7 +28,7 @@ In single monitor setup the command is identical to `workspace` command. include::./util/conditional-options-header.adoc[] -h, --help:: Print help ---fail-if-noop:: Exit with non-zero exit code if the workspace already visible on the focused monitor. +--fail-if-noop:: Exit with non-zero exit code if the workspace is already visible on the focused monitor. // =========================================================== Arguments include::./util/conditional-arguments-header.adoc[] diff --git a/docs/goodies.adoc b/docs/goodies.adoc index 52be29e9..b02b2b30 100644 --- a/docs/goodies.adoc +++ b/docs/goodies.adoc @@ -83,7 +83,7 @@ Use these snippets as a starting point. [source,toml] ---- # Run Sketchybar together with AeroSpace -# sketchbar has a built-in detection of already running process, +# sketchybar has a built-in detection of already running process, # so it won't be run twice on AeroSpace restart after-startup-command = ['exec-and-forget sketchybar'] @@ -156,7 +156,7 @@ exec-on-workspace-change = [ Invoking Safari/Terminal with a command the obvious way (`exec-and-forget open -a Safari`) results in an outcome that is probably not the intended one. Namely, that any workspace already containing an instance of Safari/Terminal is brought in focus. -Opening *a new window* of a program that can supports multiple windows (such as Safari or Terminal.app) can be accomplished with an AppleScript inlined in `aerospace.toml` as follows: +Opening *a new window* of a program that can support multiple windows (such as Safari or Terminal.app) can be accomplished with an AppleScript inlined in `aerospace.toml` as follows: - Safari + @@ -197,7 +197,7 @@ If `automatically-unhide-macos-hidden-apps` isn't enough, you can disable `cmd-h [#screenshoot-shortcut] == Take screenshots to clipboard using keyboard shortcut -You can configure a custom shortcut take a screenshot. +You can configure a custom shortcut to take a screenshot. `screencapture` is a built-in macOS command. .~/.aerospace.toml diff --git a/docs/guide.adoc b/docs/guide.adoc index a228f026..17b5a67b 100644 --- a/docs/guide.adoc +++ b/docs/guide.adoc @@ -90,13 +90,13 @@ Please read the default config! Non-trivial configuration options are mentioned further in this guide. If no custom config is found, AeroSpace will load the default config. -If the key is omitted in the custom config, it fallbacks to the value in the default config, unless it's stated otherwise for the specific keys. Namely: +If the key is omitted in the custom config, it falls back to the value in the default config, unless it's stated otherwise for the specific keys. Namely: -* `mode.*.binding`. It fallbacks to the empty TOML table. Your config is the source of truth for keyboard bindings. You must explicitly mention all the keyboard bindings and <> in your config. -* `on-focused-monitor-changed`. It fallbacks to the empty TOML array. +* `mode.*.binding`. It falls back to the empty TOML table. Your config is the source of truth for keyboard bindings. You must explicitly mention all the keyboard bindings and <> in your config. +* `on-focused-monitor-changed`. It falls back to the empty TOML array. * `exec` TOML table. See: <> (It's so boring and verbose, I don't even want to mention it in the `default-config.toml`) -Rule of thumb: all the "scalar like" values always fallback to the default config. All the "vector like" values fallback to the empty TOML array or table. +Rule of thumb: all the "scalar like" values always fall back to the default config. All the "vector like" values fall back to the empty TOML array or table. That allows you to keep your config tidy and clean from trivial config keys for which you like the default values. You can bootstrap your custom config by copying the default config from the app installation - @@ -139,7 +139,7 @@ Working with binding modes consists of two parts: [#commands] === Commands -Commands is the thing that you use to manipulate AeroSpace and query its state. +Commands are the thing you use to manipulate AeroSpace and query its state. There are two ways on how you can use commands: @@ -204,7 +204,7 @@ You can configure environment variables of `exec-*` commands and callbacks (such Environment variable substitution is supported in form of `+${ENV_VAR}+` * You can inspect what is the end result of environment variables using xref:commands.adoc#list-exec-env-vars[`list-exec-env-vars` command] * GUI apps on macOS don’t have Homebrew’s prefix in their `PATH` by default (https://docs.brew.sh/FAQ#my-mac-apps-dont-find-homebrew-utilities[docs.brew.sh]). -That's why unless you override `exec` section in your config, AeroSpace fallbacks to the following `exec` configuration: +That's why unless you override `exec` section in your config, AeroSpace falls back to the following `exec` configuration: + [source,toml] ---- @@ -410,7 +410,7 @@ image::./assets/monitor-arrangement-2-good.svg[,,align="center"] === A note on mission control For some reason, mission control doesn't like that AeroSpace puts a lot of windows in the bottom right corner of the screen. -Mission control shows windows too small even there is enough space to show them bigger. +Mission control shows windows too small even when there is enough space to show them bigger. There is a workaround. You can enable `Group windows by application` setting: [source,bash] @@ -425,7 +425,7 @@ defaults write com.apple.dock expose-group-apps -bool true && killall Dock There is an observation that macOS works better and more stable if you disable `Displays have separate Spaces`. (It's enabled by default) People report all sorts of weird issues related to focus and performance when this setting is enabled: -* Wrong window may receive focus in multi monitor setup: https://github.com/nikitabobko/AeroSpace/issues/101[#101] (Bug in Apple API) +* Wrong window may receive focus in multi-monitor setup: https://github.com/nikitabobko/AeroSpace/issues/101[#101] (Bug in Apple API) * Wrong borderless Alacritty window may receive focus in *single monitor* setup: https://github.com/nikitabobko/AeroSpace/issues/247[#247] (Bug in Apple API) * Performance issues: https://github.com/nikitabobko/AeroSpace/issues/333[#333] * macOS randomly switches focus back: https://github.com/nikitabobko/AeroSpace/issues/289[#289] @@ -455,7 +455,7 @@ Spaces are just cursed in macOS. The less Spaces you have, the better macOS beha |... is displayed only on main monitor |=== -If you don't care about macOS native fullscreen in multi monitor setup (which is itself clunky anyway, since it creates a separate Space instance), +If you don't care about macOS native fullscreen in multi-monitor setup (which is itself clunky anyway, since it creates a separate Space instance), I recommend disabling `Displays have separate Spaces`. You can disable the setting by running: @@ -580,7 +580,7 @@ on-focused-monitor-changed = ['move-mouse monitor-lazy-center'] # Mouse lazily f on-focus-changed = ['move-mouse window-lazy-center'] # Mouse lazily follows any focus (window or workspace) ---- -You shouldn't rely on the order callback are called, since it's an implementation detail and can change from version to version. +You shouldn't rely on the order callbacks are called, since it's an implementation detail and can change from version to version. The callbacks are "recursion resistant", which means that any focus change within the callback won't retrigger the callback. Changing the focus within these callbacks is a bad idea anyway, and the way it's handled will probably change in future versions. @@ -612,7 +612,7 @@ xref:./goodies.adoc#show-aerospace-workspaces-in-sketchybar[] * The pool of workspaces is shared between monitors * Each monitor shows its own workspace. -The showed workspaces are called"visible" workspaces +The showed workspaces are called "visible" workspaces * Different monitors can’t show the same workspace at the same time * Each workspace (even invisible, even empty) has a monitor assigned to it * By default, all workspaces are assigned to the "main" monitor ("main" as in `System -> Displays -> Use as`) @@ -626,7 +626,7 @@ You can move workspace to a different monitor with xref:commands.adoc#move-works The idea of making pool of workspaces shared is based on [#observation]*the observation* that most users have a limited set of workspaces on their secondary monitors. Secondary monitors are frequently dedicated to specific tasks (browser, shell), or for monitoring various activities such as logs and dashboards. -Thus, using one workspace per each secondary monitors and "the rest" on the main monitor often makes sense. +Thus, using one workspace per secondary monitor and "the rest" on the main monitor often makes sense. [NOTE] ==== diff --git a/docs/util/all-monitors-option.adoc b/docs/util/all-monitors-option.adoc index 674acedf..2ac4b85f 100644 --- a/docs/util/all-monitors-option.adoc +++ b/docs/util/all-monitors-option.adoc @@ -1,6 +1,6 @@ --all:: Alias for `--monitor all`. -Please use this option *with cautious*. +Please use this option *with caution*. Use it when you really need to get workspaces/windows from *all monitors*. + For multi-monitor setup `--monitor focused` is almost always a preferred option.