File: faq.rst

package info (click to toggle)
copyq 3.7.3-1~bpo9+1
  • links: PTS, VCS
  • area: main
  • in suites: stretch-backports
  • size: 10,480 kB
  • sloc: cpp: 51,894; sh: 734; python: 211; xml: 57; makefile: 34
file content (369 lines) | stat: -rw-r--r-- 12,281 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
FAQ - Frequently Asked Questions
================================

.. _faq-show-app:

How to open application window or tray menu using shortcut?
-----------------------------------------------------------

Add new command to open window or menu with global shortcut:

1. open "Command" dialog (``F6`` shortcut),
2. click "Add" button in the dialog,
3. select "Show/hide main window" or "Show the tray menu" from the list
   and click "OK" button,
4. click the button next to "Global Shortcut" label and set the
   shortcut,
5. click "OK" button to save the changes.

For more information about commands see :ref:`writing-commands`.

.. _faq-paste-from-window:

How to paste double-clicked item from application window?
---------------------------------------------------------

1. Open "Preferences" (``Ctrl+P`` shortcut),
2. go to "History" tab,
3. enable "Paste to current window" option.

Next time you open main window and activate an item it should be pasted.

How to paste as plain text?
---------------------------

To **paste clipboard as plain text**:

1. open "Command" dialog (``F6`` shortcut),
2. click "Add" button in the dialog,
3. select "Paste clipboard as plain text" from the list and click "OK" button,
4. click the button next to "Global Shortcut" label and set the shortcut,
5. click "OK" button to save the changes.

To **paste selected items as plain text** (from application window) follow the steps above
but add "Paste as Plain Text" command instead and change "Shortcut".

You can also disallow rich text storing: go to preferences,
"Items" tab and uncheck "Web" checkbox under "Text" uncheck "HTML" checkbox.

.. _faq-disable-clipboard-storing:

How to disable storing clipboard?
---------------------------------

To temporarily disable storing clipboard in item list,
select menu item "File - Disable Clipboard Storing" (``Ctrl+Shift+X`` shortcut).
To re-enable the functionality select "File - Enable Clipboard Storing" (same shortcut).

To permanently disable storing clipboard:

1. Open "Preferences" (``Ctrl+P`` shortcut),
2. go to "History" tab,
3. clear "Tab for storing clipboard" field.

How to back up tabs, configuration and commands?
------------------------------------------------

From menu select "File - Export" and choose what tabs to export and whether to export
configuration and commands.

To restore the backup select menu item "File - Import", select the exported file and
choose what to import back.

.. note::

   Importing tabs and commands won't override existing tabs but create new ones.

How to enable or disable displaying notification when clipboard changes?
------------------------------------------------------------------------

To enable displaying the notifications:

1. open "Preferences" (``Ctrl+P`` shortcut),
2. go to "Notifications" tab,
3. set non-zero value for "Interval in seconds to display notifications",
4. set non-zero value for "Number of lines for clipboard notification",
5. click "OK" button.

To enable displaying the notifications, set either of the options
mentioned above to zero.

.. _faq-share-commands:

How to load shared commands and share them?
-------------------------------------------

You can stumble upon code that looks like this.

.. code-block:: ini

    [Command]
    Name=Show/hide main window
    Command=copyq: toggle()
    Icon=\xf022
    GlobalShortcut=ctrl+shift+1

This code represents a command that can used in CopyQ (specifically it
opens main window on Ctrl+Shift+1). To use the command in CopyQ:

1. copy the code above,
2. open "Command" dialog (``F6`` shortcut),
3. click "Paste Commands" button at the bottom of the dialog,
4. click OK button.

(Now you should be able to open main window with Ctrl+Shift+1.)

To share your commands, you can select the commands from command list in
"Command" dialog and press "Copy Selected" button (or just hit Ctrl+C).

How to omit storing text copied from specific windows like a password manager?
------------------------------------------------------------------------------

Add and modify automatic command to ignore text copied from the window:

1. open "Command" dialog (``F6`` shortcut),
2. click "Add" button in the dialog,
3. select "Ignore *Password* window" from the list and click "OK"
   button,
4. select "Show Advanced"
5. change "Window" text box to match the title (or part of it) of the
   window to ignore (e.g. ``KeePass``),
6. click "OK" button to save the changes.

.. note::

    This new command should be at top of the command list because
    automatic commands are executed in order they appear in the list and we
    don't want to process sensitive data in any way.

.. _faq-logging:

How to enable logging?
----------------------

Set environment variable ``COPYQ_LOG_LEVEL`` to ``DEBUG`` for verbose logging
and set ``COPYQ_LOG_FILE`` to a file path for the log.

You can copy current log file path to clipboard from Action dialog (F5 shortcut)
by entering command ``copyq 'copy(info("log"))'``. Alternatively, press ``F12`` to directly access the log.

How to preserve the order of copied items on copy or pasting multiple items?
----------------------------------------------------------------------------

a. Reverse order of selected items with ``Ctrl+Shift+R`` and copy them or
b. select items in reverse order and copy.

See `#165 <https://github.com/hluk/CopyQ/issues/165#issuecomment-34745058>`__.

How does pasting single/multiple items internally work?
-------------------------------------------------------

``Return`` key copies the whole item (with all formats) to the clipboard
and -- if the "Paste to current window" option is enabled -- it sends
``Shift+Insert`` to previous window. So the target application decides
what format to paste on ``Shift+Insert``.

If you select more items and press ``Return``, just the concatenated
text of selected items is put into clipboard. Thought it could do more
in future, like join HTML, images or other formats.

See `#165 <https://github.com/hluk/CopyQ/issues/165#issuecomment-34957089>`__.

How to open the menu or context menu with only the keyboard?
------------------------------------------------------------

Use ``Alt+I`` to open the item menu or use the ``Menu`` key on your keyboard
to open the context menu for selected items.

How to hide menu bar in main window?
------------------------------------

Menu bar can be hidden by modifying style sheet of current theme.

1. Open "Preferences" (``Ctrl+P`` shortcut),
2. go to "Appearance" tab,
3. enable checkbox "Set colors for tabs, tool bar and menus",
4. click "Edit Theme" button,
5. find ``menu_bar_css`` option and add ``height: 0``:

.. code-block:: ini

    menu_bar_css="
        ;height: 0
        ;background: ${bg}
        ;color: ${fg}"

How to reuse file paths copied from a file manager?
---------------------------------------------------

By default only the text is stored in item list when you copy of cut
files from a file manager. Other data are usually needed to be able to
copy/paste files from CopyQ.

You have to add additional data formats (MIME) using an automatic command
(similar to one below). Commonly used format in many file managers is
``text/uri-list``. Other special formats include
``x-special/gnome-copied-files`` for Nautilus,
``application/x-kde-cutselection`` for Dolphin. These formats are used to
specify type of action (copy or cut).

.. code-block:: ini

    [Command]
    Automatic=true
    Command="
        copyq:
        var formats = [
            mimeUriList,
            'x-special/gnome-copied-files',
            'application/x-kde-cutselection',
        ]

        for (var i in formats) {
            var format = formats[i]
            var data = clipboard(format)
            if ( data.size() > 0 )
               setData(format, data)
        }"
    Icon=\xf56f
    Name=Store File Manager Metadata

Why can I no longer paste from the application on macOS?
--------------------------------------------------------

To fix this you can try following steps.

1. Go to System Preferences -> Security & Privacy -> Privacy -> Accessibility
   (or just search for "Allow apps to use Accessibility"),
2. click the unlock button,
3. select CopyQ from the list and remove it (with the "-" button).

See also `Issue #1030 <https://github.com/hluk/CopyQ/issues/1030>`__.

Why does my external editor fail to edit items?
-----------------------------------------------

CopyQ creates a temporary file with content of the edited item and passes it as
argument to custom editor command. If the file changes, the item is also
modified.

Usual issues are:

- external editor opens an empty file,
- external editor warns that the file is missing or
- saving the file doesn't have any effect on the origin item.

This happens if **the command to launch editor exits but the editor
application itself is still running**. Since the command exited, CopyQ assumes
that the editor itself is no longer running and stops monitoring the changes in
temporary file (and removes the file).

Here is the correct command to use for some editors::

    gvim --nofork %1
    sublime_text --wait %1
    code --wait %1
    open -t -W -n %1

Where to find saved items and configuration?
--------------------------------------------

You can find configuration and saved items in:

- Windows folder ``%APPDATA%\copyq`` for installed version of the app or ``config``
  folder in unzipped portable version,
- Linux directory ``~/.config/copyq``.

Run ``copyq info config`` to get absolute path to the configuration file
(parent directory contains saved items).

.. note::

   Main configuration for installed version of the app on Windows is stored in registry.

Why are items and configuration not saved?
------------------------------------------

Check access rights to configuration directory and files.

Why global shortcuts don't work?
--------------------------------

Global/system shortcuts (or specific key combinations) don't work in some desktop environments (e.g. Wayland on Linux).

As a workaround, you can try to assign the shortcuts in your system settings.

To get the command to launch for a shortcut:

1. open Command dialog (F6 from main window),
2. in left panel, click on the command with the global shortcut,
3. enable "Show Advanced" checkbox,
4. copy the content of "Command" text field.

.. note::

   If the command looks like this:

   ::

      copyq: toggle()

   the actual command to use is:

   ::

      copyq -e "toggle()"

Why does encryption ask for password so often?
----------------------------------------------

Encryption plugin uses ``gpg2`` to decrypt tabs and items. The password usually
needs to be entered only once every few minutes.

If the password prompt is showing up too often, either increase tab unloading
interval ("Unload tab after an interval" option in "History" tab in
Preferences), or change ``gpg`` configuration (see `#946
<https://github.com/hluk/CopyQ/issues/946#issuecomment-389538964>`__).

How to fix "copyq: command not found" errors?
---------------------------------------------

If you're getting ``copyq: command not found`` or similar error, it means that
``copyq`` executable cannot be found by the shell or a language interpreter.

This usually happens if the executable's directory is not in the ``PATH``
environmental variable.

If this happens when running from within the command, e.g.

.. code-block:: bash

    bash:
    text="SOME TEXT"
    copyq copy "$text"

you can **fix it by using** ``COPYQ`` environment variable instead.

.. code-block:: bash

    bash:
    text="SOME TEXT"
    "$COPYQ" copy "$text"

What to do when application crashes or misbehaves?
--------------------------------------------------

When the application crashes or doesn't behave as expected, try to look up
similar `issue <https://github.com/hluk/CopyQ/issues>`__ first and provide
details in a comment.

If you cannot find any such issue, `report a new bug
<https://github.com/hluk/CopyQ/issues/new>`__.

Try to provide following detail.

1. Application version
2. Operating System (desktop environment, window manager etc.)
3. Steps to reproduce the issue.
4. Application log (see :ref:`faq-share-commands`)
5. Back trace if available (e.g. on Linux ``coredumpctl dump --reverse copyq``)