Skip to content

Commit

Permalink
readme style
Browse files Browse the repository at this point in the history
  • Loading branch information
janlelis committed Feb 18, 2015
1 parent 05510b7 commit 996cc4d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,4 +1,4 @@
Copyright (c) 2010-2014 Jan Lelis
Copyright (c) 2010-2015 Jan Lelis

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
19 changes: 8 additions & 11 deletions README.rdoc
@@ -1,5 +1,5 @@
= clipboard {<img src="https://travis-ci.org/janlelis/clipboard.png" />}[https://travis-ci.org/janlelis/clipboard]
Access the clipboard and do not care if you are on Linux, Mac OS or Windows.
Lets you access the clipboard on Linux, MacOS or Windows.

=== Usage
* <tt>Clipboard.copy</tt>
Expand All @@ -12,10 +12,10 @@ Access the clipboard and do not care if you are on Linux, Mac OS or Windows.
* *Linux*: +xclip+ or +xsel+, you can install it on debian/ubuntu with <tt>sudo apt-get install xclip</tt>

==== ffi Dependency
This gem depends on the ffi gem to support the Windows clipboard. However, since ffi is not plain Ruby, it cannot be installed in every Ruby environment and therefore, ffi is not a hard dependency of this gem. To ensure Windows compatibility, you can put the ffi gem in your Gemfile.
This gem depends on the *ffi* gem to support the Windows clipboard. Since *ffi* requires native support, it cannot be installed on evevry platform and is not a hard dependency. If you need Windows support, you will need to put the *ffi* gem into your Gemfile.

==== Multiple Clipboards
On Linux, you can choose from which clipboard you want to +paste+ by supplying an argumument, the default is CLIPBOARD.
On Linux, you can choose from which clipboard you want to +paste+ by passing it as an argumument. The default is CLIPBOARD.

+copy+ copies to all clipboards in Clipboard::CLIPBOARDS.

Expand All @@ -26,20 +26,17 @@ If you paste with 1.8, it will fallback to CP850 encoding.
Copying with 1.8 will fallback to the +clip+ utility, which is installed by default since Vista

==== SSH
To use the clipboard through ssh, you need to install <tt>xauth</tt> on your server and connect via <tt>ssh -X</tt> or <tt>ssh -Y</tt>. However, some server settings restrict that feature, so don't rely on it, untested.
To use the clipboard through ssh, you need to install <tt>xauth</tt> on your server and connect via <tt>ssh -X</tt> or <tt>ssh -Y</tt>. Please note that some server settings restrict this feature.

==== Java
There is a java implementation included (<tt>Clipboard::Java</tt>) as an option for JRuby. However, on Linux, it always operates (only) on the CLIPBOARD clipboard.
There is a Java implementation included (<tt>Clipboard::Java</tt>) as an option for JRuby. However, on Linux, it always operates only on the CLIPBOARD clipboard.

=== TODO
* Don't depend on +xclip+/+xsel+ (no plans to implement it, though)

=== blip
Want to access the clipboard form the command line? Try {blip}[http://rubygems.org/gems/blip]!

=== Copyright
Copyright (c) 2010-2014 Jan Lelis <http://janlelis.de> released under the MIT license. Contributions by / thanks to
* Michael Grosser
* See https://github.com/janlelis/clipboard/graphs/contributors for full list!
*blip* is a handy commandline wrapper that lets you quickly copy file content to your clipboard: {blip}[http://rubygems.org/gems/blip]!

J-_-L
=== Copyright
Copyright (c) 2010-2015 Jan Lelis <http://janlelis.de> released under the MIT license. Contributions by and thanks to Michael Grosser and {all the other contributors!}[https://github.com/janlelis/clipboard/graphs/contributors]

0 comments on commit 996cc4d

Please sign in to comment.