From 37333bf25ad9a4c538250f5af2f9f1d666362883 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdeadmin@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- doc/Makefile.am | 5 + doc/kcron/Makefile.am | 2 + doc/kcron/index.docbook | 900 +++++++++++++++++++++++++++++ doc/kcron/kcron.png | Bin 0 -> 12848 bytes doc/kcron/kcronstart.png | Bin 0 -> 11164 bytes doc/kcron/newtask.png | Bin 0 -> 27943 bytes doc/kcron/newvariable.png | Bin 0 -> 8271 bytes doc/kcron/print.png | Bin 0 -> 19911 bytes doc/kdat/Makefile.am | 4 + doc/kdat/index.docbook | 833 +++++++++++++++++++++++++++ doc/knetworkconf/01.png | Bin 0 -> 19174 bytes doc/knetworkconf/02.png | Bin 0 -> 11535 bytes doc/knetworkconf/03.png | Bin 0 -> 34941 bytes doc/knetworkconf/04.png | Bin 0 -> 17281 bytes doc/knetworkconf/05.png | Bin 0 -> 23226 bytes doc/knetworkconf/06.png | Bin 0 -> 20572 bytes doc/knetworkconf/07.png | Bin 0 -> 38636 bytes doc/knetworkconf/08.png | Bin 0 -> 38582 bytes doc/knetworkconf/09.png | Bin 0 -> 14696 bytes doc/knetworkconf/11.png | Bin 0 -> 88408 bytes doc/knetworkconf/Makefile.am | 4 + doc/knetworkconf/about1.png | Bin 0 -> 25159 bytes doc/knetworkconf/index.docbook | 1117 ++++++++++++++++++++++++++++++++++++ doc/kpackage/Makefile.am | 4 + doc/kpackage/bsdloc.png | Bin 0 -> 13152 bytes doc/kpackage/debaptloc.png | Bin 0 -> 20365 bytes doc/kpackage/debloc.png | Bin 0 -> 28484 bytes doc/kpackage/handle.png | Bin 0 -> 25717 bytes doc/kpackage/index.docbook | 1229 ++++++++++++++++++++++++++++++++++++++++ doc/kpackage/install.png | Bin 0 -> 57287 bytes doc/kpackage/left.png | Bin 0 -> 87127 bytes doc/kpackage/right-change.png | Bin 0 -> 37157 bytes doc/kpackage/right-files.png | Bin 0 -> 25459 bytes doc/kpackage/right-prop.png | Bin 0 -> 31602 bytes doc/kpackage/root-prompt.png | Bin 0 -> 13526 bytes doc/kpackage/rpmloc.png | Bin 0 -> 26686 bytes doc/kpackage/search.png | Bin 0 -> 12484 bytes doc/kpackage/searchf.png | Bin 0 -> 45882 bytes doc/kpackage/searchl.png | Bin 0 -> 5851 bytes doc/kpackage/slackloc.png | Bin 0 -> 19097 bytes doc/kpackage/uninstall.png | Bin 0 -> 24775 bytes doc/ksysv/Makefile.am | 4 + doc/ksysv/index.docbook | 1117 ++++++++++++++++++++++++++++++++++++ doc/kuser/Makefile.am | 4 + doc/kuser/index.docbook | 273 +++++++++ doc/kuser/kuser.png | Bin 0 -> 15170 bytes doc/lilo-config/Makefile.am | 4 + doc/lilo-config/index.docbook | 177 ++++++ 48 files changed, 5677 insertions(+) create mode 100644 doc/Makefile.am create mode 100644 doc/kcron/Makefile.am create mode 100644 doc/kcron/index.docbook create mode 100644 doc/kcron/kcron.png create mode 100644 doc/kcron/kcronstart.png create mode 100644 doc/kcron/newtask.png create mode 100644 doc/kcron/newvariable.png create mode 100644 doc/kcron/print.png create mode 100644 doc/kdat/Makefile.am create mode 100644 doc/kdat/index.docbook create mode 100644 doc/knetworkconf/01.png create mode 100644 doc/knetworkconf/02.png create mode 100644 doc/knetworkconf/03.png create mode 100644 doc/knetworkconf/04.png create mode 100644 doc/knetworkconf/05.png create mode 100644 doc/knetworkconf/06.png create mode 100644 doc/knetworkconf/07.png create mode 100644 doc/knetworkconf/08.png create mode 100644 doc/knetworkconf/09.png create mode 100644 doc/knetworkconf/11.png create mode 100644 doc/knetworkconf/Makefile.am create mode 100644 doc/knetworkconf/about1.png create mode 100644 doc/knetworkconf/index.docbook create mode 100644 doc/kpackage/Makefile.am create mode 100644 doc/kpackage/bsdloc.png create mode 100644 doc/kpackage/debaptloc.png create mode 100644 doc/kpackage/debloc.png create mode 100644 doc/kpackage/handle.png create mode 100644 doc/kpackage/index.docbook create mode 100644 doc/kpackage/install.png create mode 100644 doc/kpackage/left.png create mode 100644 doc/kpackage/right-change.png create mode 100644 doc/kpackage/right-files.png create mode 100644 doc/kpackage/right-prop.png create mode 100644 doc/kpackage/root-prompt.png create mode 100644 doc/kpackage/rpmloc.png create mode 100644 doc/kpackage/search.png create mode 100644 doc/kpackage/searchf.png create mode 100644 doc/kpackage/searchl.png create mode 100644 doc/kpackage/slackloc.png create mode 100644 doc/kpackage/uninstall.png create mode 100644 doc/ksysv/Makefile.am create mode 100644 doc/ksysv/index.docbook create mode 100644 doc/kuser/Makefile.am create mode 100644 doc/kuser/index.docbook create mode 100644 doc/kuser/kuser.png create mode 100644 doc/lilo-config/Makefile.am create mode 100644 doc/lilo-config/index.docbook (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..6812bd2 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +SUBDIRS = $(AUTODIRS) + diff --git a/doc/kcron/Makefile.am b/doc/kcron/Makefile.am new file mode 100644 index 0000000..1a8064c --- /dev/null +++ b/doc/kcron/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = AUTO diff --git a/doc/kcron/index.docbook b/doc/kcron/index.docbook new file mode 100644 index 0000000..5ff2e14 --- /dev/null +++ b/doc/kcron/index.docbook @@ -0,0 +1,900 @@ + + + + + +]> + + + + + +The &kcron; Handbook + + + + +Morgan +N. +Sandquist +
morgan@pipeline.com
+ + + + +Gary +Meyer +
gary@meyer.net
+ +Developer + + + +Lauri +Watts +
lauri@kde.org
+ +Reviewer + + + + + + + +2000 +Morgan N. Sandquist + + +&FDLNotice; + +2003-09-16 +3.1.91 + +&kcron; is an application that schedules programs to be +run. + + +KDE +kdeadmin +KCron +cron +crontab +scheduler + + + + + + +Introduction + +&kcron; is an application for scheduling programs to run in the +background. It is a graphical user interface to cron, +the &UNIX; system scheduler. + + + + +Using &kcron; + +Don't forget to tell your system to start the +crond cron daemon first, or &kcron; won't +work. + + +&kcron; Start Up + +When &kcron; starts you will see a summarized view of existing +scheduled tasks and associated environment variables. If you are running +as the root user, you will see these items for all users on the computer +as well as the system scheduled tasks. Each of the folders can be +expanded and contracted. + + +&kcron; at start up. + + + +&kcron; at start up. + + + + +Scheduled Tasks + +Scheduled tasks appear under a Tasks +folder. For each scheduled task, the following are displayed: + + + + +Name +Name to identify the scheduled task. + + +Value +Program file and parameters. + + +Description +Natural language description of scheduled +task. + + + +If a task has been disabled, no program file and parameters will +appear, and the description will be disabled. + + + + +Environment Variables + +Environment variables appear under a +Variables folder. For each environment variable, +the following are displayed: + + + +Name +Variable name. + + +Value +Variable value. + + +Description +Natural language description of variable. + + + +Environment variables appearing here will override any existing +environment variable for all scheduled tasks. If an environment variable +has been disabled, no value will appear and the description will be +disabled. + + +&kcron; main window + + + +&kcron; main window + + + + + + + +Adding Scheduled Tasks + +To create a new scheduled task, first select the +Tasks folder. Then select +Edit New... +. Alternatively, you can use the +right mouse button menu and choose +New..., or simply +press CtrlN. + + +The <guilabel>Edit Task</guilabel> Dialog + + +Edit Task dialog. + + +Edit Task dialog + + + + + +Comment +Enter a description of the task to schedule. + + + +Program +Enter the name of the program. You can specify either a +relative path or absolute path. If you want to look up the program, click +Browse.... + + + +Enabled +To enable or disable the task, select or de-select +Enabled. + + + + +Silent + + +Turns off logging of the command and the output from the command. + + + + + +Months +Select the months during which the task is to be +scheduled. + + + +Days of the Month +Select the days of the month on which the task is to be +scheduled. + + + +Days of the Week +Select the days of the week on which the task is to be +scheduled. + + + +Daily +If you want to schedule the task to run daily, select +Run every day. + + + +Hours +Select the hours on which the task is to be +scheduled. + + +Minutes +Select the minute at which the task is to be scheduled. &kcron; +does not support scheduling tasks at smaller than five minute intervals. + + + +OK +Completes the creation of this task. + + + +Cancel +Cancels the creation of this task. + + + + +If you select both days of the month, and days of the week, the +task will run when either condition is met. For instance, if you select +the 1st and 15th, and select Sunday, the program will be run every 1st +and 15th of the selected months (regardless of day of week) as well as +every Sunday of the selected months (regardless of day of the +month). + +The scheduled task is not actually set up until the +crontab has been saved. + + + + + +Managing Scheduled Tasks + +As with creating new tasks, changes to tasks will not actually be +made until the crontab is saved. + + +Cutting Scheduled Tasks + +To cut a scheduled task, first select the task to be cut. Then +select Edit +Cut. Alternatively, +you can use the right mouse button menu and +choose Cut, or +simply press CtrlX. + + + + +Copying Scheduled Tasks + +To copy a scheduled task, first select the task to be copied. Then +select +EditCopy +. + +Alternatively, you can use the right mouse +button menu and choose Copy, +or simply press CtrlC. + + + + +Pasting Scheduled Tasks + +To paste a scheduled task, first a scheduled task must have +already been cut or copied to the clipboard. Once a scheduled task has +been cut or copied, paste will be enabled. Then select the +Tasks folder. Finally, select +Edit Paste +. + + Alternatively, you can use the right mouse +button menu and choose +Paste, or simply press +CtrlV. + + + + +Modifying Scheduled Tasks + +To modify a scheduled task, first select the task to be +modified. Then select + +Edit Modify... +. + +Alternatively, you can use the right +mouse button menu and choose +Modify..., or simply +press CtrlO. You +will see the Edit Task dialog, with which you would +modify the task as described above. + + + + +Deleting Scheduled Tasks + +To delete a scheduled task, first select the task to be +deleted. Then select Edit +Delete . + +Alternatively, you can use the right +mouse button menu and choose Delete. + + + + +Enabling/Disabling Scheduled Tasks + +To enable or disable a scheduled task, first select the disabled +task. Disabled tasks will have Disabled in their +descriptions. Then select Edit +Enabled . + +Alternatively, you can use the right +mouse button menu and choose +Enabled. Confirm +that the scheduled task's program name, parameters, and description are +correctly displayed. + + + + +Running Scheduled Tasks + +To run a scheduled task immediately, first select the task. Then +select Edit Run +Now . + +Alternatively, you can use the right +mouse button menu and choose Run +Now. + + + + + +Adding Environment Variables + +To create a new environment variable, first select the +Variables folder. Then select +EditNew... +. + +Alternatively, you can use the right +mouse button menu and choose +New..., or simply +press CtrlN. + + +The <guilabel>Edit Variable</guilabel> dialog + + +Edit Variable dialog. + + +Edit Variable +dialog. + + + + + +Variable +Enter the environment variable name. You can use the drop-down +list box to select from the most common environment variables used by scheduled +tasks. Those include: + + + + +HOME +To be used instead of the default user's home +folder. + + + +MAILTO +To send email output to an email address other than the user's +default email address. + + + +PATH +To be used to search folders for program +files. + + + +SHELL +To be used instead of the user's default +value. + + + + + +Value +Enter the environment variable value. + + +Comment +Enter a description for the environment variable, such as its +purpose. + + +Enabled + +To enable or disable the variable, select or de-select +Enabled. + + + +OK + +Completes the setting of this variable. + + + +Cancel + +Cancels the setting of this variable. + + + + +The environment variable is not actually set up until the +crontab has been saved. + + + + + +Managing Environment Variables + +As with creating new variables, changes to variables will +not actually be made until the crontab is +saved. + + +Cutting Environment Variables + +To cut an environment variable, first select the variable to be +cut. Then select Edit +Cut . + +Alternatively, you can use the right +mouse button menu and choose +Cut, or simply press +CtrlX. + + + + +Copying Environment Variables + +To copy an environment variable, first select the variable to be +copied. Then select Edit +Copy . + +Alternatively, you can use the right +mouse button menu and choose Copy, or simply +press CtrlC. + + + + +Pasting Environment Variables + +To paste an environment variable, first an environment variable +must have already been cut or copied to the clipboard. Once an +environment variable has been cut or copied, paste will be enabled. Then +select the Variables folder. Finally, select +Edit Paste +. + +Alternatively, you can use the right +mouse button menu and choose +Paste, or simply +press CtrlV. + + + +Modifying Environment Variables + +To modify an environment variable, first select the variable to be +modified. Then select Edit +Modify... . Alternatively, you +can use the right mouse button menu and +choose Modify..., or simply press CtrlO. You +will see the Edit Variable dialog, in which you would +modify the variable as described above. + + + + +Deleting Environment Variables + +To delete an environment variable, first select the variable to be +deleted. Then select +EditDelete + + +Alternatively, you can use the right mouse +button menu and choose Delete. + + + + +Enabling/Disabling Environment Variables + +To enable or disabled an environment variable, first select the +disabled variable. Disabled variables will have +Disabled in their descriptions. Then select + +Edit Enabled . + +Alternatively, you can use the right +mouse button menu and choose +Enabled. Confirm +that the environment variable's name and value are correctly +displayed. + + + + + +Saving the <filename>crontab</filename> + +Once all scheduled tasks and environment variables have been +created and/or properly modified, save the crontab +by selecting + +File Save . + +Alternatively, you can simply press &Ctrl;S. Additions or changes +will not actually be made until this is done. + + + + +Printing the <filename>crontab</filename> + +To print the crontab as it has been saved, +select File +Print . + + + + + +Printing the crontab. + + +Printing the +crontab. + + + +The standard &kde; printer dialog will display. If you select +Expand you will see that there are two extra +&kcron; specific options in the Print Dialog box. + + + +Print Crontab + +Prints the crontab for the current user. + + + + +Print All Users + +Prints the crontabs for all users. This option is +enabled only for users with super-user privileges. + + + + + + + + + +Command Reference + + +The main &kcron; window + + +The <guimenu>File</guimenu> Menu + + + + + +&Ctrl;S + +File +Save + + +Saves changes to the crontab. + + + + + +&Ctrl;P +File Print... + + +Prints the crontab. + + + + + + +&Ctrl;Q + +File +Quit + + +Quits &kcron;. + + + + + + +The <guimenu>Edit</guimenu> Menu + + + + + +&Ctrl;X + +Edit +Cut +Cut the selected task or +variable. + + + + +&Ctrl;C + +Edit +Copy + +Copy the selected task or +variable. + + + + +&Ctrl;V + +Edit +Paste + +Paste a task or variable that has been cut or +copied. + + + + +&Ctrl;N + +Edit +New... + +Create a new task or +variable. + + + + +&Ctrl;O + +Edit +Modify... + +Modify the selected task or +variable. + + + +Edit +Delete + +Delete the selected task or +variable. + + + +Edit +Enabled + + +Enable/disable the selected task or variable. + + + + +Edit +Run Now + +Run the selected task now. + + + + + + +The <guimenu>Settings</guimenu> Menu + + + + +Settings +Show Toolbar + +Displays toolbar. + + + +Settings +Show Statusbar + +Displays statusbar. + + + + + + +The <guimenu>Help</guimenu> Menu + +&help.menu.documentation; + + + + + + +Questions and Answers + + + + +Why aren't the changes I'm making to scheduled tasks and/or environment +variables taking effect? + +Additions or changes to scheduled tasks do not actually happen until the +crontab has been saved. + + + + + + + +Credits and License + +&kcron; + +Program copyright 2000 Gary Meyer gary@meyer.net + +Documentation copyright 2000 Morgan N. Sandquist +morgan@pipeline.com + + +&underFDL; + +&underGPL; + + + + +Installation + + +How to obtain &kcron; + +&install.intro.documentation; + + + + +Requirements + +In order to successfully compile &kcron;, you need the following +libraries: + + +cron, such as +vixie-cron. &kcron; uses the +crontab command to modify user's scheduled +tasks. +POSIX-compliant &UNIX;, such as provided by +glibc. &kcron; uses some standard &UNIX; system calls for localization of +dates and times + + + + + +Compilation and Installation + +&install.compile.documentation; + + + + + +&documentation.index; + + + diff --git a/doc/kcron/kcron.png b/doc/kcron/kcron.png new file mode 100644 index 0000000..b800ebf Binary files /dev/null and b/doc/kcron/kcron.png differ diff --git a/doc/kcron/kcronstart.png b/doc/kcron/kcronstart.png new file mode 100644 index 0000000..fd4c21b Binary files /dev/null and b/doc/kcron/kcronstart.png differ diff --git a/doc/kcron/newtask.png b/doc/kcron/newtask.png new file mode 100644 index 0000000..86da56c Binary files /dev/null and b/doc/kcron/newtask.png differ diff --git a/doc/kcron/newvariable.png b/doc/kcron/newvariable.png new file mode 100644 index 0000000..2334952 Binary files /dev/null and b/doc/kcron/newvariable.png differ diff --git a/doc/kcron/print.png b/doc/kcron/print.png new file mode 100644 index 0000000..c622f26 Binary files /dev/null and b/doc/kcron/print.png differ diff --git a/doc/kdat/Makefile.am b/doc/kdat/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kdat/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kdat/index.docbook b/doc/kdat/index.docbook new file mode 100644 index 0000000..b5fb94e --- /dev/null +++ b/doc/kdat/index.docbook @@ -0,0 +1,833 @@ + + + + + +]> + + + +&kdat; Documentation + + + + +Sean +Vyain +
svyain@mail.tds.net
 + + + + + + + +2000 +Sean Vyain + + +2000-10-03 +2.00.00 + +This documentation describes &kdat; +2.0 + + +KDE +KDat +tape +tape management + + + + + +Introduction + +&kdat; is a tar-based tape archiver. It is designed to work with +multiple archives on a single tape. &kdat; was inspired by two separate +goals. +The first, was to provide a nice, GUI front-end to tar +that +supported the fast selective extraction features of the +dds2tar program. The second goal was to +answer my wife's +question, How much longer is it going to be backing +up?!? + + + +Features + + +Simple graphical interface to local filesystem and tape +contents. + +Multiple archives on the same physical tape. + +Complete index of archives and files is stored on local +hard +disk. + +Selective restore of files from an archive. + +Backup profiles for frequently used backups. + + + + + + + +Using &kdat; + + +Mounting/unmounting a tape + +Before a tape can be used, it must be mounted by &kdat;. There are + + + + +three +ways to mount a tape: + + +Select Mount Tape from the +File menu. + +Click on the tape drive icon on the +toolbar. + +&RMB; click on the tape drive tree node, and select +Mount Tape. + + + +&kdat; will rewind the tape, and read the header information from +the tape. If &kdat; does not recognize the header on the tape, you will +be prompted to format the tape. + +If &kdat; recognizes the header it will look for the corresponding +tape index on your local disk. If the tape index cannot be found you +will be prompted to recreate the index from +tape. + +If all goes well, the tape drive icon will change to indicate that +the tape has been mounted, and a message will appear in the status bar. +The contents of the tape can be explored under the tape drive tree +node. + +Before ejecting a tape, you must unmount the tape. There are three +ways to unmount the tape: + + +Select Unmount Tape from the +File menu. + +Click on the tape drive icon on the +toolbar. + +&RMB; click on the tape drive tree node, and select +Unmount Tape. + + + +&kdat; will acknowledge that the tape has been unmounted by +changing the +tape drive icon, and displaying a message in the status bar. The tape +may now +be safely ejected. + + + + + +Formatting a tape + +Before a tape can be used by &kdat;, it must be formatted by +&kdat;. + +Some types of tapes must be formatted before they can be used to +store data. This is not what &kdat; does when formatting a +tape. If your tape drive requires that the tapes be formatted + + + + +before +using them, then they must be formatted before they can be +formatted +by &kdat;. Typically floppy tape drives require that their media be +formatted, but +DAT drives do not. + +There are two ways to format a tape: + + +Select Format Tape... from +the +File menu. + +&RMB; click on the tape drive tree node, and select +Format Tape.... + + + +You will be prompted for a name for the tape, and the stated +capacity of the tape. Both of these parameters can be changed +after the tape has been formatted. The tape name is only used +to identify the tape to the user; it is not used to identify the +tape index associated with the tape. Instead, a unique tape +identifier is automatically generated and written to the tape. +The stated capacity of the tape is used by &kdat; to warn the user +if there will not be enough space to complete a backup. + +After entering the tape name and capacity, &kdat; will proceed to +format the tape. ALL DATA ON THE TAPE WILL BE LOST. +Once &kdat; has finished formatting the tape, the tape will be +automatically +mounted and is ready for use. + + + + + +Backing up files to tape + +Before initiating a backup, you must select some files to archive. + + + + +There +are three ways to select files for backup: + + +Highlight a file or folder in the local file tree. +Only the +selected file or subfolder will be archived. + +Highlight a backup +profile in the +tree. Only the files in the backup profile will be archived. + +Checkmark selected files in the local file tree. Only +the +checked files and/or subfolders will be archived. + + + +There are four ways to initiate a backup: + + +Select Backup... from the +File menu. + +Click on the backup icon in the +toolbar. + +&RMB; click on a file or folder in the local file +tree, and +select Backup.... + +&RMB; click on a backup +profile, +and select Backup.... + + + +Once the backup has been initiated, the Backup +Options dialog will appear. This dialog gives you a chance to +review the selected files, and change the backup options. + +After accepting the backup options, the +Backup +dialog will appear. This dialog shows the progress of the backup +including +throughput and time remaining. + + + + + +Verifying tape files against local files + +Before initiating a verify, you must select some files to +verify. + +There are two ways to select files for verification: + + +Highlight a file or folder in one of the archives +under the +tape drive tree node. Only the selected file or subfolder will be +verified. + +Checkmark selected files in one of the archives under +the tape +drive tree node. Only the checked files and/or subfolders will be +verified. + + + +There are three ways to initiate a verify: + + +Select Verify... from the +File menu. + +Click on the verify icon in the +toolbar. + +&RMB; click on a file or folder in one of the +archives, and select Verify.... + + + + +Once the verify has been initiated, the Verify +Options dialog will appear. This dialog gives you a chance to +review the selected files, and change the working folder for the +verification. + +After accepting the verify options, the +Verify +dialog will appear. This dialog shows the progress of the verification +including throughput and time remaining. + + + + + +Restoring files from tape + +Before initiating a restore, you must select some files to +restore. There are two ways to select files for restoring: + + +Highlight a file or folder in one of the archives +under the +tape drive tree node. Only the selected file or subfolder will be +restored. + +Checkmark selected files in one of the archives under +the tape +drive tree node. Only the checked files and/or subfolders will be +restored. + + + +There are three ways to initiate a restore: + + +Select Restore... from the +File menu. + +Click on the restore icon in the +toolbar. + +&RMB; click on a file or folder in one of the +archives, and select +Restore.... + + + +Once the restore has been initiated, the Restore +Options dialog will appear. This dialog gives you a chance to +review the selected files, and change the working folder for the +restore. + +After accepting the restore options, the +Restore +dialog will appear. This dialog shows the progress of the restore +including +throughput and time remaining. + + + + + +Recreating an index from tape + +Sometimes it may be necessary to recreate the tape index file from + + + + +the tape +contents. This process will overwrite any existing index +file for the tape. There are two way to recreate an index +from +tape: + + +Select Recreate Tape Index +from the +File menu. + +&RMB; click on the tape drive tree node, and select +Recreate Tape Index. + + + +The Index dialog will appear. This dialog +shows +&kdat;'s progress as it creates the index file. + + + + + +Creating a backup profile + +There are two ways to create a backup profile: + + +Select Create Backup Profile +from +the File menu. + +&RMB; click on the Backup Profiles +tree node, and select Create Backup +Profile. + + + +This should create a new backup profile using the currently +checked files +and the default backup options. The following options can be set for the + + + + +backup +profile: + + + + +Archive name +The symbolic name for the archive. It can be changed +later. + + +Working folder +The current working folder to perform the backup in. +The +list of files to backup is automatically updated to reflect the selected + + + + +working +folder. + + +Stay on one filesystem +For each folder that is listed under +Backup files, only the files under that folder +that are +on the same filesystem as the folder will be archived. Folders on + + + + +different +filesystems can be listed under Backup files, and +each will +be treated independently of the others, by tar. + + + +GNU listed incremental +Perform an incremental backup. A snapshot file is used +to +determine which files have changed since the last incremental backup. +Only the +files that have changed will be archived. + + +Snapshot file +The name of the file that is used to determine which +files have +changed since the last incremental backup. + + +Remove snapshot file before backup. +Remove the snapshot file before invoking +tar. This has the effect of backing up all of + + + + +the +files, and creating the snapshot file for use next time. + + + + + +The Files >> and +<< +Files buttons were not fully implemented at the time this +documentation was +written... + +You must press the Apply button to commit +any +changes made to the backup profile. + + + + + +Configuring user preferences + +User preferences can be configured by selecting +Preferences... from the +Edit +menu. The following preferences can be configured: + + + + +Default tape size + +This value will be used as the default tape size when +formatting +a tape. + + +Tape block size + +The hardware block size for the tape drive. For floppy +tape +drives this value should be 10240 bytes. + + +Tape device + +The full path to your tape device (usually +/dev/tape). +This path must point to the non-rewind version of +your tape device. + + + +Tar command + +The full path to the tar command on +your +system. + + +Load tape on mount + +If enabled, before trying to mount a tape &kdat; will +issue an +mt +command to the +tape drive. Some drives may require this before reading and writing the +tape. + + +Lock tape drive on mount + +If enabled, whenever a tape is mounted by &kdat;, the +tape drive +will be asked to disable the eject button. This option may not work with + + + + +all +tape drives. + + +Eject tape on unmount + +If enabled, whenever a tape is unmounted by &kdat;, the +tape +will automatically be ejected from the drive. Do not use this option +with floppy tape +drives. + + +Variable block size + +If enabled, &kdat; will attempt to change the hardware +block +size used by the tape drive. Not all drives support variable block size. +Whether this feature is enabled or not, you must tell &kdat; the block +size that +your tape drive uses (&ie; 10240 for ftape users). + + + + + + + + + +&kdat; tape format + +When &kdat; formats a tape it writes a single file at the +beginning of the +tape. This file should only occupy a single tape block. The contents of +the +file are: + + +(9 bytes) The string literal +KDatMAGIC + +(4 bytes) The file format version number (currently +1). + +(4 bytes) The length in bytes of the tape ID +string. + +(n bytes) The tape ID string. The format of this string +is +hostname:seconds, +where +hostname is the full name of the machine that + + + + +the tape was +formatted on and seconds is the number of +seconds since +the epoch when the tape was formatted. + + + +The tape ID is used to locate a file, with the same name, in the +$HOME/.kdat folder. + +Each of the remaining files on the tape are plain-old +tar archives. You should be able to +manipulate them +directly with GNU tar. +Even +non-GNU tar should work +for +non-incremental backups. + + + + + + +Menu and Toolbar Reference + + +&kdat; menus + +&kdat; has three menus: +File, +Edit, and +Help. + + + +The <guimenu>File</guimenu> Menu + + + + + +FileBackup + +Begin a backup. + + + +FileRestore + +Restore a backup from +tape. + + + +FileVerify + +Verify a backup. + + + +FileMount Tape + +Mount a tape. + + + +FileRecreate Tape Index + +Recreate an index on the currently mounted +tape. + + + +FileCreate Backup Profile + +Opens the dialog box that allows you to create a + + + + +Backup +Profile. + + + +FileDelete Archive + +Delete an archive from the +tape. + + + +FileDelete Index + +Delete the &kdat; index from a +tape. + + + +FileDelete Backup Profile + +Delete a Backup +Profile. + + + +FileFormat Tape + +Format a tape for use with +&kdat;. + + + +&Ctrl;Q +FileQuit + +Exit &kdat;. + + + + + + + + +The <guimenu>Edit</guimenu> Menu + + + + + +EditPreferences + +Opens the Preferences dialog, where +you can configure &kdat; for your needs. + + + + + + + + +The <guimenu>Help</guimenu> Menu + +&help.menu.documentation; + + + + + +The &kdat; toolbar + +The &kdat; toolbar contains 6 icons, as follows: + + + + +Mount/unmount Tape + +Mount or unmount a tape. + + +Backup + +Begin a backup. This item is unavailable unless a tape +is +mounted. + + +Restore + +Restore a backup from tape. This item is unavailable +unless a +tape is mounted. + + +Verify + +Verify the contents of a backup tape. This item is +unavailable unless +a tape is mounted. + + +Help + +Opens the &kdat; help files (this +document) + + +Quit + +Quits &kdat; + + + + + + + + + + + + +Copyright +&kdat; + +Program and Documentation copyright 1998-2000 Sean +Vyainsvyain@mail.tds.net + + + +&underFDL; +&underGPL; + + + + + diff --git a/doc/knetworkconf/01.png b/doc/knetworkconf/01.png new file mode 100644 index 0000000..0e6bd6f Binary files /dev/null and b/doc/knetworkconf/01.png differ diff --git a/doc/knetworkconf/02.png b/doc/knetworkconf/02.png new file mode 100644 index 0000000..2d41e65 Binary files /dev/null and b/doc/knetworkconf/02.png differ diff --git a/doc/knetworkconf/03.png b/doc/knetworkconf/03.png new file mode 100644 index 0000000..89dbf86 Binary files /dev/null and b/doc/knetworkconf/03.png differ diff --git a/doc/knetworkconf/04.png b/doc/knetworkconf/04.png new file mode 100644 index 0000000..9a80161 Binary files /dev/null and b/doc/knetworkconf/04.png differ diff --git a/doc/knetworkconf/05.png b/doc/knetworkconf/05.png new file mode 100644 index 0000000..c10457c Binary files /dev/null and b/doc/knetworkconf/05.png differ diff --git a/doc/knetworkconf/06.png b/doc/knetworkconf/06.png new file mode 100644 index 0000000..1dc2096 Binary files /dev/null and b/doc/knetworkconf/06.png differ diff --git a/doc/knetworkconf/07.png b/doc/knetworkconf/07.png new file mode 100644 index 0000000..fee712e Binary files /dev/null and b/doc/knetworkconf/07.png differ diff --git a/doc/knetworkconf/08.png b/doc/knetworkconf/08.png new file mode 100644 index 0000000..fc56293 Binary files /dev/null and b/doc/knetworkconf/08.png differ diff --git a/doc/knetworkconf/09.png b/doc/knetworkconf/09.png new file mode 100644 index 0000000..3c834a8 Binary files /dev/null and b/doc/knetworkconf/09.png differ diff --git a/doc/knetworkconf/11.png b/doc/knetworkconf/11.png new file mode 100644 index 0000000..3ebffaf Binary files /dev/null and b/doc/knetworkconf/11.png differ diff --git a/doc/knetworkconf/Makefile.am b/doc/knetworkconf/Makefile.am new file mode 100644 index 0000000..01c1911 --- /dev/null +++ b/doc/knetworkconf/Makefile.am @@ -0,0 +1,4 @@ +KDE_LANG = en +KDE_DOCS = knetworkconf + + diff --git a/doc/knetworkconf/about1.png b/doc/knetworkconf/about1.png new file mode 100644 index 0000000..f602d20 Binary files /dev/null and b/doc/knetworkconf/about1.png differ diff --git a/doc/knetworkconf/index.docbook b/doc/knetworkconf/index.docbook new file mode 100644 index 0000000..929e413 --- /dev/null +++ b/doc/knetworkconf/index.docbook @@ -0,0 +1,1117 @@ + +KNetworkConf"> + + + + +]> + + + +&kde; Network Configuration + + + +Sean +Wheller + +In Words Techdoc +Solutions + +
sean@inwords.co.za
+ + + +Christoph +Eckert + +
ce.at.christeck.de
+ + + + + + + +2005 + +In Words Techdoc +Solutions + +Christoph Eckert + +&FDLNotice; + + + + + +2005-03-24 +1.0 + + +This manual explains how to install and use &knetworkconf;, a module for +&kcontrolcenter; that enables management of Network Interfaces, Routing and DNS +properties. + + + +KDE +kdeadmin +network +ethernet + + + + + +Introduction +The &kcontrolcenter; provides users with a single +integrated interface from which to manage a wide variety of system and +desktop settings and preferences. &kcontrolcenter; can be started by selecting +K Menu&kcontrolcenter;. + +The &knetworkconf; package was developed to enable users to manage TCP/IP +networking settings in the same way they manage other system settings from +&kcontrolcenter;. Tasks enabled by &knetworkconf; provide users with a simple +interface from which to perform the following tasks: + + + +Apply IP addresses to interfaces + + +Apply netmasks to interfaces + + +Start and stop interface activities + + +Configure Routing + + +Configure Host- and Domain Name + + +Configure Resolving + + +Manage known hosts + + + +Once installed a new module called Network +Settings is displayed in the &kcontrolcenter;. +To start the Network Settings (&knetworkconf;) module select +&kcontrolcenter; Internet & Network +Network Settings in the &kmenu;. + + + + + + +&knetworkconf; in user mode + + + +It is important to understand that &knetworkconf; cannot install +networking hardware. As such physical devices and their drivers must be +properly installed and configured in order for &knetworkconf; to display the +device and enable management of networking properties. + +In most cases drivers for networking hardware and other devices are +installed and configured while installing &Linux;. If you add networking +hardware after installation, you will have to define the drivers to be +loaded by editing one of the following files depending on your kernel +version: + + + +&Linux; Kernel 2.4 and lower + + +/etc/modules.conf + + + + +&Linux; Kernel 2.6 and higher + + +/etc/modprobe.conf + + + + + + + +Using the Network Settings Module + +The Network Settings module is loaded when +the Network Settings option is selected in the +&kcontrolcenter; index. When started the Network +Settings module attempts to automatically detect the platform +running on the system. + + +Detecting the platform + + + + + + + +When the platform is not a recognized you will be prompted to manually +select the platform. Select a platform from the list that most closely +corresponds to your distro and its release. Check the Don't ask +again option to make this choice permanent. Next time +Network Settings is started the system will +automatically default to the selected platform option. + + + + +To manage the system network settings you must enter +administrator mode. Prior to this all options will be +grayed, meaning you can only navigate the interface and view +properties. Editing is disabled. To enter administrator mode +click the Administrator Mode button located bottom +left of the module. Enter your password when prompted. + + +&knetworkconf; in administrator mode + + + + + +&knetworkconf; in administrator mode + + + + +Once in administrator mode all the modules +functionality is enable. Functionality is organized into three tabs: + + + + + + + + + + + + + + + + + + + + +Managing Network Interfaces + +The Network Interfaces tab is used to manage +the network communications devices installed on the system. All available +networking devices are listed. From the Network +Interfaces tab the following tasks can be accomplished: + + + + + + + + + + + + + + + + + + + + + + + + +The &knetworkconf; interface + + + +For each network device the following properties can be +viewed: + + + + + +Interface + +Shows the name of the network interfaces. For example, eth0, eth1, +wlan0. + + + +IP Address + +Shows the currently assigned IP address. + + + +Protocol + +Shows the boot protocol. + + + +State + +Shows the current state (up or down). + + + +Comment + +Shows the (freely assignable) comment. + + + + + +Configuring a Networking Device + +The properties of listed network devices can be configured by +selecting the required device from the list then clicking +the Configure Interface... button to display the +Configure Device dialog. + + +Configuring a networking device + + + + + +Configuring a networking device + + + + +By default only basic TCP/IP settings are available. Click +the Advanced Settings button to +expand the dialog to include advanced properties. + + + + + + +Advanced device configuration + + + +Complete the dialog values are as follows: + + + +Automatic + + + +Select the Automatic radio button when the +TCP/IP settings are obtained from a DHCP server or BOOTP server node. In +automatic mode the TCP/IP settings for the system are configured when the +system services are started. The DHCP or BOOTP server sends all the required +TCP/IP information each time the system is started, there is no need to +configure any other settings. Use the drop-list to select + or according to your +system. + + + +Manual + +Select the Manual radio button when you do not +use DHCP or BOOTP for TCP/IP configuration. In the IP +address field enter the TCP/IP address of the host. In the +Netmask field enter the subnetwork address. + + + +Activate when the computer starts + +When checked this option will cause the system to initialize this +network interface while the system is booting. If you do not want the device +initialized leave this option unchecked. + + + + +Description + + +Enter a descriptive name. + + + + +Broadcast + + +Enter the broadcast address used to communicate with +all hosts on the subnetwork. + + + + +The values entered in this dialog will be displayed as the properties +of the device in the device list. + + +Make certain that the IP-address entered is not already in use on the +network. Entering an IP-address that is already on the network will result +in a TCP/IP conflict. Use ping from &konsole; to +check if the address you want to enter is in use or not. If you are not sure +how to complete this dialog, consult your network administrator. + + + + + +Enabling a Network Device + +Network devices may be enabled or disabled depending on system +requirements. To enable a disabled network device select the device from the +list then click Enable Interface. + + + + +Disabling Network Devices + +Network devices may be enabled or disabled depending on system +requirements. To disable an enabled network device select the device from +the list then click Disable Interface. + + + + + +Managing System Routing + +The Routes tab enables management of +the system routing configuration. + + + + + + +Advanced device configuration + + + + + +Default Gateway + +This specifies the IP address of the host on the local subnetwork that +provides the physical connection to remote networks, and is used by default +when TCP/IP needs to communicate with computers on other subnetworks. +Select a device from the drop list to edit the Default +Gateway value. + + + + + +If your computer offers more than one network interface, select the +interface connected to network on which the gateway computer resides. + + + + + +Managing DNS Settings + +The Domain Name System tab enables management +of the system DNS configuration. + + + + + + +Advanced device configuration + + + + + +Host name + +The name by which the host will be known on the subnetwork. + + + +Domain name + +The network domain in which the host resides. + + + +Domain Name Servers + +A list of DNS servers in order of preference (see ). + + + +Static Hosts + +A list of known hosts on the subnetwork system (see ). + + + + + +Managing DNS Servers + +A computer running DNS matches up a fully qualified domain with a +proper IP address. This is necessary because computers only understand the +IP addresses. When a computer requests http://www.somedomain.com the DNS +resolves this name to an IP-address such as 123.45.678.90. + +The Domain Name Servers part of the +Domain Name System tab enables easy management of the +list. Server properties can be added, removed and edited. DNS records can be +arranged in order of preference by selecting a record and promoting or +demoting the record in the list using the Move Up or +Move Down buttons as required. + + + +Adding a DNS server + +From the Domain Name Servers group click the +Add... button. The Add New DNS Server +dialog is displayed. + + + + +Enter the IP-address of the DNS server then click +Add. The record is added to the DNS list. + + + + + +Editing a DNS server record + +From the Domain Name Servers group select a DNS +record then click the Edit... button. The +Edit Server dialog is displayed. + + + + + +Editing a DNS server record + + + + +Modify the IP-address then click OK. The record +is updated to the DNS list. + + + + + +Managing Static (Known) Hosts + +The Static Hosts list describes a number of +hostname-to-address mappings for the TCP/IP subsystem. It is mostly used at +boot time, when no name servers are running. On small, closed network +systems, it can be used instead of Domain Name Servers. + +By default, the Static Hosts list contains some +records describing the 'localhost' and a handful of special +records for hosts that support IPv6. This still-experimental version of IP +is destined to replace version 4. + + +Adding Static Hosts + +Click the Add... button. The Add New +Static Host dialog is displayed. + + + +Enter the IP-address of the known host then click +Add.... The Add New Alias dialog is +displayed. + + + +Enter the name of the known host then click the +Add button. If the known host has multiple aliases +click the Add button again and enter another +alias. + + +When finished click OK to update the Static +Hosts list. + + + + +Editing Static Hosts + +Select a static host record from the list, then click the +Edit... button. The Edit Static +Host dialog is displayed. + + + +Perform any of the following tasks, then click +OK to update the Static Hosts list. + + +To change the IP-address, enter a new IP-address, then click +OK. + + +To add a new alias, click the Add... +button. + + +To change an alias value, select the alias record, then click +Edit.... + + +To remove an alias, select an alias record then click +Remove. + + + + + + + + + +Applying Changes + +Changes made via the Network Settings +module are not automatically applied to the system environment. To apply the +changes made, start &konsole; and execute the +following command. + + +/etc/init.d/networking restart + + + + + +Installation + + +Requirements + +You need &kde; 3.x and QT 3.x installed to use knetwork-conf. +knetwork-conf can be used with the following platforms: + + + +&kubuntu; + + +Conectiva + + +Debian + + +Fedora Core + + +FreeBSD + + +Gentoo + + +&Mandrake; + + +PLD + + +OpenNA + + +&RedHat; + + +&SuSE; + + + + + +How to obtain knetwork-conf + +knetwork-conf's home page is at http://knetworkconf.sourceforge.net where you at least can download +source packages. + + + +Installing binaries + +When using the binary distributions (most often rpm packages), it is +enough to have the &kde; and QT binaries installed. Installing +binaries is recommended for less experienced users. Simply download the rpm +packages. Install them from &konsole; using +RPM as follows: + + +rpm -i knetwork-conf-versionnumber.rpm + + +Alternatively, use a graphical front end like + kpackage or the installation + tool of your distribution. + + + +Compilation and Installation + +In this case, it is not enough to have the binaries of QT and &kde; +installed; you also need the development packages which include libraries +and other stuff. + +Recommended for advanced users only. Otherwise, compiling &knetworkconf; +is not difficult. The following commands should do it. + + +./configure --prefix=$(kde-config --prefix) +make +make install + + + +The command make install must be run as +root. + +That should do it. Should you run into any problems, please +let us know. + + + + +Technical Information + +In the first section of this chapter, you'll find some valuable +information about networking basics. In the second, all configuration files +on your disk which can be changed by &knetworkconf; will be discussed. + + +IPv4 Networking + +This section cannot be a replacement for further lecture of +IP-Networking. In this appendix, you'll only find the basic informations to +get you started integrating your machine into a small (home) +network. + +Currently, IP-networking is done using TCP/IP version 4 (IPv4). IPv5 +has never been used much. IPv6 is expected to get spread in the near +future. So, this manual is based on the currently most spread IPv4. + +One of the most important informations for setting up an interface is +the IP-address which you have to assign to the interface. In foreign +networks, ⪚ your office, you have to ask the network administrator to +tell you a valid IP-address, or you can use DHCP if this is available. In +any case, you are not allowed to simply choose any IP-address! + +If you want to set up a small (home) network of your own, you should +use IP-addresses from a range which has especially reserved for this purpose +to prevent IP-address-conflicts with the global (Internet) network. The +addresses from the table shown below are not routed in the Internet, so it +is save to use them as you like. + +Of course these machines can later be configured for Internet access +by using a gateway machine. + +You can freely use the following addresses: + + +IP-Addresses for private networks + + + +Class +Range + + + + +A +10.0.0.0 to 10.255.255.255 + + +B +172.16.0.0 to 172.31.0.0 + + +C +192.168.0.0 to 192.168.255.0 + + + +
+ +For smaller networks, the most often used addresses are these in the +range of 192.168.1.1 to 192.168.1.254. This is enough for networks up to +over 250 computers. + +Furthermore, the netmask is most often set to 255.255.255.0, so that +all of these machines are members of the same subnet. + +Some addresses are reserved for special things, ⪚ 0.0.0.0 and +127.0.0.1. The first one is the so called default route, the second the +loopback address. The default route is needed by IP routing. + +The network 127.0.0.1 is reserved for the IP-traffic which works on +the local machine only. Usually, the address 127.0.0.1 is assigned to a +special device, the so called loopback interface, which works like a closed +circle. + +A default gateway is a computer which connects two different +networks. If you have configured a small network of your own, it is most +likely that you want all (or some) of your machines to grant Internet +access. But this is not possible directly, because these machines use local +private IP-addresses, which are not routed in the Internet. The solution is +a computer which translates between the two different networks. This +computer uses at least two interfaces. One of them, maybe an Ethernet card, +points to the local network, the other one, maybe an ISDN card, points to +the Internet. In this case, both interfaces use different IP-addresses. This +computer performs a so called network address translation (NAT, aka +IP-forwarding). To enable a local machine the Internet access, you have only +to tell them the default gateway, the local IP-address of the +gateway-computer. + + + + +Configuration files + +In this section you'll find the configuration files which are touched +by &knetworkconf; and where they reside in the file system of the different +distributions. + + +resolv.conf +In this file, the list of name servers is stored. + +Where to find resolv.conf + + + +Platform +Release number +Location + + + + +Conectiva +9.2 +/etc/resolv.conf + + +Debian +3.0 +/etc/resolv.conf + + +Fedora Core +1 +/etc/resolv.conf + + +FreeBSD +5 +/etc/resolv.conf + + +Gentoo +2005.0 +/etc/resolv.conf + + +&Mandrake; +9.2 +/etc/resolv.conf + + +PLD +2.0 +/etc/resolv.conf + + +OpenNA +1.0 +/etc/resolv.conf + + +&RedHat; +9.0 +/etc/resolv.conf + + +&SuSE; +9.0 +/etc/resolv.conf + + + +
+ +This file is sometimes dynamically changed by DSL-connections, so do +not wonder if the file doesn't contain what you have put there when a DSL +connection is established. + + + +hosts +In this file, the list of known hosts is stored. + + +Where to find the file hosts + + + +Distribution +Releasenumber +Location + + + + +Conectiva +9.0 +/etc/hosts + + +Debian +3.0 +/etc/hosts + + +Fedora Core +1 +/etc/hosts + + +FreeBSD +5 +/etc/hosts + + +Gentoo +  +/etc/hosts + + +&Mandrake; +9.2 +/etc/hosts + + +PLD +2.0 +/etc/hosts + + +OpenNA +1 +/etc/hosts + + +&RedHat; +9.0 +/etc/hosts + + +&SuSE; +9.0 +/etc/hosts + + + +
+ +On &SuSE; it is known that this file gets occasionally resorted by the +script SuSEconfig. So do not wonder if you do not find in a state you have +expected. + + + + + +Credits and license + +Credits + +Thanks to all who have worked on &kappname;: + + +Developers + +Juan Luis Baptiste +juan.baptiste@kdemail.net + + +David Sansome me@davidsansome.com + + +Carlos Garnacho garnacho@tuxerver.net + + +Simon Edwards simon@simonzone.com + +Pedro Jurado Maquedo +pjmelenas@biwemail.com + + +Florian Fernandez florian.fernandez2@wanadoo.fr + + +Unai Garro Unai.Garro@ee.ed.ac.uk + + +Christoph Eckert mchristoph.eckert@t-online.de + + +Jaime Torres jtorres@telecorp.net + + +All the others which I have forgotten to list here - you know who +you are you@foo.tld + + + + +Authors + +Christoph Eckert: +mchristoph.eckert@t-online.de + + +Sean Wheller: sean@inwords.co.za + + + + + +License + +The Copyright on &kappname;, at least for the years 2003 and 2004, is +owned by Juan Luis Baptiste: +(juan.baptiste@kdemail.net). + + + +&underFDL; +&underGPL; + + + diff --git a/doc/kpackage/Makefile.am b/doc/kpackage/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kpackage/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kpackage/bsdloc.png b/doc/kpackage/bsdloc.png new file mode 100644 index 0000000..b498b7f Binary files /dev/null and b/doc/kpackage/bsdloc.png differ diff --git a/doc/kpackage/debaptloc.png b/doc/kpackage/debaptloc.png new file mode 100644 index 0000000..965b2ef Binary files /dev/null and b/doc/kpackage/debaptloc.png differ diff --git a/doc/kpackage/debloc.png b/doc/kpackage/debloc.png new file mode 100644 index 0000000..bcc96d0 Binary files /dev/null and b/doc/kpackage/debloc.png differ diff --git a/doc/kpackage/handle.png b/doc/kpackage/handle.png new file mode 100644 index 0000000..58caf2d Binary files /dev/null and b/doc/kpackage/handle.png differ diff --git a/doc/kpackage/index.docbook b/doc/kpackage/index.docbook new file mode 100644 index 0000000..2112411 --- /dev/null +++ b/doc/kpackage/index.docbook @@ -0,0 +1,1229 @@ + + + + + +]> + + + +The &kpackage; Handbook + + +Toivo +Pedaste + +
toivo@ucs.uwa.edu.au
+ + + + +Lauri +Watts + +
lauri@kde.org
+ +Reviewer + + + + + +2000 +Toivo Pedaste + + +&FDLNotice; + +2006-12-04 +3.5.5 + +&kpackage; is a &GUI; interface to the +RPM, Debian, Slackware and BSD package +managers. + + +kpackage +package +package manager +RPM +deb + + + + +Introduction + +&kpackage; is a &GUI; interface to the RPM, +Debian, Slackware and BSD package managers. &kpackage; is part of the K Desktop +Environment and, as a result, it is designed to integrate with the &kde; +file manager. + + + + + +Onscreen Fundamentals + +&kpackage; has two panels. The left panel displays a tree of the +installed and available packages, the right panel displays information +on the packages. + + + +The Main Window - Package Tree + +When &kpackage; is started normally (that is it has not been +invoked via drag and drop and has not been given any parameters) it +displays two panels with the package tree on the left, this tree shows +installed packages and optionally new and updated packages as +well. + + +&kpackage; Left Panel + + + + +Left Panel - Package Tree + + +Left Panel - Package Tree + + + + +The left panel displays the list of packages, the tabs along +the top determines which packages are displayed: + + + +Installed - Show installed packages + +Updated - Show packages for which newer versions are available + +New - Show uninstalled packages + +All - All packages + + +Below the tabs is the Search line, this filters the package tree so that only those packages whose name or summary contains the search string are displayed. + +The package tree is based on the sections of the distribution +and shows summary information about the packages: + + +Package - Name of the package +Mark - Shows a tick if the package has +been marked. Marking allows multiple packages to be installed or +uninstalled at once using the buttons located below the package tree. +Summary- A short description of the package. +Size- The package size +Version - The package version +Old Version - If the package updates an installed package, the +version of the old package + + + +The packages have graphical labels to indicate their state, an +image representing the package type means an installed package, a +N indicates an available package and a U +means a package that can upgrade an installed package. + +A single package is selected by clicking on the name. Clicking on +the dot in the Mark column marks the package with a +tick, a second click unmarks it, while &Shift;left click +can be used to mark a range of packages and &Ctrl;left click +can be used to add and remove marks on packages. + +Selecting a package from the tree displays information about it in +the right panel. + + + + +The Main Window - Package Information Panel + +The right panel has tabs for displaying three different types of +information about selected packages + + + + +&kpackage; Right Panel - Properties + + + + +Right Panel - Package Properties + + +The Properties tab which displays +information on the selected package. In the dependency information there are +hyper-links to the packages listed, installed packages are in standard font, +uninstalled but available packages are in italic and dependencies that aren't +available are normal text. + + + + + + + + +&kpackage; Right Panel - Properties + + + + +Right Panel - The Files in the Package + + +The File List tab shows the files in the +package and for installed packages (provided the information is +available) shows the state of the +files. Files that exist are marked with a tick, those that are +missing are marked with a cross. + + + + + + + + + +&kpackage; Right Panel - Properties + + + + +Right Panel - The Files in the Package + + +The Change Log tab shows the change log +for the package. + + + + + + + + + + + +Installing Packages + +To install a package you can + + +locate the package you wish to install in &konqueror;, drag it +onto a running copy of &kpackage; + + +click on a package file in &konqueror; and start a new copy of +&kpackage; + + +use on the Open menu items in +&kpackage; + + +selecting an available package in the package tree + + + +For a selected package, use the buttons in the right panel, the +Fetch button will fetch the package from a remote +source and display detailed information, the +Install button pops up the installation +window. + +For marked packages, use the +Install Marked button on the left panel, +which pops up the install +window. + + +&kpackage; Install dialog + + + + +Install Dialog + + +Install Dialog + + + + +The install window lists the packages to be selected to +be installed in a panel in the top left, if Debian APT +is being used the packages needed to satisfy any dependencies are +also shown. Below this there are a set of check boxes which set options for +the install program. For RPM packages the options +are: + + +Upgrade - Will upgrade any already +installed package. + + +Replace Files - Install the packages even +if they replace files from other, already installed, packages. + + +Check Dependencies - Verify dependencies. + + +Test (do not install) + + + +For Debian APT the options are: + + +Download only - Fetch the packages but +don't install them. + + +No download - Only use packages that +are locally available + + +Ignore missing - Do the install even if +some packages are missing + + +Ignore hold - Ignore holds that have been +placed on packages + + +Allow Unauthenticated - Ignore any requirements that +the packages must be signed. + + +Assume yes - Answer yes for any questions +the install program would ask. + + +Test (do not install) + + + +The Install button will start the +actual install. Normally the install window will be deleted after +a successful install but if the +Keep this window check box is selected the +window will stay around. + +The panel on the right is an integrated +terminal window in which the installation programs are run, for +interactive installation programs the interaction is done in this +window. + + + + +Uninstalling Packages + +A selected package can be uninstalled by using the +Uninstall button in the right panel, the +Uninstall Marked in the right panel +can be used to uninstall marked packages. The buttons bring +up the uninstall window. + + +&kpackage; Install dialog + + + + +Uninstall Dialog + + +Uninstall Dialog + + + + +The +Uninstall button in the window causes the +packages to be uninstalled, and the right panel provides an integrated +terminal window for the uninstall program. + +For RPM packages the options +are: + + +Use scripts - Execute any unistall scripts + + +Check Dependencies - Verify dependencies. + + +Test (do not uninstall) + + + +For Debian APT the options are: + + +Purge Config Files - Remove any package +configuration files. + + +Assume yes - Answer yes for any questions +the install program would ask. + + +Test (do not uninstall) + + + + + + + +Integrating available packages in the tree + +Access to available packages is setup in the menu with Settings +Configure &kpackage;.... + + + + +&kpackage; Install dialog + + + + +Package Handler Panel + + +Package Handler Panel + + + + +The top part of the panel has the Remote Host +box which allows &kpackage; to operate on the packages on a remote computer, +this functionality requires ssh and is only available +when using Debian apt. The name of the remote +computer is entered into the combobox and &kpackage; will access +it when the Use remote host checkbox is +selected. + +The rest of the panel allows the enabling and disabling of +the various package types that &kpackage; can handle. If a package +type is enabled the Location of Packages button +will bring up a dialog for setting the location of available packages. +If the programs required for handling a package type is not available the package +type will be automatically disabled. + + + +&kpackage; Install dialog + + + + +RPM Location Dialog + + +RPM Location Dialog + + + + +For RPM packages &kpackage; can read a +folder containing packages and add these to the package tree as +either new or updated packages. It is possible to examine or install +these packages from the package tree. By default the information about +the packages is extracted from the standard format of the file names and +so it is necessary to use the Examine button to +see the full description, it is possible though to set an option so that +for local folders each package file is read, this is slower but +gives a full description. + +The RPM locations dialog allows the specification +of folders containing RPM packages, it's divided +up into a number of tabbed panels for convenience of management. Each +line in the panel specifies a folder, the Use +checkbox is selected the folder is used, otherwise it's ignored. +The text entry field can take either a folder path or an ftp +URL. The Subfolders checkbox determines +whether subfolders are searched for packages. The ... +button will pop up a folder selection dialog. + + + +&kpackage; Install dialog + + + + +Debian Apt Location Dialog + + +Debian Apt Location Dialog + + + + +APT: Debian means that Debian packages +are handled using the deb-apt command which +can automatically fetch packages from repositories and +resolve dependencies. + +The location of +uninstalled package repositories can be set in the "A" panel, this is +used to write the /etc/apt/sources.list file +which controls where deb-apt searches for packages, +each entry corresponds to a line in the file, if the +Use checkbox is not set the line is commented +out. + +The "D" panel allows the specification of folders containing +Debian packages. + + +&kpackage; Install dialog + + + + +Debian DPKG Location Dialog: L and P panels + + +Debian DPKG Location Dialog: L and P panels + + + + + +DPKG: Debian means that packages are handled using dpkg +command, there are three ways of accessing available packages, these can be +selected in three different types of location setting panels. + + + +The "I" panel specifies the location of the Debian package tree +and selects the +distribution and architecture. &kpackage; will look in the standard +places for the Package files describing the available packages and these +packages are then added to the package tree and can be examined or +installed + + +The "P" panel specifies the location of the Debian distribution along with the +Packages files for the parts of the distribution that are of +interest. If the dselect program is being +used then the file /var/lib/dpkg/available can be +used as a Packages file that describes the distribution that +dselect uses. + +The "D" panel specifies folders that are handled in the same way as with +RPM packages. + + + +&kpackage; Install dialog + + + + +Slackware Location Dialog + + +Slackware Location Dialog + + + + +For Slackware packages there is very little information stored on +installed packages, but it is possible to use a +PACKAGE.TXT file as a source of information about +the installed packages. The PACKAGES.TXT file is +the equivalent of a Debian Packages file and Slackware distributions are +structured with a folder tree containing the .tgz packages and a +PACKAGES.TXT file that describes the +packages. + +As with Debian distributions the packages in a Slackware +distribution can be integrated into the package tree. Unfortunately the +Slackware packages don't carry version information so it is not possible +to tell with available packages are newer than installed ones. + + +The "I" panel is the location of a +PACKAGES.TXT file which is used to provided information on +the installed packages +The "P" panels can be used to specify the location of +distributions with the folder tree containing the .tgz files and the location of the corresponding +PACKAGES.TXT file +The "D" panels are for folders that do +not have a corresponding PACKAGES.TXT +fi +le + + + +&kpackage; Install dialog + + + + +BSD Location Dialog + + +BSD Location Dialog + + + + +For BSD packages &kpackage; will understand a +packages distribution folder that contains an +INDEX file (which describes all the packages) and +also contains an All folder (with all the +package files in it). + +The "Ports" panel gives the location of the ports tree in +the file system +The "Packages" panel allows the specifying the location of packages +folders &ie; those containing INDEX +files + +For remote folders and package files (&ie; those fetched via +&FTP;) &kpackage; will do caching, the packages are by default cached in +~/.kpackage and the folders in +~/.kpackage/dir. + +For the handling of remote (&FTP;) folders to work, it +may be necessary to not have the FTP Proxy set in the +Browser Settings. + + + + +Searching + +Package Search Line + + + &kpackage; Search Line + + + + + Search Line + + + Search Line + + + + +The Search line filters the package tree so that only those packages whose name or summary contains the search string are displayed. + + + + + Find Package + + + &kpackage; Find Package + + + + + Find Package + + + Find Package + + + + + The Find Package dialog searches the names + of the packages in the package tree and moves to the next matching package. + If Sub string is not set then it will find only exact + matches against packages names. If Wrap search is not + set the search doesn't wrap around the end of the package tree. + + + + + Find File + + + &kpackage; Find File + + + + + Find File + + + Find File + + + + + The Find File dialog searches for files the names of + which contain the search string. + The columns in the display are: + + + Installed - Ticked if it is an installed package. + + + Type - The type of the package. + + + Package - The name of the package + + + File Name - The name of the matched file + + + Only the files in installed packages are shown unless Also search uninstalled packages is set, this will only work with Debian APT + packages and only if the apt-file command is installed. + The database used by the apt-file command is updated + by the Apt-File Update menu item. + + + + + + + + + Misc + + Root Access + + &kpackage; requires root + access for installing/uninstalling packages, this can be can be done by + running &kpackage; as root, + say by using &kdesu;. + + Alternatively, if &kpackage; is running as a normal user it will + try to run the install/uninstall programs as root by logging in to a + pseudo terminal, it will use either su, sudo or + ssh to do this and if needed it will pop up a + prompt window where the root + password or ssh key can be typed. For this to work the root prompt has to end in + # . The Keep password option causes &kpackage; to + remember the password that is entered. + + &kpackage; Password prompt + + + + + Password prompt + + + Password prompt + + + + + + + + + Drag and Drop + + &kpackage; makes use of the &kde; Drag and Drop protocol. This + means that you can drag and drop packages onto &kpackage; to open + them. Dropping a file onto the Find File dialog + will find the package that contains the file. + + + + + + + +Menus + +This describes the &kpackage; menus. + + +<guimenu>File</guimenu> menu + +The items in the File menu are: + + + + +&Ctrl;O +File +Open... +Brings up file selector for local and &FTP; +files + + + +File +Open Recent +A list of the most recently open package files + + + + +&Ctrl;F +FileFind +Package... +Search the installed package list for a package, the name +of which contains the entered string + + + +File +Find File... +Produces a list of packages that contain the entered +file name, selecting a line will display the information on that +package. It behaves slightly differently for RPM +(where you have to enter the exact file name) and DEB +(where you can enter a regular expression). + + + +F5 +File +Reload +Reread the package data and rebuild the package +tree + + + + +&Ctrl;Q +File +Quit +Quit &kpackage; + + + + + + +<guimenu>Packages</guimenu> menu + +The items in the Packages menu are: + + + + + +&Alt;Left + +Packages +Back +Back button for navigation using the links in +Properties entries in the right panel. + + + + +&Alt;Right + +Packages +Forward +Forward button for navigation using the links in +Properties entries in the right panel. + + + +Packages +Expand Tree +Fully expands the packages tree + + + +Packages +Collapse Tree +Collapses the package tree so that only the tree structure is +shown + + + + Packages +Clear Marked +Unmarks all packages + + + + Packages +Mark All +Marks all packages that are members of the selected view + + + +Package +Install + + +Install the currently selected package + + + + +Package +Install Marked + +Install all marked packages + + + + +Package +Uninstall + + +Uninstall the currently selected package + + + + + +Package +Uninstall Marked + + + +Uninstall all marked packages + + + + + + + + + +<guimenu>Cache</guimenu> menu + +The items in the Cache menu are: + + +Cache Clear +Package Folder Cache +Delete cached copies of remote package folders and Packages +files + + + + +CacheClear Package +Cache + +Delete cached copies of remote package files that have been +fetched + + + + + + +<guimenu>Special</guimenu> menu + +The Special contains actions +related to specific package types: + + + + +Special +APT: Debian + + + + + + +Update +Update apt indexes from package +repositories. + + + +Upgrade +Upgrade the Debian installation to the latest versions +of all the packages. + + + +Fixup +apt is extremely strict about +dependencies, attempt to fixup dependency problems + + + + Apt-File Update + Searching for uninstall files uses the apt-file command, this updates the database that apt-file uses. + + + + + + + + + + + + +<guimenu>Settings</guimenu> menu + +The items in the Settings menu are: + + + + +SettingsShow +Toolbar + +Toggle displaying the toolbar + + + + +SettingsSave +Settings +Save options immediately + + + + +SettingsConfigure +Shortcuts... +The standard &kde; dialog for setting shortcut +keys + + + + +SettingsConfigure +Toolbars... +The standard &kde; dialog for configuring tool +bars + + + +Settings +Configure &kpackage;... + + + + +Types +Which package types to handle, Debian using DPKG and +Debian using APT are listed separately, it is not a good idea to +enable both at the same time. It also sets whether to access +a remote host for Debian apt. + + + +Cache +Controls caching of remote (&FTP;ed) folders and Package +files. + + + +Cache Remote Package Folders +Whether to cache remote (&FTP;ed) folders and Package +files. + + + +Cache Remote Package Files +Whether to cache remote package files that have been fetched + + + + +Cache Folder +Where to cache package files and folders + + + + + + + + +misc + + + + +Execute Privileged Commands Using +Use su, sudo or +ssh for running privileged commands. For remote Debian APT ssh +is always used. + + + +Verify file list +If set the list of files in the package is checked to see if +they are actually installed + + + +Read information from all local package files +If set all the files from a (local) package folder are read +instead of just using the files names, this is slower but shows more +information. + + + + + + + + + + + + + + + +<guimenu>Help</guimenu> menu + +The items in the Help menu are: + +&help.menu.documentation; + + + + +Toolbar + + +Open +Back +Forward +Expand Tree +Collapse Tree +Find Package +Find File +Reload + + + + + +Credits and Licenses + + +&kpackage; + + +Documentation copyright 2005 Toivo Pedaste +toivo@ucs.uwa.edu.au + + +&underFDL; +&underGPL; + + + + +Installation + + +How to obtain &kpackage; + +&install.intro.documentation; + +For information on how to obtain and compile it see +http://www.kde.org/install-source.html + +There is more information on compilation at +http://www.kde.org/compilationfaq.html + +There is a web page at +http://www.general.uwa.edu.au/u/toivo/kpackage + + + + +Requirements + +For installing &kpackage; you need: + + +&Qt; 3 and &kde; 3 + + +For listing Debian packages no other software is needed but to +install and uninstall the packages you need: + + +the dpkg package +manager or + + apt-get and +apt-cache + + +For BSD packages you need the package +management programs: + + +pkg_info +pkg_add +pkg_delete + + +For Slackware packages you need: + + +installpkg +removepkg + + +For dealing with Redhat packages you need: + + + +rpm + + +For &kpackage; to work correctly with RPM +packages the RPM database must be initialized. If +typing rpm + gives an error about +unable to open.... then try +rpm +. + + + + + + + diff --git a/doc/kpackage/install.png b/doc/kpackage/install.png new file mode 100644 index 0000000..958dc44 Binary files /dev/null and b/doc/kpackage/install.png differ diff --git a/doc/kpackage/left.png b/doc/kpackage/left.png new file mode 100644 index 0000000..ad665c2 Binary files /dev/null and b/doc/kpackage/left.png differ diff --git a/doc/kpackage/right-change.png b/doc/kpackage/right-change.png new file mode 100644 index 0000000..303dd62 Binary files /dev/null and b/doc/kpackage/right-change.png differ diff --git a/doc/kpackage/right-files.png b/doc/kpackage/right-files.png new file mode 100644 index 0000000..e986caf Binary files /dev/null and b/doc/kpackage/right-files.png differ diff --git a/doc/kpackage/right-prop.png b/doc/kpackage/right-prop.png new file mode 100644 index 0000000..94b01de Binary files /dev/null and b/doc/kpackage/right-prop.png differ diff --git a/doc/kpackage/root-prompt.png b/doc/kpackage/root-prompt.png new file mode 100644 index 0000000..b954963 Binary files /dev/null and b/doc/kpackage/root-prompt.png differ diff --git a/doc/kpackage/rpmloc.png b/doc/kpackage/rpmloc.png new file mode 100644 index 0000000..52b03b1 Binary files /dev/null and b/doc/kpackage/rpmloc.png differ diff --git a/doc/kpackage/search.png b/doc/kpackage/search.png new file mode 100644 index 0000000..4d77cc1 Binary files /dev/null and b/doc/kpackage/search.png differ diff --git a/doc/kpackage/searchf.png b/doc/kpackage/searchf.png new file mode 100644 index 0000000..135f89b Binary files /dev/null and b/doc/kpackage/searchf.png differ diff --git a/doc/kpackage/searchl.png b/doc/kpackage/searchl.png new file mode 100644 index 0000000..fc47d07 Binary files /dev/null and b/doc/kpackage/searchl.png differ diff --git a/doc/kpackage/slackloc.png b/doc/kpackage/slackloc.png new file mode 100644 index 0000000..210cf6b Binary files /dev/null and b/doc/kpackage/slackloc.png differ diff --git a/doc/kpackage/uninstall.png b/doc/kpackage/uninstall.png new file mode 100644 index 0000000..b30ed5c Binary files /dev/null and b/doc/kpackage/uninstall.png differ diff --git a/doc/ksysv/Makefile.am b/doc/ksysv/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/ksysv/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/ksysv/index.docbook b/doc/ksysv/index.docbook new file mode 100644 index 0000000..9dc4f54 --- /dev/null +++ b/doc/ksysv/index.docbook @@ -0,0 +1,1117 @@ + + + + + +]> + + + +The &ksysv; Handbook + + +Peter +Putzer + +
putzer@kde.org
+ + + + + +2001-03-21 +1.03.06 + + +1998 +2000 +2001 +Peter Putzer + + +&FDLNotice; + + +&ksysv; is a graphical editor for the SysV style init +configuration. + + + +KDE +KSysV +Runlevel +Runlevel editor +System V init + + + + +Introduction + + +Welcome to the &kde; System V Init Editor, commonly known (and hereafter +referenced) as &ksysv;. This section introduces a few concepts and explains what +you can do with &ksysv;. + + + + + +A Brief Description of System V Init + + +The following explanation is borrowed from +tksysv (an inspiration for &ksysv;): + + + +System V init is fast becoming the standard in the &Linux; world to +control the startup of software at boot time. This is because it is +arguably easier to use and more powerful and flexible than the +traditional BSD init. + + + +I won't go into the history here (mainly because I don't know it :-). + + + +The init binary is located in /sbin and +not /etc. This is important as one might +try and upgrade a machine to System V init without re-installing and +reformatting. The &Linux; kernel looks in /etc for its init first, so you must make sure and +delete your old init from there if any. + + +SysV init also differs from BSD init in that +the config files are in a subfolder of /etc instead of residing directly in +/etc. This folder is called +rc.d. In there you will find +rc.sysinit and the following folders: + + + + + +init.d/ + + + + +rc0.d/ + + + + +rc1.d/ + + + + +rc2.d/ + + + + +rc3.d/ + + + + +rc4.d/ + + + + +rc5.d/ + + + + +rc6.d + + + + + +init.d contains a bunch of +scripts. Basically, you need one script for each service you may need to +start at boot time or when entering another runlevel. Services include +things like networking, NFS, &Sendmail;, httpd,&etc; +Services do not include things like setserial that +must only be run once and then exited. Things like that should go in +the file rc.local. + + + +rc.local should be in /etc/rc.d if you want one. Most systems +include one even though it doesn't do much. You can also include an +rc.serial in /etc/rc.d if you need to do serial port +specific things at boot time. + + +The chain of events is as follows: + + + + +The kernel looks in several places for init and runs the first one it +finds. + + + + +init runs /etc/rc.d/rc.sysinit. + + + + +rc.sysinit does a bunch of necessary things and then runs +rc.serial (if it exists) + + + + +init runs rc.local + + + + +init runs all the scripts for the default runlevel + + + + + + +The default runlevel is decided in +/etc/inittab. You should have a line close to the +top like: + + +id:3:initdefault: + + +From this, you'd look in the second column and see that the default +runlevel is 3, as should be the case for most systems. If you want to +change it, you can edit /etc/inittab by hand and +change the 3. Be very careful when you are messing with the inittab. If +you do mess up, you can get in to fix it by rebooting and doing: + + +LILO boot: linux single + + +This should allow you to boot into single user mode +so you can fix it. + + +Now, how does it run all the right scripts? If you do an +ls on +rc3.d, you might see something +like: + + + +lrwxrwxrwx 1 root root 13 13:11 S10network -> ../init.d/network +lrwxrwxrwx 1 root root 16 13:11 S30syslog -> ../init.d/syslog +lrwxrwxrwx 1 root root 14 13:32 S40cron -> ../init.d/cron +lrwxrwxrwx 1 root root 14 13:11 S50inet -> ../init.d/inet +lrwxrwxrwx 1 root root 13 13:11 S60nfs -> ../init.d/nfs +lrwxrwxrwx 1 root root 15 13:11 S70nfsfs -> ../init.d/nfsfs +lrwxrwxrwx 1 root root 18 13:11 S75keytable -> ../init.d/keytable +lrwxrwxrwx 1 root root 23 13:11 S80sendmail -> ../init.d/sendmail.init +lrwxrwxrwx 1 root root 18 13:11 S90lpd -> ../init.d/lpd.init +lrwxrwxrwx 1 root root 11 13:11 S99local -> ../rc.local + + +What you'll notice is that there are no real files in the folder. +Everything there is a link to one of the scripts in the init.d folder. + + + +The links also have an S and a number at the +beginning. The S means to start this particular +script and a K would mean to stop it. The number is +just there for ordering purposes. Init will start all the services based +on the order they appear. You can duplicate numbers, but it will only +confuse you somewhat. You just need to use a two digit number only, +along with an upper case S or K to +start or stop the services you need to. + + + +How does it start and stop services? Simple. Each of the scripts is +written to accept an argument which can be and +. You can execute those scripts by hand in fact +with a command like: + + +/etc/rc.d/init.d/httpd.init + + +To stop the httpd server. Init just reads the name and if it has a +K, it calls the script with the +argument. If it has an it calls the script with a + argument. + + + +Why All These Runlevels ? + + +Some people want an easy way to setup machines to be multi-purpose. I +could have a server runlevel that just runs httpd, +sendmail, networking, &etc; Then I could have a user +runlevel that runs kdm, networking, &etc; + + + + + + + +Onscreen Fundamentals + + +Here you learn how to use &ksysv;, which shouldn't be hard since it was +designed to be as user-friendly as possible. + + + +Mouse + + +Using &ksysv; with a mouse or other pointing device is easy: just drag +an entry from the Available Services area onto one +of the six runlevels to start (or resp. stop) it in that runlevel. + + + +You can also move scripts between runlevels, or change the position in a +given runlevel, by dragging it around. Doing so removes the entry from +its original runlevel (or position). This doesn't happen when you drag +an entry from the Available Services area. + + + + +Entries are moved when you drag them to a new area. To copy a service to +a different runlevel, you have to select Copy +from the Edit or context menu and +Paste it in the target runlevel. + + + + +The sorting number of an entry sometimes cannot be +calculated. In such a case you have to edit the sorting numbers of +surrounding entries before re-trying to insert the service. + + + + +Sorting numbers can range from 00 to 99, but no higher. + + + + +You can delete entries by dragging them onto the Trash +Can area (symbolized by an icon depicting a garbage bin). + + + + +Currently there is no way to recover items dragged +onto the Trash Can, so be careful! + + + + + + +Keyboard + + +You can use the Tab key to switch focus between +different panels (Available Services, +Runlevel 1 Start, Runlevel 1 +Stop, &etc;) and the cursor keys to move the selection up and +down. + + + +To move an entry to a different runlevel, Cut +it to the clipboard (using &Ctrl; +X and Paste it in +the target runlevel (with &Ctrl; +V). + + + +To manually change an entries sorting number or name, press +Enter to open the properties dialog. Use the +Tab key to switch between different fields. Close the +dialog by pressing Enter to accept the modifications, +or press Esc to cancel any changes. + + + + + +The Menu Entries + + +A one by one description of &ksysv;'s menu. + + + +The <guimenu>File</guimenu> menu + + +Because of the danger of data loss, all menu entries under +File ask for confirmation before doing their work. + + + + + + +File +Revert Configuration... + + + + +Forget any changes you have made, and revert to the last saved configuration. + + + + + + + + +&Ctrl; O + +File +Open... + + + + +Open a previously saved configuration. + + + + + + + + +&Ctrl; S + +File +Save Configuration + + + + +Make your changes permanent. Saving does not generate any +backup files, so use with care. + + + + + + + +File +Save As... + + + + +Save a copy of your new configuration. + + + + + + + + +&Ctrl; L + +File +Save Log... + + + + +Save a log + + + + + + + + + +&Ctrl; P + +File +Print Log... + + + + +Print a copy of the log. + + + + + + + + +&Ctrl; Q + +File +Quit + + + + +Quit &ksysv;. + + + + + + + + +The <guimenu>Edit</guimenu> menu + + + + + + +&Ctrl; Z + +Edit +Undo + + + + +Undo the last unsaved change made. + + + + + + + + +&Ctrl; Shift +Z + +Edit +Redo + + + + +Redo the last item undone. + + + + + + + + +&Ctrl; X + +Edit +Cut + + + + +Cut the currently selected service to the clipboard. + + + + + + + + +&Ctrl; C + +Edit +Copy + + + + +Copy the selected entry to the clipboard, without removing it from its +original position. + + + + + + + + +&Ctrl; V + +Edit +Paste + + + + +Paste the content of the clipboard at the current cursor +position. + + + + + + + +Edit +Properties + + + + +Open the properties dialog for the selected item. + + + + + + + + +The <guimenu>Tools</guimenu> menu + + + + + +Tools +Start Service... + + + + +Start the selected service + + + + + + + +Tools +Stop Service... + + + + +Stop the selected service + + + + + + + +Tools +Restart Service... + + + + +Restart the selected service. + + + + + + + +Tools +Edit Service... + + + + +Edit the selected service + + + + + + + + + +The <guimenu>Settings</guimenu> menu + + + + + +Settings +Show Toolbar + + + + +Toggle on and off display of the toolbar. + + + + + + + +Settings +Show Statusbar + + + + +Toggle on and off display of the statusbar. + + + + + + + +Settings +Show Log + + + + +Toggle on and off the display of the log window + + + + + + + +Settings +Save Settings + + + + +Save your current settings. + + + + + + + +Settings +Configure Key bindings... + + + + +Customize the default keybindings. + + + + + + + +Settings +Configure Toolbars... + + + + +Customize the toolbar. + + + + + + + +Settings +Configure SysV-Init Editor... + + + + +Customize the behavior of &ksysv; + + + + + + + + +The <guimenu>Help</guimenu> menu + +&help.menu.documentation; + + + + + + + + +Configuration + + +All options are saved in +$KDEHOME/share/config/ksysvrc. Defaults +are taken from the global file +($KDEDIR/share/config/ksysvrc), if +available, or else generated within &ksysv;. Changes to the defaults +are stored in your local ksysvrc. + + + +Recognized Sections + + +Recognized sections and keys plus their default values. + + + +[Path Settings] + + +Keyword +Default +Description + +ScriptPath +/etc/rc.d/init.d +Path to the scripts used for starting and stopping services. + + + +RunlevelPath +/etc/rc.d +Path to the runlevel subfolders. + + + + + + + +[Colors] + + + +Keyword +Default +Description + +Changed +red +Color used for changed entries + + + +New +blue +Color used for new entries + + + + + + + +[Geometry] + + +Keyword +Default +Description + +Width + +Width of &ksysv;'s window + + + +Height + +Height of &ksysv;'s + + + + + + +[Other Settings] + + +Keyword +Default +Description + +ToolBar +true +If the toolbar is enabled or not + + + +StatusBar +true +If the statusbar is enabled or not + + + +ShowLog +true +If the log window is shown or not + + + +PanningFactor +80 +100 - PanningFactor = percentage of window reserved for the logfile +display + + + + + + + + + + +Questions and Answers + + + + + +I played around with the default runlevel, and now my machine reboots +all the time. What can I do? + + + + +Enter linux single at the +LILO prompt, and press Enter to +boot into single user mode. Edit the file +/etc/inittab and change to the default runlevel +to something sane. 3 should normally be safe. + + + + + + + +My Machine halts just after booting + + + + +See Question 1, above. + + + + + + + +I scheduled some services to be run in runlevel X using &ksysv;, so why +aren't they working? + + + + + +If you're using SuSE or Delix (DLD) distributions, you also have to edit +a distribution specific file in /etc. Please have a look at the manual of +your distribution for details. + + + + +The approach to starting services used by the above mentioned +distributions makes configuration of services easy for the proprietary +configuration tools these distributions provide, but it is unfortunately +non-standard. The &ksysv; authors plan to write a generic extension for +this approach some time in the future, but don't hold your breath. + + + + +If you're using a different distribution, please check you have all the +config files needed by the service, and whether they are in the correct +locations. Some daemons for example Apache, +(aka httpd) just die silently if +their configuration files are missing or misconfigured. + + + + + + + + + +Standard semantics of Runlevels + + +These vary by distribution, so this is an incomplete list of the most +common &Linux; distributions. If you have additional distributions, +please email the author and have the information added to this manual. + + + + +&RedHat; + + + +Runlevel 0: + + +halt (shuts down the machine) + + + + +Runlevel 1: + + +Single user mode. + + + + +Runlevel 2: + + +Multi user text only, without NFS. + + + + +Runlevel 3: + + +Multi user text-only, with full networking. + + + + +Runlevel 4: + + +Not used. + + + + +Runlevel 5: + + +Multi user X11 with full networking. + + + + +Runlevel 6: + + +Reboot + + + + + + + + + + + +License and Credits +&ksysv; Copyright © 1997-1998 Peter Putzer + + + + +Peter Putzer, putzer@kde.org - Developer + + + + + +Documentation: + + + + +Peter Putzer, putzer@kde.org - Original content + +Eric Bischoff, e.bischoff@noos.fr - Editor + + + + + +&underFDL; +&underGPL; + + + + +Installation + +&install.intro.documentation; +&install.compile.documentation; + + + + + diff --git a/doc/kuser/Makefile.am b/doc/kuser/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kuser/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kuser/index.docbook b/doc/kuser/index.docbook new file mode 100644 index 0000000..9b3f006 --- /dev/null +++ b/doc/kuser/index.docbook @@ -0,0 +1,273 @@ + + + + +]> + + + + +The &kuser; Handbook + + +Matt +Johnston + +
mattj@flashmail.com
+ + + + +Lauri +Watts + +
lauri@kde.org
+ +Reviewer + + +Jonathan +Singer + +
jsinger@leeta.net
+ +Reviewer + + + + + +2000 +Matt Johnston + +&FDLNotice; + + +2002-10-08 +1.0 + +This documentation describes &kuser; version 1.0. This +program allows you to manage users and groups on your system. + + + +kuser +user +management +admin +tools +group +password + + + + +Getting Started + +This is a short introduction to &kuser;. For more detailed +information, see Usage. + +Actually, you do not need to do anything to begin using &kuser; +except configuration. + +When you have made the changes you want, you must +Save them for them to take effect. Either +choose the Toolbar icon, or use the File menu. + + + + +Usage + + +Main Window + +&kuser; is a very simple application. In the main window you can +see two tabs: the list of users and the list of groups. To edit a user +or a group, just double click on it. The user or group properties dialog +will appear. + +&kuser; Main Window + + + + + +&kuser; Main Window + + + + + + + +User Properties Dialog + +The user properties dialog has various tabs. + +The number of tabs depends on the type of the user storage system +and whether quotas are being used. Additional tabs will appear if you +have shadow passwords, or any other similar things such as +/etc/master.passwd in BSD flavor Unices. + + +<guilabel>User Info</guilabel> Tab + +In the User Info tab you can modify: + + + +User Id +Full Name +Login Shell (the list of login shells is +taken from the /etc/shells file) +Home Folder +Two office locations +Address +Password + + + + + +<guilabel>Password Management</guilabel> Tab + +The Password Management tab will appear if you have +shadow passwords, or any other similar things such as +/etc/master.passwd in BSD flavor +Unices. + +In the Extended Info tab you can modify +parameters related to extended account control: + + +Minimum number of days between password +changes +Number of days after which a password expires if it hasn't been +changed +Number of days before expiration the user will be +warned +Whether and when an account will be disabled if the password +expires +A set date when the account expires +Class (on BSD +systems) + +The date of the last password change is displayed near the top of the +dialog. + + + + + +<guilabel>Quota</guilabel> Tab + +You will probably see the Quota tab only if you +have at least one mounted volume with quota enabled and a quota file +present. There you may modify all quota related parameters: + + +File Soft Quota +File Hard Quota +File Time Limit (Grace +Period) +iNode Soft Quota +iNode Hard Quota +iNode Time Limit (Grace +Period) + + + All these parameters can be changed for each filesystem that has user +quota enabled. Filesystems can be changed using the Quota +Filesystem box. + + + + +<guilabel>Groups</guilabel> Tab + +The Groups tab contains all the information about the +selected user's participation in groups. The primary group to which the user +belongs +is set in the Primary Group box. The user can be assigned +to additional groups by checking them in the large box. + + + + + +<guilabel>Group Properties</guilabel> + +The Group Properties dialog contains a list of all +users. Check +the boxes for each user to be assigned to the selected group. + + + + +Adding, Editing and Deleting Users or Groups + +To add a user or group to the system, either choose +Add from the User or +Group menu, or click the relevant Add +button on +the toolbar. The selected user or group can also be edited or deleted in the +same way. + + + + +Customizing &kuser; + + +Edit user creation defaults + +To edit the user creation defaults you can use the Edit +defaults dialog, which is accessible via the menu +Settings +Configure &kuser;. There you may +change the defaults that are used when creating a new user: Shell and +Home Folder (or home folders volume). You can choose whether to +make a home folder on create or not,and to copy a +skeleton (standard configuration files) to the home folder or not. You can +also enable +User Private Group mechanism, which creates a new +personal group with the creation of a new user, and removes the personal +group when the user is removed. +The skeleton files for new users can be specified in the Sources + tab. + + + + + +Credits and License + +&kuser; + +Program copyright 1997-2000 Denis Pershin +dyp@inetlab.com + +Documentation copyright 1997-2000 Denis Pershin +dyp@inetlab.com +Documentation copyright 2000 Matt Johnston +mattj@flashmail.com + + +&underFDL; +&underGPL; + + +&documentation.index; + + + + diff --git a/doc/kuser/kuser.png b/doc/kuser/kuser.png new file mode 100644 index 0000000..e68ac2d Binary files /dev/null and b/doc/kuser/kuser.png differ diff --git a/doc/lilo-config/Makefile.am b/doc/lilo-config/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/lilo-config/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/lilo-config/index.docbook b/doc/lilo-config/index.docbook new file mode 100644 index 0000000..a0cf803 --- /dev/null +++ b/doc/lilo-config/index.docbook @@ -0,0 +1,177 @@ + + + + + + + +VirgilJ.Nisly"> +virgil@vigilite.com"> +]> + +
+ +The &liloconfig; Handbook + + +&Virgil.J.Nisly; &Virgil.J.Nisly.mail; + + + + +2005 +&Virgil.J.Nisly; + +&FDLNotice;&underFDL;&GPLNotice;&underGPL; + +2005-01-18 +1.00.00 +&liloconfig; is an application specificly designed to configure &lilo; the boot manager. + +KDE +KControl +lilo +boot configuration +booting + + + + +&liloconfig; + +Using this module, you can install lilo boot manager, add/remove/change boot password, change time till booting default OS, add/remove/change default OS, add/remove/change OS's, and more! + +In order to organize all of these options, this module is +divided into three sections: General Options, +Operating Systems, and Expert + +You can switch between the sections using the tabs at the top of +the window. + +If you are not currently logged in as a superuser, you +will need to click the Administrator Mode +Button. You will then be asked for a superuser password. Entering a +correct password will allow you to modify the settings of this +module. + + + +General Options + +From this page you can add/remove/change boot password, time till booting default OS, and more! + + + +Install boot record to drive/partition: + Select the drive or partition where you would like to install the Lilo boot loader. Unless you intend to use other boot managers in addition to LILO, this should be the MBR (master boot record) of your boot drive. In this case, you should probably select /dev/hda if your drive is IDE, and /dev/sda if your boot drive is SCSI. + + +Boot the default kernel/OS after: +Lilo will wait the specified time before booting default kernel/OS. + + +Use linear mode +Linear mode tells the boot loader the location of the kernels in linear addressing rather than sector/head/cylinder. Linear mode is required by some SCSI drives, and shouldn't hurt unless you are planning to create a boot disk to be used with other computers. See lilo man file for more details. + + +Use compact mode +The compact mode trys to merge read requests for adjacent sectors in to single read request. This reduces load time and keeps boot map smaller, but will not work on all systems. + + +Record boot command lines for defaults +Automatic recording of boot command lines as defaults for following boots. This way, lilo "locks" on a choice until manually overridden. + + +Restrict parameters +A password is required only if any parameters changed (i.e. the user can boot linux, but not linux single or linux init=/bin/sh). This sets a default for all Linux kernels you want to boot. If you need a per-kernel setting, go to Operating Systems tab, and select details. + + +Require password: +Enter the password for bootup (if any) here. If restricted (above) is checked, the password is required for additional parameters only. The password is stored in clear text in /etc/lilo.conf. You'll want to make sure nobody untrusted can read this file. Also, you probably don't want to use your normal/root password here. + + +Default graphics mode on text console: +You can select the default graphics mode here. If you intend to use a VGA graphics mode, you must compile the kernel with support for frame buffer devices. The ask setting brings up a prompt at boot time. This sets a default for all Linux kernels you want to boot. If you need a per-kernel setting, go to Operating Systems tab, and select details. + + +Enter LILO prompt automatically +If this box is checked, lilo goes to the lilo prompt whether or not a key is pressed. If it is turned off, lilo boots the default operating system unless shift is pushed (in that case, it goes to the lilo prompt). + + + + + +Operating Systems + +Some of the things that can be done here are: settings like General Options for specific kernels/OSes, set default OS to boot, probe for available kernels, you can also edit root file system, ramdisk settings, extra parameters, etc... + + + +Boot menu listbox +To the far left is a list of the kernels and operating systems you can currently boot. Choose the one you would like to edit. + + +Kernel: +Enter the filename of the kernel you would like to boot. Pushing the Select... will bring up &kde; standard fileselector to help you find the kernel. + + +Label: +Enter the label (name) of the kernel you want to boot here. + + +Root filesystem: +Enter the root filesystem for the kernel you would like to boot. Pushing the Select... will bring up &kde; standard fileselector to help you find the root filesystem. +Root filesystemIn this case, the root filesystem means the partition that will be mounted as / at boot time. + + + +Initial ramdisk: +If you want to use an initial ramdisk (initrd) for this kernel, enter its filename here. Leave this field blank if you do not intend to use an initial ramdisk for this kernel. + + +Extra parameters: +Enter an extra parameters you wish to pass kernel. Usually this can be left blank. This can the append option in lilo.conf. + + +Set Default +Boot this kernel if the user doesn't make a different choice. + + +Details +This brings up a dialog box with further, less commonly used, options. + + +Probe +Automaticly generate a (hopefully) reasonable lilo.conf for your system. + + +Check Configuration +Run LILO in test mode to see if the configuration is ok. + + +Add Kernel... +Add a new Linux kernel to the boot menu. + + +Add Other OS... +Add non-Linux OS to boot menu. + + +Remove Entry +Remove entry from boot menu. + + + + + + +Expert +In this page you can edit the /etc/lilo.conf file. +Do not edit this file so unless you know what you are doing! + + +
-- cgit v1.2.3