Apache OpenOffice (AOO) Bugzilla – Issue 3977
Use of a unix shell wrapper for setup
Last modified: 2003-09-08 16:53:51 UTC
Hi, For OOo 1.0 linux/unix users need a setup_wrapper.sh that makes the current install much more unix-like for the following reasons: 1. OOo users generate too many bug reports about -net under unix so for 1.0 so we have to do something about this. That and no one reads the docs on how to install under unix. 2. In addition, setup does not follow the standard unix command line options for displaying syntax, help etc. This confuses many people. 3. Linux/unix distributors of Staroffice and OpenOffice are already packaging up a wrapper script for setup that handles many of these issues along with using autoresponse files (see for example the Mandrake packaging for OOo) 4. If each distribution has its own wrapper script providing support under linux/unix for installation, the sheer number of differnt scripts and names becomes a support nightmare. 5. A real solution is on the drawing board for post 1.0 but won't be out in time for 1.0 (see http://installation.openoffice.org) So based on that we have the following proposition for OOo 1.0 (no changes to Star!) 1. rename setup to setup.bin 2. create a new script called setup which is a simple shell script that does the following: a) handles all of the standard unix command line switches -?, --prefix=/opt, etc b) defaults to -net install unless a --single-user switch is added, or use a netsetup script) c) uses autoresponse files to allow for automated install by default (handle an --interactive switch for those who want) d) automatically install extra user items like dictionaries and other things like that e) install symlinks to soffice, sweb, swriter, etc in prefix/bin This should shield us from a large number of bug reports, while actually not changing much of anything (handle most of this in a simple wrapper script). To demonstrate the possibilities, I have attached a working setup_wrapper.sh script that actually works under linux. Also we need to add: setup2/mow/source/loader/loader.c rev 1.25 to OOO_STABLE_1 to prevent the small unpack bar from being used during installs with autoresponse files. I have already added that to my OOO_STABLE_1 tree and rebuilt and it works. With these changes in place plus some additional changes to the setup script installed into program, we should be able to make the installation process seem much more unix like and avoid many of the bug reports I am sure are coming. Hope this helps, Kevin
Created attachment 1361 [details] example setup shell wrapper file
Hi, Adding ooo1.0 as the keyword in hopeful anticipation of acceptance. I will remove this if people object. I have my fingers crossed ;-) Kevin
I agree in general with the approach and would like to see it similar in ooo1.0. What we have to have in mind is, that there is quite some documentation about the installation process. http://whiteboard.openoffice.org/source/browse/whiteboard/doc/SETUP_GUIDE/ Wouldn't it be a more smoothful change if we provide provide an ADDITIONAL script (like "install"?) with the described functionality? Stefan
Hi Stefan, Renaming the setup_wrapper.sh to "install" would be fine. We could keep the original setup binary (not rename it setup.bin) and that means we don't have to change the installation directions very much, just add (for unix systems) that "install" is there. That would work for me! Thanks, Kevin
So, go ahead! Thanks. - is "install" or "install.sh" more appropriate? - we have to remember to include "install.sh" in installation set tarballs. I don't know whether creation is automated (make target) or done by hand. Seems a question for dev@tools. - will you notify doc@whiteboard with the appropriate info and have a look whether somebody picks it up for the setup guide?
Created attachment 1368 [details] changes to scp project for setup_wrapper idea
Hi, Okay here is one idea for how to integrate this into the build: 1. Create setup2/wrapper/install.sh Create setup2/wrapper/makefile.mk All tha makefile.mk does is copy the install.sh file to the out tree bin directory 2. modify setup2/prj/build.lst to build in setup2/wrapper but only for unix 3. modify setup2/d.lst to deliver install.sh to the solver bin/directory Then in scp we would have to make the right changes to handle the script 1. in scp/source/office/config.scp create an SCP_ACTION to copy install.sh to EXENAME(install) right after the loader is copied and renamed to setup (but only for UNX) That I think should do the trick and an "excutable script" called "install" should then appear in the insetoo module when it builds. I have just made these changes (very minor) to the setup2/ and scp/ modules and rebuilt instsetoo and it all seems to work like a charm. If you want I can commit them to the OOO_STABLE_1 tree but I would like to hear back from the owners of scp/ and setup2/ to make sure they like the idea and it all looks good first. Then all that leaves is adding some changes to the INSTALL docs and I will find out who is handling that and work with them. I will wait to hear back from scp and setup2 module owners about the integration idea. I have attached 3 patches for them to look at: scp_setup_wrapper.patch (changes needed for scp) setup2_setup_wrapper.patch (changes in build.lst and d.lst) setup2_extra_pieces.patch (actual new directory for setup2) Thanks, Kevin
Created attachment 1369 [details] changes to scp to support install.sh wrapper
Created attachment 1370 [details] changes to setup2 build.lst and d.lst
Created attachment 1371 [details] contents of setup2/wrapper/ - install.sh and makefile.mk
Hi Kevin, This is Frank Peters (fpe@sun.com) which is handling the install guide. Regards - Sophie
Hi, Who or how do I go about getting my changes to setup2 and scp reviewed for inclusion into the tree? Should I send them directly to specific people? Thanks, Kevin
About the first comment by Kevin: "1. OOo users generate too many bug reports about -net under unix so for 1.0 so we have to do something about this. That and no one reads the docs on how to install under unix." There are no docs on how to install under UNIX. At least none that are clearly visible on the website. So the best solution may be just to make the user manual more visible. I think the best way to deal with the -net option is to just make it an option within the graphical setup.
Hi, There will be an install guide in pdf form that comes with OOo 1.0 which should document all of this. I have used a OpenOffice_README_ppclinux.txt with every ppc release I have made that explains hot to do a -net install and I still gets lots and lots of bug reports. So even with a nice installation guide we will get people ignore the option and then complain and say why is this a single user setup? Unix admins and users just expect net installs to be the default. As for your idea of a button in the graphical install, that would be nice for Window's users and others but won't be in OOo 1.0. So the closest thing we can do easily is use the "install" wrapper script and default to a -net install unless overridden with -single (the user can also choose interactive (graphical) versus command line options as well. This won't help Windows 2000 users but hopefully they will be more inclined to actually read the installation documentation! Kevin
the wrapper dir and d.lst and build.lst looks ok for me, Oliver or Ingo to review the scp changes.
Oliver (obo) told me that he give approval for this, but he is not able to add comments to this issue. please Kevin, go ahead !
Hi Martin, Okay, I have added the pieces to both scp and setup2 OOO_STABLE_1 so we should be good to go here. Thanks! Kevin p.s. I will not close this issue. Thanks for everyone's help.
Hi, Whoops I should have written I will NOW close this issue. I have to learn to type better! Kevin