{"id":16406481,"url":"https://github.com/wincent/vim-clipper","last_synced_at":"2025-03-21T03:30:53.545Z","repository":{"id":34641105,"uuid":"38597537","full_name":"wincent/vim-clipper","owner":"wincent","description":"Clipper integration for Vim","archived":false,"fork":false,"pushed_at":"2023-10-24T22:25:11.000Z","size":23,"stargazers_count":43,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-12T06:09:55.879Z","etag":null,"topics":["clipper","vim"],"latest_commit_sha":null,"homepage":"","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wincent.png","metadata":{"files":{"readme":"README.txt","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2015-07-06T04:28:30.000Z","updated_at":"2024-03-05T22:24:55.000Z","dependencies_parsed_at":"2022-08-29T06:30:50.296Z","dependency_job_id":"a837c8a2-4f44-4648-8ff2-f5f1acd7db61","html_url":"https://github.com/wincent/vim-clipper","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fvim-clipper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fvim-clipper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fvim-clipper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fvim-clipper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wincent","download_url":"https://codeload.github.com/wincent/vim-clipper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221811375,"owners_count":16884305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clipper","vim"],"created_at":"2024-10-11T06:09:55.182Z","updated_at":"2025-03-21T03:30:53.529Z","avatar_url":"https://github.com/wincent.png","language":"Vim Script","funding_links":[],"categories":[],"sub_categories":[],"readme":"*clipper.txt* Clipper plug-in for Vim                       *clipper* *vim-clipper*\n\nCONTENTS                                                     *clipper-contents*\n\n 1. Intro           |clipper-intro|\n 2. Installation    |clipper-installation|\n 3. Commands        |clipper-commands|\n 4. Options         |clipper-options|\n 5. Functions       |clipper-functions|\n 6. Mappings        |clipper-mappings|\n 7. Website         |clipper-website|\n 8. License         |clipper-license|\n 9. Development     |clipper-development|\n10. Authors         |clipper-authors|\n11. History         |clipper-history|\n\n\nINTRO                                                           *clipper-intro*\n\n    \"clipper (noun)\n    an instrument for cutting or trimming small pieces off things.\"\n\n                                                             *clipper-features*\nvim-clipper provides integration between Vim and Clipper\n(https://github.com/wincent/clipper), which is an macOS \"launch agent\" that\nruns in the background providing a service that exposes the local clipboard to\ntmux sessions and other processes running both locally and remotely.\n\nSpecifically, vim-clipper provides a |:Clip| command, to send the last-yanked\ntext to Clipper, it sets up a \u003cleader\u003ey mapping that calls |:Clip|.\nAdditionally, if the |TextYankPost| |autocommand| is available, it will send\nthe last-yanked text to Clipper automatically.\n\nvim-clipper supports both Vim and Neovim. nvim-clipper\n(https://github.com/wincent/nvim-clipper) is a streamlined, Lua-only\nequivalent designed to support only Neovim.\n\n\nINSTALLATION                                             *clipper-installation*\n\nTo install vim-clipper, use your plug-in management system of choice.\n\nIf you don't have a \"plug-in management system of choice\", I recommend\nPathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and\nrobustness. Assuming that you have Pathogen installed and configured, and that\nyou want to install vim-clipper into `~/.vim/bundle`, you can do so with: \u003e\n\n  git clone https://github.com/wincent/vim-clipper.git ~/.vim/bundle/vim-clipper\n\nAlternatively, if you use a Git submodule for each Vim plug-in, you could do\nthe following after `cd`-ing into the top-level of your Git superproject: \u003e\n\n  git submodule add https://github.com/wincent/vim-clipper.git ~/vim/bundle/vim-clipper\n  git submodule init\n\nTo generate help tags under Pathogen, you can do so from inside Vim with: \u003e\n\n  :call pathogen#helptags()\n\n\nCOMMANDS                                                     *clipper-commands*\n\n                                                                        *:Clip*\n:Clip       Sends the last-yanked text to Clipper.\n\n\nOPTIONS                                                       *clipper-options*\n\n                                                             *g:ClipperAddress*\n  |g:ClipperAddress|                                string (default: localhost)\n\n  Specifies the address at which to connect to the Clipper daemon. To override\n  from the default of \"localhost\", set it in your |.vimrc|. The main reason\n  you would want to do this is to make Clipper connect to a UNIX domain\n  socket: \u003e\n\n    let g:ClipperAddress=~/.clipper.sock\n\u003c\n  Note that if you want to connect using a UNIX domain socket, you must also\n  set |g:ClipperPort| to 0.\n\n  If |g:ClipperAddress| and |g:ClipperPort| provide insufficient\n  configurability (for example, because you are using a version of `nc` that\n  doesn't support UNIX sockets and want to use an alternative like\n  `socat - UNIX-CLIENT:$SOCKET`), then you can use |clipper#set_invocation()|\n  to provide an entirely custom string.\n\n                                                                *g:ClipperPort*\n  |g:ClipperPort|                                        number (default: 8377)\n\n  Specifies the port on which to connect to the Clipper daemon. To override\n  from the default of port 8377, set it in your |.vimrc|: \u003e\n\n    let g:ClipperPort=31337\n\u003c\n  To connect via a UNIX domain socket, set the port number to 0, and provide\n  the path to the socket using the |g:ClipperAddress| option.\n\n  If |g:ClipperAddress| and |g:ClipperPort| provide insufficient\n  configurability (for example, because you are using a version of `nc` that\n  doesn't support UNIX sockets and want to use an alternative like\n  `socat - UNIX-CLIENT:$SOCKET`), then you can use |clipper#set_invocation()|\n  to provide an entirely custom string.\n\n                                                                *g:ClipperAuto*\n  |g:ClipperAuto|                                          boolean (default: 1)\n\n  Controls whether to use the |TextYankPost| autocommand to route yanked text\n  to Clipper automatically. To prevent this, set to 0 in your |.vimrc|: \u003e\n\n    let g:ClipperAuto=0\n\u003c\n                                                                 *g:ClipperMap*\n  |g:ClipperMap|                                           boolean (default: 1)\n\n  Controls whether to set up the |\u003cPlug\u003e(ClipperClip)| mapping. To prevent any\n  mapping from being configured, set to 0 in your |.vimrc|: \u003e\n\n    let g:ClipperMap=0\n\u003c\n                                                              *g:ClipperLoaded*\n  |g:Clipper|                                                  any (no default)\n\n  To prevent vim-clipper from being loaded, set |g:ClipperLoaded| to any value\n  in your |.vimrc|. For example: \u003e\n\n    let g:ClipperLoaded=1\n\n\nFUNCTIONS                                                   *clipper-functions*\n\n\n  |clipper#set_invocation()|                         *clipper#set_invocation()*\n\n  Provide a completely custom string to invoke an arbitrary executable with\n  arguments. This overrides the automatic invocation that would usually be\n  created using `nc` and the values of |g:ClipperAddress| and |g:ClipperPort|.\n  This may be necessary in environments where you want to use a UNIX domain\n  socket but the local version of `nc` does not support the `-U` switch. For\n  example: \u003e\n\n    call clipper#set_invocation('socat - UNIX-CLIENT:/path/to/socket')\n\u003c\n  Note: This is a function and not a setting for security reasons; only the\n  first call to |clipper#set_invocation()| will have any effect. In this way,\n  you can place the call near the start of your |vimrc| without having to\n  worry that a malicious plug-in will later overwrite it with something\n  nefarious (important because whatever is passed to this function will be\n  blindly executed with the |system()| function).\n\n  As such, even if you don't want to use this feature, it is a good\n  idea to lock it down by calling `clipper#set_invocation('')` in your\n  |vimrc|.\n\n\nMAPPINGS                                                     *clipper-mappings*\n\n                                                            *\u003cPlug\u003eClipperClip*\n                                                          *\u003cPlug\u003e(ClipperClip)*\nvim-clipper maps \u003cleader\u003ey to |\u003cPlug\u003e(ClipperClip)|, which sends the last-yanked\ntext to Clipper. To use an alternative mapping instead, create a different one\nin your |.vimrc| instead using |:nmap|: \u003e\n\n  \" Instead of \u003cleader\u003ey, use \u003cleader\u003ex.\n  nmap \u003cleader\u003ex \u003cPlug\u003e(ClipperClip)\n\nNote that vim-clipper will not try to set up its \u003cleader\u003ey mapping if any of\nthe following are true:\n\n- A mapping for \u003cleader\u003ey already exists.\n- An alternative mapping for |\u003cPlug\u003e(ClipperClip)| has already been set up from\n  a |.vimrc|.\n- The mapping has been suppressed by setting |g:ClipperMap| to 1 in your\n  |.vimrc|.\n\n\nWEBSITE                                                       *clipper-website*\n\nSource code:\n\n  https://github.com/wincent/vim-clipper\n\nOfficial releases are listed at:\n\n  http://www.vim.org/scripts/script.php?script_id=5217\n\n\nLICENSE                                                       *clipper-license*\n\nCopyright 2015-present Greg Hurrell. All rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice,\n   this list of conditions and the following disclaimer.\n2. Redistributions in binary form must reproduce the above copyright notice,\n   this list of conditions and the following disclaimer in the documentation\n   and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\nARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE\nLIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\nCONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\nSUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\nINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\nCONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\nARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\nPOSSIBILITY OF SUCH DAMAGE.\n\nDEVELOPMENT                                               *clipper-development*\n\nContributing patches ~\n\nPatches can be sent via mail to greg@hurrell.net, or as GitHub pull requests\nat: https://github.com/wincent/vim-clipper/pulls\n\nCutting a new release ~\n\nAt the moment the release process is manual:\n\n- Perform final sanity checks and manual testing\n- Update the |clipper-history| section of the documentation\n- Verify clean work tree:\n\u003e\n    git status\n\u003c\n- Tag the release:\n\u003e\n    git tag -s -m \"$VERSION release\" $VERSION\n\u003c\n- Publish the code:\n\u003e\n    git push origin main --follow-tags\n    git push github main --follow-tags\n\u003c\n- Produce the release archive:\n\u003e\n    git archive -o vim-clipper-$VERSION.zip HEAD -- .\n\u003c\n- Upload to http://www.vim.org/scripts/script.php?script_id=5217\n\n\nAUTHORS                                                       *clipper-authors*\n\nvim-clipper is written and maintained by Greg Hurrell \u003cgreg@hurrell.net\u003e.\nOther contributors that have submitted patches include, in alphabetical order:\n\n  J. Eduardo\n\nThis list produced with:\n\n    :read !git shortlog -s HEAD | grep -v 'Greg Hurrell' | cut -f 2-3 | column -c 72 | expand | sed -e 's/^/  /'\n\n\nHISTORY                                                       *clipper-history*\n\n2.2 (8 December 2020):\n\n- Attempt to autodetect when host platform's `nc` executable requires the `-N`\n  switch (https://github.com/wincent/vim-clipper/pull/3).\n- Make autodetection work case-insensitively (patch from J Eduardo,\n  https://github.com/wincent/vim-clipper/pull/5).\n\n2.1 (6 March 2019)\n\n- Add ability to customize invocation with |clipper#set_invocation()|.\n\n2.0 (25 August 2017)\n\n- Add ability to automatically send yanked text to Clipper using the\n  |TextYankPost| autocommand, and the corresponding |g:ClipperAuto| setting to\n  provide an opt-out mechanism.\n\n1.0 (3 June 2016)\n\n- Rename |\u003cPlug\u003eClipperClip| to |\u003cPlug\u003e(ClipperClip)|.\n- Add |g:ClipperAddress| and support for connecting to the Clipper daemon via\n  a UNIX domain socket.\n\n0.1 (6 July 2015)\n\n- Initial release, extracted from my dotfiles\n  (https://github.com/wincent/wincent).\n\n\n-----------------------------------------------------------------------------\nvim:tw=78:ft=help:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwincent%2Fvim-clipper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwincent%2Fvim-clipper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwincent%2Fvim-clipper/lists"}