Skip to content

Update README to Markdown format #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jasper-zanjani wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README to Markdown format #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 72 additions & 92 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,77 +1,75 @@


WHAT IS XCLIP?
==============

xclip is a command line utility that is designed to run on any system with an
X11 implementation. It provides an interface to X selections ("the clipboard")
from the command line. It can read data from standard in or a file and place it
in an X selection for pasting into other X applications. xclip can also print
an X selection to standard out, which can then be redirected to a file or
another program.

USING XCLIP
===========

Here are some ideas for things you can do with xclip:

Copy your uptime into the selection for pasting:
uptime | xclip

Copy your password file for pasting:
xclip /etc/passwd

Save some text you have Edit | Copied in a web browser:
xclip -o -sel clip > webpage.txt

Open a URL selected in an email client
mozilla `xclip -o`

Copy XA_PRIMARY to XA_CLIPBOARD
xclip -o | xclip -sel clip

In command mode in vim, select some lines of text, then press shift-:
for an ex prompt, and use this command to copy the selected lines of
text to the primary X selection:
!xclip -f


USING XCLIP FOR MOVING FILES
============================

The programs xclip-copyfile, xclip-pastefile, and xclip-cutfile can be
used for copying and moving files between different directories and
even machines, assuming that you have a working X11 connection. Here
are some examples:

# Copying a file to a remote host
# What is xclip?
__xclip__ is a command line utility that is designed to run on any system with an X11 implementation. It provides an interface to X selections ("the clipboard") from the command line. It can read data from standard in or a file and place it in an X selection for pasting into other X applications. __xclip__ can also print an X selection to standard out, which can then be redirected to a file or another program.

## Using xclip
Here are some ideas for things you can do with __xclip__:

Copy your uptime into the selection for pasting:
```sh
uptime | xclip
```

Copy your password file for pasting:
```sh
xclip /etc/passwd
```

Save some text you have Edit | Copied in a web browser:
```sh
xclip -o -sel clip > webpage.txt
```

Open a URL selected in an email client
```sh
mozilla `xclip -o`
```

Copy XA_PRIMARY to XA_CLIPBOARD
```sh
xclip -o | xclip -sel clip
```

In command mode in vim, select some lines of text, then press `<Shift-:>` for an ex prompt, and use this command to copy the selected lines of text to the primary X selection:
```vim
!xclip -f
```

## Using xclip for moving files
The programs __xclip-copyfile__, __xclip-pastefile__, and __xclip-cutfile__ can be used for copying and moving files between different directories and even machines, assuming that you have a working X11 connection. Here are some examples:

### Copying a file to a remote host
```sh
[maggie.lkpg.cendio.se ~]$ echo "A file created on ${HOSTNAME}" > file1
[maggie.lkpg.cendio.se ~]$ xclip-copyfile file1
[sofie.homeip.net ~/doc]$ xclip-pastefile
file1
[sofie.homeip.net ~/doc]$ cat file1
A file created on maggie.lkpg.cendio.se
```


# Copying an entire tree structure
### Copying an entire tree structure
```sh
[sofie.homeip.net ~]$ xclip-copyfile doc
[maggie.lkpg.cendio.se ~/tmp]$ xclip-pastefile
doc/
doc/letter-mom-april.txt
doc/file1
doc/letter-dad-march.txt
```


# Copying files with preserved path information
### Copying files with preserved path information
```sh
[maggie.lkpg.cendio.se ~]$ xclip-copyfile -p /etc/sysconfig/grub
tar: Removing leading `/' from member names
[sofie.homeip.net ~/tmp]$ xclip-pastefile
etc/sysconfig/grub
[sofie.homeip.net ~/tmp]$ ls etc/sysconfig/grub
etc/sysconfig/grub
```


# Moving files
### Moving files
```sh
[sofie.homeip.net ~]$ ls letter-brother-may.txt
letter-brother-may.txt
[sofie.homeip.net ~]$ xclip-cutfile letter-brother-may.txt
Expand All @@ -80,52 +78,34 @@ ls: cannot access letter-brother-may.txt: No such file or directory
[sofie.homeip.net ~]$ cd doc
[sofie.homeip.net ~/doc]$ xclip-pastefile
letter-brother-may.txt


FEATURES
========

* Reads data piped to standard in or files given as arguments
* Prints contents of selection to standard out
* Accesses the XA_PRIMARY, XA_SECONDARY or XA_CLIPBOARD selection
* Accesses the cut-buffers
* Supports the INCR mechanism for large transfers
* Connects to the X display in $DISPLAY, or specified with -display host:0
* Waits for selection requests in the background

SELECTIONS
==========

```
## Features
- Reads data piped to standard in or files given as arguments
- Prints contents of selection to standard out
- Accesses the `XA_PRIMARY`, `XA_SECONDARY` or `XA_CLIPBOARD` selection
- Accesses the cut-buffers
- Supports the `INCR` mechanism for large transfers
- Connects to the X display in `$DISPLAY`, or specified with `-display host:0 `
- Waits for selection requests in the background

## Selections
For a good overview of what selections are about, have a look at
<https://specifications.freedesktop.org/clipboards-spec/clipboards-latest.txt>. Short version:

* XA_PRIMARY contains the last text you highlighted
* Middle click pastes XA_PRIMARY
* XA_CLIPBOARD contains text explicitly copied with Edit | Copy, Ctrl-C etc.
* Edit | Paste pastes XA_CLIPBOARD
* xclip uses XA_PRIMARY unless you specify otherwise with -selection

CAN I HELP?
===========
* `XA_PRIMARY` contains the last text you highlighted
* Middle click pastes `XA_PRIMARY`
* `XA_CLIPBOARD` contains text explicitly copied with Edit | Copy, Ctrl-C etc.
* Edit | Paste pastes `XA_CLIPBOARD`
* __xclip__ uses `XA_PRIMARY` unless you specify otherwise with `-selection`

Glad you asked! At this stage, I'm pretty happy with the features and
implementation, so if you have anything at all that should be done, I want to
hear about it. Doesn't matter how small, compiler warnings, segfaults, spelling
mistakes, whatever, I want to get it sorted out. xclip is not a big project,
I'd like to get all these things sorted out and then declare it "complete".

LICENSE
=======
## Can I help?
Glad you asked! At this stage, I'm pretty happy with the features and implementation, so if you have anything at all that should be done, I want to hear about it. Doesn't matter how small, compiler warnings, segfaults, spelling mistakes, whatever, I want to get it sorted out. __xclip__ is not a big project, I'd like to get all these things sorted out and then declare it "complete".

## License
GNU GPL, see the COPYING file for details.

CONTACT
=======

Web:
https://github.com/astrand/xclip

Email:
astrand@lysator.liu.se
## Contact
- [Web](https://github.com/astrand/xclip)
- [Email](astrand@lysator.liu.se)

Please email me about problems, experiences, patches, fixes, etc.