CopyQ Documentation Lukas Holecek Sep 21, 2021 The Basics 1 Installation 3 2 Basic Usage 5 2.1 First Start.................................................5 2.2 Basic Item Manipulation.........................................5 2.3 Search..................................................6 2.4 Tray....................................................6 3 Tabs and Items 7 3.1 Tabs....................................................7 3.2 Storing Clipboard............................................7 3.3 Organizing Items.............................................7 4 Keyboard 9 4.1 Default Shortcuts.............................................9 4.2 Search.................................................. 10 4.3 Change Shortcuts............................................. 10 4.4 Create new Shortcut........................................... 10 5 Images 11 5.1 Display Image Items........................................... 11 5.2 Editor................................................... 11 5.3 Preview Image.............................................. 12 5.4 Take Screenshots............................................. 12 5.5 Save Image to a File........................................... 12 6 Tags 13 7 Security 17 8 Data Storage 19 9 Clipboard Content Visibility 21 10 Clipboard Access 23 11 Theme 25 11.1 Appearance Configuration........................................ 25 i 11.2 Style Sheets............................................... 25 12 FAQ - Frequently Asked Questions 29 12.1 How to open CopyQ window or tray menu using shortcut?....................... 29 12.2 How to paste double-clicked item from CopyQ window?........................ 29 12.3 How to paste as plain text?........................................ 29 12.4 How to store only plain text?....................................... 30 12.5 How to disable storing clipboard?.................................... 30 12.6 How to back up tabs, configuration and commands?.......................... 30 12.7 How to enable or disable displaying notification when clipboard changes?............... 31 12.8 How to load shared commands and share them?............................. 31 12.9 How to omit storing text copied from specific windows like a password manager?........... 31 12.10 How to enable logging?......................................... 32 12.11 How to preserve the order of copied items when copying or pasting multiple items?.......... 32 12.12 How does pasting single/multiple items work internally?........................ 32 12.13 Why does pasting from CopyQ not work?................................ 33 12.14 How to open the menu or context menu with only the keyboard?.................... 33 12.15 How to hide the menu bar in the main CopyQ window?........................ 33 12.16 How to reuse file paths copied from a file manager?.......................... 33 12.17 How to trigger a command based on primary selection only?...................... 34 12.18 Why can I no longer paste from the application on macOS?...................... 34 12.19 Why does my external editor fail to edit items?............................. 35 12.20 Where to find saved items and configuration?.............................. 35 12.21 Why are items and configuration not saved?............................... 35 12.22 Why do global shortcuts not work?................................... 35 12.23 Why does encryption ask for password so often?............................ 36 12.24 How to fix “copyq: command not found” errors?............................ 36 12.25 What to do when CopyQ crashes or misbehaves?............................ 36 13 Known Issues 39 13.1 On Windows, tray icon is hidden/repositioned after restart....................... 39 13.2 On Windows, CopyQ does not print anything on console........................ 39 13.3 On macOS, CopyQ won’t paste after installation/update........................ 40 13.4 On Linux, global shortcuts and pasting doesn’t work.......................... 40 14 Glossary 41 15 Command Line 43 16 Sessions 45 16.1 Running Multiple Instances....................................... 45 16.2 Configuration Path............................................ 46 16.3 Icon Color................................................ 46 17 Pin Items 47 17.1 Why pin items?.............................................. 47 17.2 Configuration............................................... 47 17.3 Pinning Items............................................... 48 18 Password Protection 49 18.1 Installation................................................ 49 18.2 Generate Keys and Set Password.................................... 50 18.3 Protect Tabs............................................... 53 18.4 Protect Single Items........................................... 55 ii 19 Synchronize with Documents 57 19.1 Configuration............................................... 57 19.2 File Types................................................ 58 20 Writing Commands and Adding Functionality 59 20.1 Command Dialog............................................. 59 21 Scripting 65 21.1 Searching Items............................................. 65 21.2 Working with Tabs............................................ 65 21.3 Scripting Functions............................................ 66 22 Command Examples 67 22.1 Join Selected Items............................................ 67 22.2 Paste Current Date and Time....................................... 67 22.3 Play Sound when Copying to Clipboard................................. 68 22.4 Edit and Paste.............................................. 68 22.5 Remove Background and Text Colors.................................. 68 22.6 Linkify.................................................. 69 22.7 Highlight Text.............................................. 69 22.8 Render HTML.............................................. 70 22.9 Translate to English........................................... 70 22.10 Paste and Forget............................................. 71 22.11 Render Math Equations......................................... 71 22.12 Move Images to Other Tab........................................ 72 22.13 Copy Clipboard to Window Tabs.................................... 72 22.14 Quickly Show Current Clipboard Content................................ 72 22.15 Replace All Occurrences in Selected Text................................ 73 22.16 Copy Nth Item.............................................. 73 22.17 Edit Files................................................. 74 22.18 Change Monitoring State Permanently................................. 74 22.19 Show Window Title........................................... 75 22.20 Show Copy Time............................................. 75 22.21 Mark Selected Items........................................... 76 22.22 Change Upper/Lower Case of Selected Text............................... 76 22.23 Change Copied Text to Title Case.................................... 77 23 Script Commands 79 23.1 Extending Command Line Interface................................... 79 23.2 Override Functionality.......................................... 79 24 Display Commands 81 25 Backup 83 25.1 Back Up All Data Automatically on Exit................................ 83 25.2 Back Up Manually............................................ 83 25.3 Export and Import............................................ 84 26 Writing Raw Data 85 27 Scripting API 87 27.1 Execute Script.............................................. 87 27.2 Command Line.............................................. 88 27.3 Functions................................................. 88 27.4 Types................................................... 109 iii 27.5 Objects.................................................. 113 27.6 MIME Types............................................... 113 27.7 Selected Items.............................................. 115 27.8 Linux Mouse Selection.......................................... 115 27.9 Plugins.................................................. 115 28 Build from Source Code 117 28.1 Get the Source Code........................................... 117 28.2 Install Dependencies........................................... 117 28.3 Build and Install............................................. 118 28.4 Qt Creator................................................ 118 28.5 Visual Studio............................................... 119 28.6 Building and Packaging for OS X.................................... 119 29 Fixing Bugs and Adding Features 121 29.1 Making Changes............................................. 121 29.2 Build the Debug Version......................................... 121 29.3 Run Tests................................................. 121 30 Source Code Overview 123 30.1 Applications, Frameworks and Libraries................................. 123 30.2 Application Processes.......................................... 123 30.3 Platform-dependent Code........................................ 125 30.4 Plugins.................................................. 125 30.5 Continuous Integration (CI)....................................... 126 31 Translations 127 31.1 Translating Keyboard Accelerators................................... 127 31.2 Writing Translatable Code........................................ 127 31.3 Adding New Language.......................................... 127 31.4 Updating Translations.......................................... 128 32 Text Encoding 129 33 Customize and Build the Windows Installer 131 33.1 Translations..............................................