source: ietf.README @ 33

Revision 11, 4.0 KB checked in by, 7 years ago (diff)

Minor tweaks

2General Instructions
4The "ietf" program lets you access IETF-related files from the command line.
5It creates a local copy of these files on your computer using rsync, and gives
6a friendly way to access them. You can give commands from your normal shell,
7or you can run an interactive shell that is part of the program.
9These instructions assume that you are using a Unix-based system (including
10MacOS), and are already comfortable with the command-line interfaces of your
11shell. There are instructions for Windows users later in this document.
13The "ietf" program requires Python 2.6 or later; that should be available on
14almost any modern computing platform.
16The program consists of two files: "ietf" (the executable) and "ietf.config"
17(mandatory configuration settings). The latter file must be either in one of
18the following directories: ~/bin/, /usr/local/bin/, or ~/.ietf/. The
19executable can be anywhere, but is probably best kept with the configuration
22Make the "ietf" file executable with "chmod u+x ietf".
24You can make aliases in your shell for the program if you normally run it from
25the shell command line to save keystrokes. For example, if you use the bash
26shell, you might make an alias of:
27   alias charter='ietf charter '
29Edit the ietf.config with an editor. There is a description of the values at
30the top of that file.  It is likely you will want to change the value of
31DisplayTextCommand to be your favorite text editor and the value of the
32DisplayWebCommand to be the executable for your favorite web browser.
35Running the Program
37There are two ways to run the "ietf" program: in its own command line
38processor, or from your normal shell. For the former, just give the command
39"ietf", and you will see the "ietf: " prompt. For the latter, give all the
40arugments necessary after the "ietf" command itself. For example, to see the
41charter of the TLS Working Group:
43- In the command line processor, give the command "charter tls" at the
44"ietf:" prompt
46- From your shell, give the command "ietf charter tls"
48There are many commands available; see the help text for a complete list and
51The first run of the program, you need to fill the local mirror with the
52"mirror" command in the command line processor or "ietf mirror" from your
53shell. This takes about 40 minutes on a low-end broadband connection.
56Instructions for Windows Users
58These instructions assume that you are already comfortable with command-line
59interfaces, both Windows-style and Unix-style.
61Do a standard base install of Cygwin; instructions are on the site.
63Start the Cygwin installer again, and install "python" from the Python
64section, "rsync" from the Net section,  and an editor from the Editors section
65("nano" is a very easy one to learn if you aren't comfortable with vi or
68Open a Windows "command" window (not the Cygwin shell). Give the command
69"\cygwin\bin\ash". "ash" prints a "$" prompt; give the command
70"/bin/rebaseall". Give the "exit" command to leave the "ash" program and close
71the Windows "command" window. (This step is a bit of magic to fix a bug
72involving python in Cygwin.)
74Start the Cygwin shell program. Create a "bin" directory in your home
75directory, and put the two files ("ietf" and "ietf.config") there.
77When editing ietf.config file, it is likely you will want to change the
78DisplayTextCommand and DisplayWebCommand values. For example, if you installed
79"nano" under Cygwin and have installed Firefox under Windows, you might use:
80   DisplayTextCommand = "nano "
81   DisplayWebCommand = "C:'\Program Files\Mozilla Firefox'\firefox "
82Or, if you want to use the Windows Notepad program for viewing text files:
83   DisplayTextCommand = "/cygdrive/c/Windows/System32/notepad.exe "
85You can now follow the directions above for running the "ietf" command.
Note: See TracBrowser for help on using the repository browser.