77[ ![ Windows Build Status] ( https://ci.appveyor.com/api/projects/status/github/hluk/copyq?branch=master&svg=true )] ( https://ci.appveyor.com/project/hluk/copyq )
88[ ![ Coverage Status] ( https://coveralls.io/repos/hluk/CopyQ/badge.svg?branch=master )] ( https://coveralls.io/r/hluk/CopyQ?branch=master )
99
10- CopyQ is advanced clipboard manager with editing and scripting features.
10+ CopyQ is an advanced clipboard manager with powerful editing and scripting features.
1111
1212- [ Downloads] ( https://github.com/hluk/CopyQ/releases )
1313- [ Web Site] ( https://hluk.github.io/CopyQ/ )
@@ -19,22 +19,22 @@ CopyQ is advanced clipboard manager with editing and scripting features.
1919
2020## Overview
2121
22- CopyQ monitors system clipboard and saves its content in customized tabs.
23- Saved clipboard can be later copied and pasted directly into any application.
22+ * CopyQ monitors the system clipboard and saves its content in customized tabs.
23+ * Saved clipboard entries can later be copied and pasted directly into any application.
2424
2525## Features
2626
27- * Support for Linux, Windows and [ OS X 10.15+] ( https://doc.qt.io/qt-5/macos.html#supported-versions )
28- * Store text, HTML, images or any other custom formats
27+ * Support for Linux, Windows, and [ OS X 10.15+] ( https://doc.qt.io/qt-5/macos.html#supported-versions )
28+ * Store text, HTML, images, and any other custom formats
2929* Quickly browse and filter items in clipboard history
3030* Sort, create, edit, remove, copy/paste, drag'n'drop items in tabs
31- * Add notes or tags to items
32- * System-wide shortcuts with customizable commands
33- * Paste items with shortcut or from tray or main window
31+ * Add notes and tags to items
32+ * System-wide keyboard shortcuts with customizable commands
33+ * Paste items with keyboard shortcuts, from tray, or from main window
3434* Fully customizable appearance
3535* Advanced command-line interface and scripting
36- * Ignore clipboard copied from some windows or containing some text
37- * Support for simple Vim-like editor and shortcuts
36+ * Ignore clipboard copied from specified windows or containing specified text
37+ * Support for simple Vim-like editor with keyboard shortcuts
3838* Many more features
3939
4040## Install
@@ -43,18 +43,18 @@ Saved clipboard can be later copied and pasted directly into any application.
4343 <img src="https://repology.org/badge/vertical-allrepos/copyq.svg" alt="Packaging status" align="right">
4444</a >
4545
46- To install CopyQ, use the binary package or installer provided for your system.
46+ To install CopyQ, use the binary package or the installer provided for your operating system.
4747
48- For unlisted systems, please follow the instructions in
48+ For unlisted operating systems, please follow the instructions in
4949[ Build from Source Code] ( https://copyq.readthedocs.io/en/latest/build-source-code.html ) .
5050
5151### Windows
5252
5353[ ![ Chocolatey package] ( https://repology.org/badge/version-for-repo/chocolatey/copyq.svg )] ( https://repology.org/metapackage/copyq )
5454
55- On Windows you can use one of the following options to install the app :
55+ On Windows you can use any of the following options to install CopyQ :
5656
57- * [ The Installer (setup.exe)] ( https://github.com/hluk/CopyQ/releases )
57+ * [ Installer (setup.exe)] ( https://github.com/hluk/CopyQ/releases )
5858* [ Portable zip package] ( https://github.com/hluk/CopyQ/releases )
5959* [ Scoop package] ( https://scoop.sh/ ) from the [ extras bucket] ( https://github.com/lukesampson/scoop-extras ) .
6060* [ Chocolatey package] ( https://chocolatey.org/packages/copyq )
@@ -75,21 +75,29 @@ choco install copyq
7575
7676[ ![ Homebrew package] ( https://repology.org/badge/version-for-repo/homebrew_casks/copyq.svg )] ( https://repology.org/metapackage/copyq )
7777
78- On OS X you can use [ Homebrew] ( https://brew.sh/ ) to install the app.
78+ On OS X you can use [ Homebrew] ( https://brew.sh/ ) to install CopyQ:
7979
8080``` bash
8181brew install --cask copyq
8282```
8383
84- ### Debian 10+, Ubuntu 18.04+, and their derivatives
84+ If you encounter an issue where the app crashes with a dialog saying "CopyQ is
85+ damaged" or "CopyQ cannot be opened", you may need to run the following
86+ commands (for details, see #2652 ):
8587
86- Install ` copyq ` package.
88+ ``` bash
89+ xattr -d com.apple.quarantine /Applications/CopyQ.app
90+ codesign --force --deep --sign - /Applications/CopyQ.app
91+ ```
92+
93+ ### Debian 11+, Ubuntu 22.04+, and their derivatives
8794
88- ` copyq-plugins ` is highly recommended. ` copyq-doc ` available .
95+ Install ` copyq ` and ` copyq-plugins ` packages .
8996
9097#### Ubuntu PPA
9198
92- Install and keep CopyQ always up to date by running the following three commands from the terminal:
99+ Install and keep CopyQ always up to date by running the following commands from
100+ the terminal (the package from PPA contains all plugins and documentation):
93101
94102``` bash
95103sudo add-apt-repository ppa:hluk/copyq
@@ -107,41 +115,41 @@ Install `copyq` package.
107115
108116### Other Linux Distributions
109117
110- Install [ Flatpak] ( https://www. flatpak.org/ ) and ` com.github.hluk.copyq ` from
118+ Install [ Flatpak] ( https://flatpak.org/ ) and ` com.github.hluk.copyq ` from
111119[ Flathub] ( https://flathub.org/ ) .
112120
113121``` bash
114122flatpak install flathub com.github.hluk.copyq
115123```
116124
117- Start the application from menu or with following command:
125+ Start CopyQ from the menu or with the following command:
118126
119127``` bash
120128flatpak run com.github.hluk.copyq
121129```
122130
123131## Using the App
124132
125- To start the application double-click the program icon or run ` copyq ` .
133+ To start CopyQ, double-click the program icon or run ` copyq ` .
126134
127- The list with clipboard history is accessible by clicking on system tray icon
128- or running ` copyq toggle ` .
135+ The list with the clipboard history is accessible by clicking on the system tray icon
136+ or by running ` copyq toggle ` .
129137
130- Copying text or image to clipboard will create new item in the list.
138+ Copying text or image to the clipboard will create a new item in the list.
131139
132140Selected items can be:
133141
134142* edited (` F2 ` )
135143* removed (` Delete ` )
136144* sorted (` Ctrl+Shift+S ` , ` Ctrl+Shift+R ` )
137- * moved around (with mouse or ` Ctrl+Up/Down ` )
138- * copied back to clipboard (` Ctrl+C ` )
139- * pasted to previously active window (` Enter ` )
145+ * repositioned (with mouse or ` Ctrl+Up/Down ` )
146+ * copied back to the clipboard (` Ctrl+C ` )
147+ * pasted to the previously active window (` Enter ` )
140148
141- All items will be restored when application is started next time .
149+ All items will be restored when CopyQ is next started .
142150
143- To exit the application select Exit from tray menu or press ` Ctrl-Q ` keys in the
144- application window.
151+ To exit CopyQ, select Exit from the tray menu or press ` Ctrl-Q ` in the
152+ CopyQ window.
145153
146154Read more:
147155
@@ -150,14 +158,14 @@ Read more:
150158
151159### Adding Functionality
152160
153- To create custom action that can be executed
154- from menu, with shortcut or when clipboard changes:
155- - go to Command dialog (` F6 ` shortcut),
156- - click Add button and select predefined command or create new one,
157- - optionally change the command details (shortcut, name),
158- - click OK to save the command.
161+ To create custom actions that can be executed
162+ from the menu, with keyboard shortcuts, or when the clipboard changes:
163+ - go to the Command dialog (` F6 ` shortcut)
164+ - click the ` Add ` button, then select a predefined command, or create a new one
165+ - optionally change the command details (shortcut, name)
166+ - click ` OK ` to save the command
159167
160- One of very useful predefined commands there is "Show/hide main window".
168+ One of the very useful predefined commands is "Show/hide main window".
161169
162170Read more:
163171
@@ -166,34 +174,34 @@ Read more:
166174
167175### Command Line
168176
169- CopyQ has powerful command line and scripting interface.
177+ CopyQ has a powerful command line and scripting interface.
170178
171- Note: The main application must be running to be able to issue commands using
179+ Note: The main application must be running to be able to issue commands using the
172180command line.
173181
174182Print help for some useful command line arguments:
175183
176184 copyq --help
177185 copyq --help add
178186
179- Insert some texts to the history:
187+ Insert some text in the history:
180188
181189 copyq add -- 'first item' 'second item' 'third item'
182190
183- Omitting double-dash (` -- ` ) in the command above would mean that slash
184- (` \ ` ) in arguments will be treated as special character so that ` \n ` is new
185- line character, ` \t ` is tab, ` \\ ` is slash, ` \x ` is ` x ` etc.
191+ Omitting the double-dash (` -- ` ) in the command above would mean that slashes
192+ (` \ ` ) in arguments will be treated as special characters. For example, ` \n ` will be treated as
193+ the new line character, ` \t ` as tab, ` \\ ` as slash, ` \x ` as ` x ` , etc.
186194
187- Create single item containing two lines:
195+ Create a single item containing two lines:
188196
189197 copyq add 'first line\nsecond line'
190198
191- Print content of the first three items:
199+ Print the content of the first three items:
192200
193201 copyq read 0 1 2
194202 copyq separator "," read 0 1 2
195203
196- Show current clipboard content:
204+ Show the current clipboard content:
197205
198206 copyq clipboard
199207 copyq clipboard text/html
@@ -203,7 +211,7 @@ Copy text to the clipboard:
203211
204212 copyq copy "Some Text"
205213
206- Load file content into clipboard:
214+ Load file content into the clipboard:
207215
208216 copyq copy - < file.txt
209217 copyq copy text/html < index.html
@@ -221,7 +229,7 @@ Read more:
221229
222230## Build from Source Code
223231
224- To build the application from source code, first install the required dependencies:
232+ To build CopyQ from source code, first install the required dependencies:
225233
226234- [ Git] ( https://git-scm.com/ )
227235- [ CMake] ( https://cmake.org/download/ )
@@ -249,7 +257,8 @@ sudo apt install \
249257 qttools5-dev \
250258 qttools5-dev-tools \
251259 qtwayland5 \
252- qtwayland5-dev-tools
260+ qtwayland5-dev-tools \
261+ libkf5notifications-dev
253262```
254263#### RHEL / CentOS / Oracle Linux
255264
@@ -271,7 +280,7 @@ sudo yum install \
271280 kf5-knotifications-devel
272281```
273282
274- ### Build the App
283+ ### Build CopyQ
275284
276285Change install prefix if needed:
277286
@@ -290,7 +299,7 @@ You can now run the built app.
290299
291300## Contributions
292301
293- You can help translate the application (click the banner below)
302+ You can help translate CopyQ (click the banner below)
294303or help [ fix issues and implement new features] ( https://github.com/hluk/CopyQ/issues ) .
295304
296305[ ![ Translations] ( https://hosted.weblate.org/widgets/copyq/-/287x66-white.png )] ( https://hosted.weblate.org/engage/copyq/?utm_source=widget )
0 commit comments