finalized package

1 files changed, 85 insertions, 0 deletions

diff --git a/ietf.README b/ietf.README
new file mode 100644
index 000000000000..f15f084bf9df
--- /dev/null
+++ b/ietf.README
@@ -0,0 +1,85 @@
+=========================================================

+General Instructions

+

+The "ietf" program lets you access IETF-related files from the command line.

+It creates a local copy of these files on your computer using rsync, and gives

+a friendly way to access them. You can give commands from your normal shell,

+or you can run an interactive shell that is part of the program.

+

+These instructions assume that you are using a Unix-based system (including

+MacOS), and are already comfortable with the command-line interfaces of your

+shell. There are instructions for Windows users later in this document.

+

+The "ietf" program requires Python 2.6 or later; that should be available on

+almost any modern computing platform.

+

+The program consists of two files: "ietf" (the executable) and "ietf.config"

+(mandatory configuration settings). The latter file must be either in one of

+the following directories: ~/bin/, /usr/local/bin/, or ~/.ietf/. The

+executable can be anywhere, but is probably best kept with the configuration

+file.

+

+Make the "ietf" file executable with "chmod u+x ietf".

+

+You can make aliases in your shell for the program if you normally run it from

+the shell command line to save keystrokes. For example, if you use the bash

+shell, you might make an alias of:

+   alias charter='ietf charter '

+

+Edit the ietf.config with an editor. There is a description of the values at

+the top of that file.  It is likely you will want to change the value of

+DisplayTextCommand to be your favorite text editor and the value of the

+DisplayWebCommand to be the executable for your favorite web browser.

+

+=========================================================

+Running the Program

+

+There are two ways to run the "ietf" program: in its own command line

+processor, or from your normal shell. For the former, just give the command

+"ietf", and you will see the "ietf: " prompt. For the latter, give all the

+arugments necessary after the "ietf" command itself. For example, to see the

+charter of the TLS Working Group:

+

+- In the command line processor, give the command "charter tls" at the

+"ietf:" prompt

+

+- From your shell, give the command "ietf charter tls"

+

+There are many commands available; see the help text for a complete list and

+description.

+

+The first run of the program, you need to fill the local mirror with the

+"mirror" command in the command line processor or "ietf mirror" from your

+shell. This takes about 40 minutes on a low-end broadband connection.

+

+=========================================================

+Instructions for Windows Users

+

+These instructions assume that you are already comfortable with command-line

+interfaces, both Windows-style and Unix-style.

+

+Do a standard base install of Cygwin; instructions are on the cygwin.com site.

+

+Start the Cygwin installer again, and install "python" from the Python

+section, "rsync" from the Net section,  and an editor from the Editors section

+("nano" is a very easy one to learn if you aren't comfortable with vi or

+emacs).

+

+Open a Windows "command" window (not the Cygwin shell). Give the command

+"\cygwin\bin\ash". "ash" prints a "$" prompt; give the command

+"/bin/rebaseall". Give the "exit" command to leave the "ash" program and close

+the Windows "command" window. (This step is a bit of magic to fix a bug

+involving python in Cygwin.)

+

+Start the Cygwin shell program. Create a "bin" directory in your home

+directory, and put the two files ("ietf" and "ietf.config") there.

+

+When editing ietf.config file, it is likely you will want to change the

+DisplayTextCommand and DisplayWebCommand values. For example, if you installed

+"nano" under Cygwin and have installed Firefox under Windows, you might use:

+   DisplayTextCommand = "nano "

+   DisplayWebCommand = "C:'\Program Files\Mozilla Firefox'\firefox "

+Or, if you want to use the Windows Notepad program for viewing text files:

+   DisplayTextCommand = "/cygdrive/c/Windows/System32/notepad.exe "

+

+You can now follow the directions above for running the "ietf" command.