commit e251314099ecd2d68106cf67fa8ae5f2d8756607
parent 52490214bd85a62fc22a0606c4e7fcfdabda0032
Author: Conrad Parker <conrad@metadecks.org>
Date: Fri, 12 Aug 2016 11:10:54 +1000
Merge pull request #9 from gjuniioor/master
Using markdown syntax
Diffstat:
| D | INSTALL | | | 182 | ------------------------------------------------------------------------------- |
| A | INSTALL.md | | | 113 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| D | README | | | 168 | ------------------------------------------------------------------------------- |
| A | README.md | | | 150 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
4 files changed, 263 insertions(+), 350 deletions(-)
diff --git a/INSTALL b/INSTALL
@@ -1,182 +0,0 @@
-Basic Installation
-==================
-
- These are generic installation instructions.
-
- The `configure' shell script attempts to guess correct values for
-various system-dependent variables used during compilation. It uses
-those values to create a `Makefile' in each directory of the package.
-It may also create one or more `.h' files containing system-dependent
-definitions. Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, a file
-`config.cache' that saves the results of its tests to speed up
-reconfiguring, and a file `config.log' containing compiler output
-(useful mainly for debugging `configure').
-
- If you need to do unusual things to compile the package, please try
-to figure out how `configure' could check whether to do them, and mail
-diffs or instructions to the address given in the `README' so they can
-be considered for the next release. If at some point `config.cache'
-contains results you don't want to keep, you may remove or edit it.
-
- The file `configure.in' is used to create `configure' by a program
-called `autoconf'. You only need `configure.in' if you want to change
-it or regenerate `configure' using a newer version of `autoconf'.
-
-The simplest way to compile this package is:
-
- 1. `cd' to the directory containing the package's source code and type
- `./configure' to configure the package for your system. If you're
- using `csh' on an old version of System V, you might need to type
- `sh ./configure' instead to prevent `csh' from trying to execute
- `configure' itself.
-
- Running `configure' takes awhile. While running, it prints some
- messages telling which features it is checking for.
-
- 2. Type `make' to compile the package.
-
- 3. Optionally, type `make check' to run any self-tests that come with
- the package.
-
- 4. Type `make install' to install the programs and any data files and
- documentation.
-
- 5. You can remove the program binaries and object files from the
- source code directory by typing `make clean'. To also remove the
- files that `configure' created (so you can compile the package for
- a different kind of computer), type `make distclean'. There is
- also a `make maintainer-clean' target, but that is intended mainly
- for the package's developers. If you use it, you may have to get
- all sorts of other programs in order to regenerate files that came
- with the distribution.
-
-Compilers and Options
-=====================
-
- Some systems require unusual options for compilation or linking that
-the `configure' script does not know about. You can give `configure'
-initial values for variables by setting them in the environment. Using
-a Bourne-compatible shell, you can do that on the command line like
-this:
- CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
-
-Or on systems that have the `env' program, you can do it like this:
- env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
-
-Compiling For Multiple Architectures
-====================================
-
- You can compile the package for more than one kind of computer at the
-same time, by placing the object files for each architecture in their
-own directory. To do this, you must use a version of `make' that
-supports the `VPATH' variable, such as GNU `make'. `cd' to the
-directory where you want the object files and executables to go and run
-the `configure' script. `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
-
- If you have to use a `make' that does not supports the `VPATH'
-variable, you have to compile the package for one architecture at a time
-in the source code directory. After you have installed the package for
-one architecture, use `make distclean' before reconfiguring for another
-architecture.
-
-Installation Names
-==================
-
- By default, `make install' will install the package's files in
-`/usr/local/bin', `/usr/local/man', etc. You can specify an
-installation prefix other than `/usr/local' by giving `configure' the
-option `--prefix=PATH'.
-
- You can specify separate installation prefixes for
-architecture-specific files and architecture-independent files. If you
-give `configure' the option `--exec-prefix=PATH', the package will use
-PATH as the prefix for installing programs and libraries.
-Documentation and other data files will still use the regular prefix.
-
- In addition, if you use an unusual directory layout you can give
-options like `--bindir=PATH' to specify different values for particular
-kinds of files. Run `configure --help' for a list of the directories
-you can set and what kinds of files go in them.
-
- If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving `configure' the
-option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
-
-Optional Features
-=================
-
- Some packages pay attention to `--enable-FEATURE' options to
-`configure', where FEATURE indicates an optional part of the package.
-They may also pay attention to `--with-PACKAGE' options, where PACKAGE
-is something like `gnu-as' or `x' (for the X Window System). The
-`README' should mention any `--enable-' and `--with-' options that the
-package recognizes.
-
- For packages that use the X Window System, `configure' can usually
-find the X include and library files automatically, but if it doesn't,
-you can use the `configure' options `--x-includes=DIR' and
-`--x-libraries=DIR' to specify their locations.
-
-Specifying the System Type
-==========================
-
- There may be some features `configure' can not figure out
-automatically, but needs to determine by the type of host the package
-will run on. Usually `configure' can figure that out, but if it prints
-a message saying it can not guess the host type, give it the
-`--host=TYPE' option. TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name with three fields:
- CPU-COMPANY-SYSTEM
-
-See the file `config.sub' for the possible values of each field. If
-`config.sub' isn't included in this package, then this package doesn't
-need to know the host type.
-
- If you are building compiler tools for cross-compiling, you can also
-use the `--target=TYPE' option to select the type of system they will
-produce code for and the `--build=TYPE' option to select the type of
-system on which you are compiling the package.
-
-Sharing Defaults
-================
-
- If you want to set default values for `configure' scripts to share,
-you can create a site shell script called `config.site' that gives
-default values for variables like `CC', `cache_file', and `prefix'.
-`configure' looks for `PREFIX/share/config.site' if it exists, then
-`PREFIX/etc/config.site' if it exists. Or, you can set the
-`CONFIG_SITE' environment variable to the location of the site script.
-A warning: not all `configure' scripts look for a site script.
-
-Operation Controls
-==================
-
- `configure' recognizes the following options to control how it
-operates.
-
-`--cache-file=FILE'
- Use and save the results of the tests in FILE instead of
- `./config.cache'. Set FILE to `/dev/null' to disable caching, for
- debugging `configure'.
-
-`--help'
- Print a summary of the options to `configure', and exit.
-
-`--quiet'
-`--silent'
-`-q'
- Do not print messages saying which checks are being made. To
- suppress all normal output, redirect it to `/dev/null' (any error
- messages will still be shown).
-
-`--srcdir=DIR'
- Look for the package's source code in directory DIR. Usually
- `configure' can determine that directory automatically.
-
-`--version'
- Print the version of Autoconf used to generate the `configure'
- script, and exit.
-
-`configure' also accepts some other, not widely useful, options.
diff --git a/INSTALL.md b/INSTALL.md
@@ -0,0 +1,113 @@
+# Basic Installation
+
+#### These are generic installation instructions.
+
+The `configure` shell script attempts to guess correct values for
+various system-dependent variables used during compilation. It uses
+those values to create a `Makefile` in each directory of the package.
+It may also create one or more `.h` files containing system-dependent
+definitions. Finally, it creates a shell script `config.status` that
+you can run in the future to recreate the current configuration, a file
+`config.cache` that saves the results of its tests to speed up
+reconfiguring, and a file `config.log` containing compiler output
+(useful mainly for debugging `configure`).
+
+If you need to do unusual things to compile the package, please try
+to figure out how `configure` could check whether to do them, and mail
+diffs or instructions to the address given in the `README` so they can
+be considered for the next release. If at some point `config.cache`
+contains results you don't want to keep, you may remove or edit it.
+
+The file `configure.in` is used to create `configure` by a program
+called `autoconf`. You only need `configure.in` if you want to change
+it or regenerate `configure` using a newer version of `autoconf`.
+
+#### The simplest way to compile this package is:
+
+1. `cd` to the directory containing the package's source code and type `./configure` to configure the package for your system. If you're using `csh` on an old version of System V, you might need to type `sh ./configure` instead to prevent `csh` from trying to execute `configure` itself.
+Running `configure` takes awhile. While running, it prints some messages telling which features it is checking for.
+
+2. Type `make` to compile the package.
+
+3. Optionally, type `make check` to run any self-tests that come with the package.
+
+4. Type `make install` to install the programs and any data files and documentation.
+
+5. You can remove the program binaries and object files from the source code directory by typing `make clean`. To also remove the files that `configure` created (so you can compile the package for a different kind of computer), type `make distclean`. There is also a `make maintainer-clean` target, but that is intended mainly for the package's developers. If you use it, you may have to get all sorts of other programs in order to regenerate files that came with the distribution.
+
+#### Compilers and Options
+
+Some systems require unusual options for compilation or linking that the `configure` script does not know about. You can give `configure` initial values for variables by setting them in the environment. Using a Bourne-compatible shell, you can do that on the command line like this:
+
+> CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
+
+Or on systems that have the `env` program, you can do it like this:
+
+> env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
+
+### Compiling For Multiple Architectures
+
+You can compile the package for more than one kind of computer at the same time, by placing the object files for each architecture in their own directory. To do this, you must use a version of `make` that supports the `VPATH` variable, such as GNU `make`. `cd` to the directory where you want the object files and executables to go and run the `configure` script. `configure` automatically checks for the source code in the directory that `configure' is in and in `..`.
+
+If you have to use a `make` that does not supports the `VPATH` variable, you have to compile the package for one architecture at a time
+in the source code directory. After you have installed the package for one architecture, use `make distclean` before reconfiguring for another architecture.
+
+### Installation Names
+
+By default, `make install` will install the package's files in `/usr/local/bin`, `/usr/local/man`, etc. You can specify an installation prefix other than `/usr/local` by giving `configure` the option `--prefix=PATH`.
+
+You can specify separate installation prefixes for architecture-specific files and architecture-independent files. If you give `configure` the option `--exec-prefix=PATH`, the package will use PATH as the prefix for installing programs and libraries. Documentation and other data files will still use the regular prefix.
+
+In addition, if you use an unusual directory layout you can give options like `--bindir=PATH` to specify different values for particular kinds of files. Run `configure --help` for a list of the directories you can set and what kinds of files go in them.
+
+If the package supports it, you can cause programs to be installed with an extra prefix or suffix on their names by giving `configure` the option `--program-prefix=PREFIX` or `--program-suffix=SUFFIX`.
+
+### Optional Features
+
+Some packages pay attention to `--enable-FEATURE` options to `configure`, where FEATURE indicates an optional part of the package. They may also pay attention to `--with-PACKAGE` options, where PACKAGE is something like `gnu-as` or `x` (for the X Window System). The `README` should mention any `--enable-` and `--with-` options that the package recognizes.
+
+For packages that use the X Window System, `configure` can usually find the X include and library files automatically, but if it doesn't, you can use the `configure` options `--x-includes=DIR` and `--x-libraries=DIR` to specify their locations.
+
+### Specifying the System Type
+
+There may be some features `configure` can not figure out automatically, but needs to determine by the type of host the package will run on. Usually `configure` can figure that out, but if it prints a message saying it can not guess the host type, give it the `--host=TYPE` option. TYPE can either be a short name for the system type, such as `sun4`, or a canonical name with three fields:
+
+> CPU-COMPANY-SYSTEM
+
+See the file `config.sub` for the possible values of each field. If `config.sub` isn't included in this package, then this package doesn't need to know the host type.
+
+If you are building compiler tools for cross-compiling, you can also use the `--target=TYPE` option to select the type of system they will produce code for and the `--build=TYPE` option to select the type of system on which you are compiling the package.
+
+### Sharing Defaults
+
+If you want to set default values for `configure` scripts to share, you can create a site shell script called `config.site` that gives default values for variables like `CC`, `cache_file`, and `prefix`. `configure` looks for `PREFIX/share/config.site` if it exists, then `PREFIX/etc/config.site` if it exists. Or, you can set the `CONFIG_SITE` environment variable to the location of the site script.
+
+> *Warning*: not all `configure` scripts look for a site script.
+
+### Operation Controls
+
+`configure` recognizes the following options to control how it operates.
+
+##### `--cache-file=FILE`
+
+> Use and save the results of the tests in FILE instead of `./config.cache`. Set FILE to `/dev/null` to disable caching, for debugging `configure`.
+
+##### `--help'
+
+> Print a summary of the options to `configure`, and exit.
+
+##### `--quiet'
+##### `--silent'
+##### `-q'
+
+> Do not print messages saying which checks are being made. To suppress all normal output, redirect it to `/dev/null` (any error messages will still be shown).
+
+##### `--srcdir=DIR'
+
+Look for the package's source code in directory DIR. Usually `configure` can determine that directory automatically.
+
+##### `--version'
+
+> Print the version of Autoconf used to generate the `configure` script, and exit.
+
+`configure` also accepts some other, not widely useful, options.
diff --git a/README b/README
@@ -1,168 +0,0 @@
-XSel -- manipulate the X selection.
-
-Copyright (C) 2001 Conrad Parker <conrad@vergenet.net>
-
-For updates see http://www.vergenet.net/~conrad/software/xsel/
-
-
-INTRODUCTION
-============
-
-XSel is a command-line program for getting and setting the contents of the
-X selection. Normally this is only accessible by manually highlighting
-information and pasting it with the middle mouse button.
-
-
-To read a file into the X selection:
-------------------------------------
-
- xsel < file
-
-after which you can paste the file's contents into any X application with
-the middle mouse button, as though you had highlighted its text. XSel will
-read in the file contents exactly, whereas manual highlighting invariably
-breaks lines and transforms tabs into spaces. This is especially handy for
-copying in large files.
-
-
-To write the X selection to a file:
------------------------------------
-
- xsel > file
-
-after which file will contain exactly the contents of the X selection,
-without trailing newlines and spaces and crap.
-
-
-XSel is more than just cat for the X selection.
-
-
-Append to the X selection:
---------------------------
-
- xsel --append < file
-
-
-To follow a growing file:
--------------------------
-
- xsel --follow < file
-
-to make the X selection follow standard input as it grows (like tail -f).
-
-
-ADVANCED FEATURES
-=================
-
-XSel also lets you access some of the more esoteric features of the
-X selection:
-
-
-Delete the contents of the selection
-------------------------------------
-
- xsel --delete
-
-Will cause the program in which text is selected to delete that text. This
-really works, you can try it on xedit to remotely delete text in the editor
-window.
-
-
-Manipulate the secondary selection
-----------------------------------
-
-The X Window System maintains two selections, the usual primary selection
-and a secondary, which isn't used much ... XSel lets you use the secondary
-selection, for example:
-
- To get and set the secondary selection:
- ---------------------------------------
-
- xsel --secondary < file
- xsel --secondary > file
-
- To swap the primary and secondary selections:
- ---------------------------------------------
- xsel --exchange
-
-So for example you can store useful text in the secondary selection and
-retrieve it later.
-
-
-Manipulate the clipboard selection
-----------------------------------
-
-Similarly, X has a clipboard selection. You can use the standard xclipboard
-program to manage a history of selected text, and you can use xsel to
-actually get text into that clipboard:
-
- xsel --clipboard < file
-
-
-Make the selection contents persist in memory
----------------------------------------------
-
-Normally the X selection only exists as long as the program it was selected
-in is running. Further, some buggy applications tend to forget their
-selection text after a little while. If you run:
-
- xsel --keep
-
-after selecting some important text, xsel will copy the text into its own
-memory so you can paste it elsewhere even if the original program exits or crashes.
-
-
-Further information
-===================
-
-Naturally all these options have single character equivalents, and
-
- xsel --help
-
-provides usage information. For complete details, see the xsel(1x) man page.
-
-
-DOWNLOAD
-========
-
-New versions of XSel are distributed in source form from:
-
- http://www.vergenet.net/~conrad/software/xsel/
-
-
-STANDARDS
-=========
-
-X11 ICCCM2
-----------
-
-XSel conforms to the X Window System Inter-Client Communication Conventions
-Manual Version 2.0 (ICCCM2), including correct handling of TARGETS,
-MULTIPLE, TIMESTAMP, and DELETE targets, INCR properties and large data
-transfers.
-
-My thoughts on ICCCM are available at:
-
- http://lists.slug.org.au/archives/slug-chat/2001/July/msg00054.html
-
-(Warning: explicit language).
-
-
-LICENSE
-=======
-
-Copyright (C) 2001 Conrad Parker <conrad@vergenet.net>
-
-Permission to use, copy, modify, distribute, and sell this software and its
-documentation for any purpose is hereby granted without fee, provided that
-the above copyright notice appear in all copies and that both that copyright
-notice and this permission notice appear in supporting documentation. No
-representations are made about the suitability of this software for any
-purpose. It is provided "as is" without express or implied warranty.
-
-
-CONTACT
-=======
-
-Please direct any queries, bug reports etc. about XSel to the author,
-Conrad Parker conrad@vergenet.net .
diff --git a/README.md b/README.md
@@ -0,0 +1,150 @@
+# XSel -- manipulate the X selection
+
+> Copyright (C) 2001 Conrad Parker <conrad@vergenet.net>
+
+> For updates see http://www.vergenet.net/~conrad/software/xsel/
+
+### INTRODUCTION
+
+XSel is a command-line program for getting and setting the contents of the
+X selection. Normally this is only accessible by manually highlighting
+information and pasting it with the middle mouse button.
+
+##### To read a file into the X selection
+
+```bash
+$ xsel < file
+```
+
+After which you can paste the file's contents into any X application with
+the middle mouse button, as though you had highlighted its text. XSel will
+read in the file contents exactly, whereas manual highlighting invariably
+breaks lines and transforms tabs into spaces. This is especially handy for
+copying in large files.
+
+##### To write the X selection to a file
+
+```bash
+$ xsel > file
+```
+
+After which file will contain exactly the contents of the X selection,
+without trailing newlines and spaces and crap.
+
+XSel is more than just cat for the X selection.
+
+##### Append to the X selection
+
+```bash
+$ xsel --append < file
+```
+
+##### To follow a growing file
+
+```bash
+$ xsel --follow < file
+```
+
+To make the X selection follow standard input as it grows (like `tail -f`).
+
+### ADVANCED FEATURES
+
+XSel also lets you access some of the more esoteric features of the
+X selection:
+
+##### Delete the contents of the selection
+
+```bash
+$ xsel --delete
+```
+
+Will cause the program in which text is selected to delete that text. This
+really works, you can try it on xedit to remotely delete text in the editor
+window.
+
+##### Manipulate the secondary selection
+
+The X Window System maintains two selections, the usual primary selection
+and a secondary, which isn't used much ... XSel lets you use the secondary
+selection, for example:
+
+###### To get and set the secondary selection:
+
+```bash
+$ xsel --secondary < file
+$ xsel --secondary > file
+```
+
+###### To swap the primary and secondary selections:
+```bash
+$ xsel --exchange
+```
+
+So for example you can store useful text in the secondary selection and
+retrieve it later.
+
+##### Manipulate the clipboard selection
+
+Similarly, X has a clipboard selection. You can use the standard xclipboard
+program to manage a history of selected text, and you can use xsel to
+actually get text into that clipboard:
+
+```bash
+$ xsel --clipboard < file
+```
+
+##### Make the selection contents persist in memory
+
+Normally the X selection only exists as long as the program it was selected
+in is running. Further, some buggy applications tend to forget their
+selection text after a little while. If you run:
+
+```bash
+$ xsel --keep
+```
+
+After selecting some important text, xsel will copy the text into its own
+memory so you can paste it elsewhere even if the original program exits or crashes.
+
+### Further information
+
+Naturally all these options have single character equivalents, and
+
+```bash
+$ xsel --help
+```
+
+Provides usage information. For complete details, see the xsel(1x) man page.
+
+### DOWNLOAD
+
+> New versions of XSel are distributed in source form from: http://www.vergenet.net/~conrad/software/xsel/
+
+### STANDARDS
+
+##### X11 ICCCM2
+
+XSel conforms to the X Window System Inter-Client Communication Conventions
+Manual Version 2.0 (ICCCM2), including correct handling of TARGETS,
+MULTIPLE, TIMESTAMP, and DELETE targets, INCR properties and large data
+transfers.
+
+My thoughts on ICCCM are available at: http://lists.slug.org.au/archives/slug-chat/2001/July/msg00054.html
+
+> Warning: explicit language.
+
+### LICENSE
+
+>Copyright (C) 2001 Conrad Parker <conrad@vergenet.net>
+
+>Permission to use, copy, modify, distribute, and sell this software and its
+documentation for any purpose is hereby granted without fee, provided that
+the above copyright notice appear in all copies and that both that copyright
+notice and this permission notice appear in supporting documentation. No
+representations are made about the suitability of this software for any
+purpose. It is provided "as is" without express or implied warranty.
+
+### CONTACT
+
+Please direct any queries, bug reports etc. about XSel to the author,
+Conrad Parker conrad@vergenet.net .
