From 8394efc667151d1f607d759805f1a90f1998d10a Mon Sep 17 00:00:00 2001 From: drewbrokke Date: Tue, 27 Oct 2020 16:26:47 -0500 Subject: [PATCH] documents 'copyToClipboardCommand' configuration item --- README.md | 85 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 47 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index c8be670..17f6579 100644 --- a/README.md +++ b/README.md @@ -2,44 +2,45 @@ # Table of Contents -- [Table of Contents](#table-of-contents) -- [jack](#jack) -- [Motivation](#motivation) -- [Installation](#installation) -- [Usage](#usage) - - [Viewing a Git log](#viewing-a-git-log) - - [Built-in Key Commands](#built-in-key-commands) - - [Meta](#meta) - - [Navigation](#navigation) - - [Searching](#searching) - - [Actions](#actions) -- [Configuration](#configuration) - - [Configuration options](#configuration-options) - - [**blacklistPatterns**](#blacklistpatterns) - - [**commands**](#commands) - - [**gitShowOptions**](#gitshowoptions) - - [**notificationTimeout**](#notificationtimeout) - - [**searchIndexLimit**](#searchindexlimit) - - [**showLineNumbers**](#showlinenumbers) - - [**useLegacyEscapeKeyBehavior**](#uselegacyescapekeybehavior) - - [**useSearchIndex**](#usesearchindex) - - [The `Command` object](#the-command-object) - - [**command (Required)**](#command-required) - - [**description (Required)**](#description-required) - - [**foreground (Optional)**](#foreground-optional) - - [**key (Required)**](#key-required) - - [**onErrorCommand (Optional)**](#onerrorcommand-optional) - - [**refreshOnComplete (Optional)**](#refreshoncomplete-optional) - - [Placeholder tokens](#placeholder-tokens) - - [**COMMIT_MESSAGE**](#commit_message) - - [**SHA_RANGE**](#sha_range) - - [**SHA_SINGLE_OR_RANGE**](#sha_single_or_range) - - [**SHA_SINGLE**](#sha_single) - - [Environment variables](#environment-variables) - - [JACK_CLI_CONFIG_FILE_PATH](#jack_cli_config_file_path) - - [Miscellaneous](#miscellaneous) - - [**Why does the `foreground` option for my custom command not work?**](#why-does-the-foreground-option-for-my-custom-command-not-work) - - [**iTerm drag and drop is potentially dangerous while using `jack`**](#iterm-drag-and-drop-is-potentially-dangerous-while-using-jack) +- [Table of Contents](#table-of-contents) +- [jack](#jack) +- [Motivation](#motivation) +- [Installation](#installation) +- [Usage](#usage) + - [Viewing a Git log](#viewing-a-git-log) + - [Built-in Key Commands](#built-in-key-commands) + - [Meta](#meta) + - [Navigation](#navigation) + - [Searching](#searching) + - [Actions](#actions) +- [Configuration](#configuration) + - [Configuration options](#configuration-options) + - [**blacklistPatterns**](#blacklistpatterns) + - [**commands**](#commands) + - [**copyToClipboardCommand**](#copytoclipboardcommand) + - [**gitShowOptions**](#gitshowoptions) + - [**notificationTimeout**](#notificationtimeout) + - [**searchIndexLimit**](#searchindexlimit) + - [**showLineNumbers**](#showlinenumbers) + - [**useLegacyEscapeKeyBehavior**](#uselegacyescapekeybehavior) + - [**useSearchIndex**](#usesearchindex) + - [The `Command` object](#the-command-object) + - [**command (Required)**](#command-required) + - [**description (Required)**](#description-required) + - [**foreground (Optional)**](#foreground-optional) + - [**key (Required)**](#key-required) + - [**onErrorCommand (Optional)**](#onerrorcommand-optional) + - [**refreshOnComplete (Optional)**](#refreshoncomplete-optional) + - [Placeholder tokens](#placeholder-tokens) + - [**COMMIT_MESSAGE**](#commit_message) + - [**SHA_RANGE**](#sha_range) + - [**SHA_SINGLE_OR_RANGE**](#sha_single_or_range) + - [**SHA_SINGLE**](#sha_single) + - [Environment variables](#environment-variables) + - [JACK_CLI_CONFIG_FILE_PATH](#jack_cli_config_file_path) + - [Miscellaneous](#miscellaneous) + - [**Why does the `foreground` option for my custom command not work?**](#why-does-the-foreground-option-for-my-custom-command-not-work) + - [**iTerm drag and drop is potentially dangerous while using `jack`**](#iterm-drag-and-drop-is-potentially-dangerous-while-using-jack) # jack @@ -185,6 +186,14 @@ These options can be configured in the `.jack.json` file: } ``` +### **copyToClipboardCommand** + +**Type**: String + +**Default**: `""` + +**Description**: A command to call when one of the copy text actions is used. The text to copy will be written to the standard input of the command. By default, jack attempts to use `pbcopy` if on macOS or `xsel --input` if on Linux. + ### **gitShowOptions** **Type**: String