doc update: reorganize chapters/files
diff --git a/documentation/examples.rst b/documentation/examples.rst
index 5c51ef6..1114a18 100644
--- a/documentation/examples.rst
+++ b/documentation/examples.rst
@@ -4,107 +4,11 @@
Examples
==========
-.. _miniterm:
Miniterm
========
-This is a console application that provides a small terminal application.
-Miniterm itself does not implement any terminal features such as VT102
-compatibility. However it may inherit these features from the terminal it is run.
-For example on GNU/Linux running from an xterm it will support the escape
-sequences of the xterm. On Windows the typical console window is dumb and does
-not support any escapes. When ANSI.sys is loaded it supports some escapes.
-
-Miniterm::
-
- --- Miniterm on /dev/ttyS0: 9600,8,N,1 ---
- --- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
-
-Command line options can be given so that binary data including escapes for
-terminals are escaped or output as hex.
-
-Miniterm supports :rfc:`2217` remote serial ports and raw sockets using :ref:`URLs`
-such as ``rfc2217:://<host>:<port>`` respectively ``socket://<host>:<port>`` as
-*port* argument when invoking.
-
-Command line options ``python -m serial.tools.miniterm -h``::
-
- usage: miniterm.py [-h] [--parity {N,E,O,S,M}] [--rtscts] [--xonxoff]
- [--rts RTS] [--dtr DTR] [-e] [--encoding CODEC] [-f NAME]
- [--eol {CR,LF,CRLF}] [--raw] [--exit-char NUM]
- [--menu-char NUM] [-q] [--develop]
- [port] [baudrate]
-
- Miniterm - A simple terminal program for the serial port.
-
- positional arguments:
- port serial port name
- baudrate set baud rate, default: 9600
-
- optional arguments:
- -h, --help show this help message and exit
-
- port settings:
- --parity {N,E,O,S,M} set parity, one of {N E O S M}, default: N
- --rtscts enable RTS/CTS flow control (default off)
- --xonxoff enable software flow control (default off)
- --rts RTS set initial RTS line state (possible values: 0, 1)
- --dtr DTR set initial DTR line state (possible values: 0, 1)
-
- data handling:
- -e, --echo enable local echo (default off)
- --encoding CODEC set the encoding for the serial port (e.g. hexlify,
- Latin1, UTF-8), default: UTF-8
- -f NAME, --filter NAME
- add text transformation
- --eol {CR,LF,CRLF} end of line mode
- --raw Do no apply any encodings/transformations
-
- hotkeys:
- --exit-char NUM Unicode of special character that is used to exit the
- application, default: 29
- --menu-char NUM Unicode code of special character that is used to
- control miniterm (menu), default: 20
-
- diagnostics:
- -q, --quiet suppress non-error messages
- --develop show Python traceback on error
-
-
-Miniterm supports some control functions. Typing :kbd:`Ctrl+T Ctrl+H` when it is
-running shows the help text::
-
- --- pySerial (3.0a) - miniterm - help
- ---
- --- Ctrl+] Exit program
- --- Ctrl+T Menu escape key, followed by:
- --- Menu keys:
- --- Ctrl+T Send the menu character itself to remote
- --- Ctrl+] Send the exit character itself to remote
- --- Ctrl+I Show info
- --- Ctrl+U Upload file (prompt will be shown)
- --- Ctrl+A encoding
- --- Ctrl+F edit filters
- --- Toggles:
- --- Ctrl+R RTS Ctrl+D DTR Ctrl+B BREAK
- --- Ctrl+E echo Ctrl+L EOL
- ---
- --- Port settings (Ctrl+T followed by the following):
- --- p change port
- --- 7 8 set data bits
- --- N E O S M change parity (None, Even, Odd, Space, Mark)
- --- 1 2 3 set stop bits (1, 2, 1.5)
- --- b change baud rate
- --- x X disable/enable software flow control
- --- r R disable/enable hardware flow control
-
-.. versionchanged:: 2.5
- Added :kbd:`Ctrl+T` menu and added support for opening URLs.
-.. versionchanged:: 2.6
- File moved from the examples to :mod:`serial.tools.miniterm`.
-.. versionchanged:: 3.0
- Apply encoding on serial port, convert to Unicode for console.
- Added new filters, default to stripping terminal control sequences.
+Miniterm is now available as module instead of example.
+see :ref:`miniterm` for details.
miniterm.py_
The miniterm program.