Home My Page Projects Code Snippets Project Openings SML/NJ
Summary Activity Forums Tracker Lists Tasks Docs Surveys News SCM Files

SCM Repository

[smlnj] Annotation of /pages/trunk/DEV/sf-howto.html
ViewVC logotype

Annotation of /pages/trunk/DEV/sf-howto.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 966 - (view) (download) (as text)

1 : macqueen 962 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
2 :     <html>
3 :     <head>
4 :     <title>SML/NJ Project Howto</title>
5 :     </head>
6 :    
7 :     <body BGCOLOR="ffffff">
8 :     <h1>SML/NJ Project Howto</h1>
9 :    
10 :     This is a collection of hints and pointers to help new users of
11 :     SourceForge and CVS to use the facilities of the SML/NJ project.
12 :     For general information on using SourceForge, see the
13 :     <a href="http://sourceforge.net/docman/?group_id=1">
14 :     SourceForge Documentation Manager</a> and the
15 :     "Getting Started with SourcForge" link on that page under the
16 :     heading "General Documentation".
17 :     <p>
18 :     Note: <em>loginname</em> stands for the SourceForge user login name.
19 :     <p>
20 :     <h3> Project directory </h3>
21 :     The SML/NJ project directory path is:
22 :     <pre>
23 :     /home/groups/s/sm/smlnj/
24 :     </pre>
25 :     This directory contains subdirectories <code>htdocs</code> and <code>cgi-bin</code>.
26 :     <p>
27 :    
28 : macqueen 966 <h3>Logging in to your sourceforge user account</h3>
29 : macqueen 962 <pre>
30 : macqueen 966 ssh -l loginname shell.sourceforge.net
31 : macqueen 962 </pre>
32 :     Your home directory will look something like: <code>/home/users/m/ma/macqueen</code>.
33 : macqueen 966 <p>
34 :     You can abbreviate the command to (e.g.)
35 :     <pre>
36 :     ssh sf-shell
37 :     </pre>
38 :     by defining sf-shell as a host alias in your .ssh/config file:
39 :     <pre>
40 :     Host = sf-shell
41 :     HostName = shell.sourceforge.net
42 :     User = loginname
43 :     </pre>
44 :     <p>
45 :     <h3>Moving files to sourceforge</h3>
46 :     You can copy an individual html source file (localfile) to your
47 :     sourceforge home directory by executing a command like:
48 :     <pre>
49 :     scp localfile macqueen@smlnj.sourceforge.net:/home/users/m/ma/macqueen
50 :     </pre>
51 :     I have not been able to use ftp (from SF) to transfer files into SF.
52 : macqueen 962
53 :     <h3>Setting up CVS access</h3>
54 :     <ol>
55 :     <li> In your user Account Maintenance page, go to "Shell Account Information"
56 :     and click [Edit Keys] next to "CVS/SSH Shared Keys". Insert contents
57 :     of ~/.ssh/identity.pub file on your local machine into the text box.
58 :     Make sure that when you cut and paste your key that it remains a single
59 :     line of text! Sometimes spurious line breaks are added when your
60 :     key is printed, and these will prevent CVS from working. You can verify
61 :     that it worked by checking the contents of the .ssh/authorized_keys
62 :     file in your SourceForge home directory.
63 :     <p>
64 :     <li> Set CVS_RSH:
65 :     <pre>
66 :     export CVS_RSH=ssh
67 :     </pre>
68 : macqueen 966 <p>
69 : macqueen 962 <li> Run ssh-agent and ssh-add for convenience, to avoid having to repeatedly
70 :     type in your ssh passphrase or SourceForge password:
71 :     <pre>
72 :     eval `ssh-agent`
73 :     ssh-add -p &lt;&lt;EOF
74 :     your pass phrase
75 :     EOF
76 :     </pre>
77 :     These last three commands can be, and probably should be, added to your
78 :     .profile or .login file. "your pass phrase" refers to the pass phrase
79 :     that you gave when you created your ssh identity files with ssh-keygen.
80 :     Note that some versions of ssh do not support the -p flag, in which case
81 :     you will have to run ssh-add interactively and type in your pass phrase.
82 :     Unfortunately, the version of ssh available on the SourceForge shell servers
83 : macqueen 966 is one of these, so ssh-add has to be run manually after login.
84 :     <p>
85 :     <li> Create a host entry for cvs.sourceforge.net in your ssh config file (.ssh/config)
86 :     like the following (replacing loginname with your SF user name, as usual):
87 :     <pre>
88 :     Host = sf-smlnj
89 :     HostName = cvs.smlnj.sourceforge.net
90 :     User = loginname
91 :     </pre>
92 :     This defines a standard alias for the cvs host that agrees with that used
93 :     the CVS/Root files (in htdocs, for instance).
94 :     <p>
95 : macqueen 962 <li> Set CVSROOT:
96 :     <pre>
97 : macqueen 966 export CVSROOT=sf-smlnj:/cvsroot/smlnj
98 : macqueen 962 </pre>
99 : macqueen 966 Note the use of the alias "sf-smlnj" defined in the config file from the
100 :     previous item.
101 :     <p>
102 :     <li> Now you can execute cvs commands without needing -d arguments, passwords,
103 :     or pass phrases, e.g.:
104 : macqueen 962 <pre>
105 :     cvs update bugs
106 :     </pre>
107 :     </ol>
108 : macqueen 966 In order to execute cvs commands on the SourceForge shell server, you
109 :     should run ssh-keygen from your SF account to generate a new ssh key, and
110 :     then add that key to the end of your .ssh/authorized_keys file. You can
111 :     also define CVS_RSH and run ssh-agent in your .profile at
112 :     SourceForge to make things simpler.
113 : macqueen 962
114 :     <h3> Updating web pages </h3>
115 : macqueen 966 The htdocs directory in the smlnj project home directory (/home/groups/s/sm/smlnj)
116 :     contains the web pages for the project. These web pages can be accessed using
117 :     either of the following URLs:
118 :     <blockquote>
119 :     <a href="http://www.smlnj.org">http://www.smlnj.org</a><br>
120 :     <a href="http://smlnj.sourceforge.net">http://smlnj.sourceforge.net/index.html</a>
121 :     </blockquote>
122 :     The htdocs directory is a CVS working directory created by checking out
123 :     the htdocs module from the project CVS repository. The Bell Labs copy
124 :     (in /home/sml/Doc/WWW/smlnj) is also checked-out from the repository ("htdocs"
125 :     and "smlnj" are both aliases of the pages module in the repository). If you
126 :     have extensive edits to perform on the web pages, we recommend that you check
127 :     out your own private working copy, make the edits, test them, and commit the changes.
128 :     After the changes are commited, "cvs update" must be performed in
129 :     the two directories
130 :     <blockquote>
131 :     /home/groups/s/sm/smlnj/htdocs (at SF)<br>
132 :     alice:/cm/cs/what/smlnj (at Bell Labs)
133 :     </blockquote>
134 :     to synchronize them with the changed repository. You can do the
135 :     update on the htdocs directory yourself as described in the next
136 :     paragraph, but you may need to send mail to Bell Labs to have the
137 :     update done on that copy until we set up automatic email notifications
138 :     of commits to the web pages repository.
139 : macqueen 962 <p>
140 : macqueen 966 To actually update the pages at SF, you login to your SF account
141 :     and do (e.g.)
142 : macqueen 962 <pre>
143 :     cd /home/groups/s/sm/smlnj/htdocs
144 :     ... set up cvs ...
145 : macqueen 966 export CVSROOT=sf-smlnj:/cvsroot/smlnj
146 :     cvs update htdocs
147 : macqueen 962 </pre>
148 :     <p>
149 :     <hr>
150 :     <address><a href="mailto:macqueen@users.sourceforge.net">Dave MacQueen</a></address>
151 :     <!-- Created: Fri Feb 16 12:36:42 EST 2001 -->
152 :     <!-- hhmts start -->
153 :     Last modified: Wed Feb 21 14:10:48 EST 2001
154 :     <!-- hhmts end -->
155 :     </body>
156 :     </html>

root@smlnj-gforge.cs.uchicago.edu
ViewVC Help
Powered by ViewVC 1.0.0