Updated man pages for idesk-0.5.x.

6 files changed, 314 insertions, 8 deletions

diff --git a/x11-misc/idesk/ChangeLog b/x11-misc/idesk/ChangeLog
index 8ffde6ed4b34..80e20b99f2b8 100644
--- a/x11-misc/idesk/ChangeLog
+++ b/x11-misc/idesk/ChangeLog
@@ -1,6 +1,10 @@
 # ChangeLog for x11-misc/idesk
 # Copyright 2002-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2
-# $Header: /var/cvsroot/gentoo-x86/x11-misc/idesk/ChangeLog,v 1.10 2003/07/29 17:18:31 bcowan Exp $
+# $Header: /var/cvsroot/gentoo-x86/x11-misc/idesk/ChangeLog,v 1.11 2003/09/06 13:21:31 sergey Exp $
+
+  06 Sep 2003; Sergey Kuleshov <svyatogor@gentoo.org> idesk-0.5.5.ebuild,
+  idesk-0.5.6.ebuild, files/idesk05.1, files/ideskrc05.5:
+  Updated the man pages for idesk-0.5.x, thus closing bug #22646.
 
 *idesk-0.5.6 (29 Jul 2003)
 
diff --git a/x11-misc/idesk/Manifest b/x11-misc/idesk/Manifest
index 81ee1637d775..6ccf14eb2487 100644
--- a/x11-misc/idesk/Manifest
+++ b/x11-misc/idesk/Manifest
@@ -1,11 +1,11 @@
-MD5 60ad9409dfa6ff550246ba53005065ac ChangeLog 2154
+MD5 1488e32e61e8180ac586618cec4a393a ChangeLog 2353
 MD5 f8de31c89a7380eceb11c60515acebff idesk-0.3.3.ebuild 859
 MD5 572e3cfdac07d1ff0b31ac5f3b243b52 idesk-0.3.4.ebuild 859
 MD5 017942f1d9de5ac1878a390349ef5162 idesk-0.3.5-r1.ebuild 977
 MD5 d926b1071ee7d88b64b6b50e2b3a6c3f idesk-0.3.5-r2.ebuild 1110
 MD5 7df6b723463544f0b3fd8830e1870e8a idesk-0.3.5.ebuild 859
-MD5 cbd5087db9a7bee72bba1b9132c11b5e idesk-0.5.5.ebuild 1148
-MD5 6a2c3b6f060afa11535f2e87321c05af idesk-0.5.6.ebuild 1142
+MD5 29995012a5c0aa9523b408ba95dee82a idesk-0.5.5.ebuild 1146
+MD5 f5d6008b3d462b66d3acf130e7a28e87 idesk-0.5.6.ebuild 1139
 MD5 681d0e14514c589e16568398b9eeecd0 files/idesk05.1 4844
 MD5 2aae27b79a7df7030bfec00195d5a04c files/digest-idesk-0.3.3 61
 MD5 3ca11c23ec8a78f704507b8d75fee01f files/digest-idesk-0.3.4 61
diff --git a/x11-misc/idesk/files/idesk05.1 b/x11-misc/idesk/files/idesk05.1
new file mode 100644
index 000000000000..9d367cf207ca
--- /dev/null
+++ b/x11-misc/idesk/files/idesk05.1
@@ -0,0 +1,121 @@
+.TH "idesk" "1" "" "" ""
+.SH "NAME"
+Idesk \-\-  program that draws desktop icons.
+.SH "SYNOPSIS"
+Idesk is program that draws desktop icons. Each icon will execute a shell command when double\-clicked (set to single\-click by an option). The icons can be moved on the desktop by dragging them, and the icons will remember their positions on start\-up. Oh yea, forgot there is cool eye\-candy.
+                                                                                                               
+The icons can either be PNG (.png) or SVG (.svg) files. There are some problems with librsvg's usage of some svg files it seems. Most simple SVG files _cannot_ be loaded by librsvg. More investigation is needed to see what kind of SVG's work. See note in section 6.
+.SH "DEPENDENCIES"
+.TP 
+gdk\-pixbuf\-2
+.TP 
+pkg\-config     \- GNU autoconf and automake already have it I believe
+.TP 
+librsvg\-2.0.1  \- nautilus has this already I believe
+.TP 
+other gnome stuff \- if you have everything for librsvg then you should be good.
+                                                                                                           
+.SH "INSTALLING"
+Decompress and untar the tar.gz file into a directory. In that directory:
+.IP                                
+$> make
+.br 
+$> su
+.br 
+$> make install
+.LP 
+Make install will copy the executable\-binary file to /usr/local/bin/idesk.
+.SH "CONFIGURING"
+\fBSTEPS\fR
+.PP 
+\fB1.\fR Following the syntax described in \fIideskrc(5)\fR, create a file
+in your home directory named .ideskrc.
+.PP 
+\fB2.\fR Create a directory called .idesktop/ in your home directory. 
+.PP 
+\fB3.\fR Inside the new directory, create an icon file with the extension 'lnk'(e.g., home.lnk) as deescribed in \fILINKS FILES\fR section belw.
+.PP 
+\fB4.\fR Start idesk as described in \fIRUNNING\fR below, or kill and
+restart idesk if it's already running.
+.PP 
+\fB5.\fR Move your new icon to where you would like it to be, and verify
+it works correctly.
+.PP 
+\fB6.\fR Repeat steps 3\-5 for any additional icons you would like to have.
+.PP 
+\fB7.\fR After you have your icons finished and where you want them, change
+\fILocked\fR from 'false' to 'true' in .ideskrc.
+.PP 
+\fB8.\fR (optional) Add 'idesk' to your .xinitrc or other startup scripts to run it automatically.
+
+.SH "LINK FILES"
+In general link file will look like this:
+.IP 
+table Icon
+  Caption: Home
+  Command: nautilus /home/you
+  Icon: /home/you/.idesktop/home.png
+.br 
+end
+.LP                              
+These are the options for icon file, they should mostly be self\-explantory. The Icon option is the graphic file for the icon image (either a png file or a svg file). The Execute[i] action (in .ideskrc) runs the Command[i]. If the Caption field is blank or just one space, then no caption will be created for the icon.
+
+.IP                             
+table Icon
+  Caption: Tux
+  Icon: /home/you/icons/tux2.svg
+  Width: 600
+  Height: 700
+  X: 680
+  Y: 174
+  Command[0]: echo 'Linux rocks!'
+.br 
+end
+.LP                                                                                                                
+\fBImportant for SVG\fR
+.br 
+If you use a svg icon need to set Width and Height to your desired pixel size. Just make sure that the X value plus the width doesn't exceed your window diemensions, you get a segfault (same for Y value and height). It is best to set X and Y to zero to prevent this.
+.SH "DEFAULT USAGE"
+.TP 
+Double click with the first mouse button will run the command.
+.TP 
+Click and drag with the first mouse button moves the icon (if not locked).
+.TP 
+Double\-click with the middle mouse button reloads the icons and regenerates background. Useful after changing wallpapers to clear graphical artifacts.
+.TP 
+Double\-click with the right mouse button to toggle the lock state. The state will be saved in the config file, so it will be remembered next startup.
+.SH "RUNNING"
+Idesk runs as a background process.  One suggested way to start idesk is:
+.IP 
+nohup idesk > /dev/null &
+.PP 
+After Idesk is running, click on an icon to start whatever command you 
+assigned it.  Currently 'kill \-HUP' will terminate the program.  It is 
+required to restart idesk when you add new icons (.lnk files), unless
+you are running some other utility that runs on top of idesk, such as
+Fluxspace.
+
+You can reload existing .lnk files in ~/.idesktop/ by double middle\-clicking 
+on any icon.
+
+.SH "SEE ALSO"
+\fIideskrc(5)\fR
+
+.SH "BUGS"
+High\-Contrast currently not implemented. 
+.br 
+segfault if SVG image extends beyond window in config file
+.SH "PROGRAM AUTHORS"
+.IP 
+Chris Roberts (nikon) <nikon@sc.rr.com>
+.br 
+Bryn (curious) <curious@ihug.com.au>
+.br 
+Christopher Morris <cmorri9@lsu.edu>
+.br 
+Tim Finley <timmfin@timmfin.net>
+.SH "MANPAGE AUTHOR"
+.IP 
+Dylan Carlson <absinthe@gentoo.org>
+.br 
+Sergey Kuleshov <svyatogor@gentoo.org>
diff --git a/x11-misc/idesk/files/ideskrc05.5 b/x11-misc/idesk/files/ideskrc05.5
new file mode 100644
index 000000000000..6ccbdc39b990
--- /dev/null
+++ b/x11-misc/idesk/files/ideskrc05.5
@@ -0,0 +1,179 @@
+.TH "ideskrc" "5" "" "" ""
+.SH "NAME"
+ideskrc \- Configuration file for idesk(1)
+.SH "USAGE"
+The .ideskrc file needs to be placed in the root of your home directory.
+.SH "FORMAT"
+The structure of the file is as follows:
+.IP 
+table Config
+  <setting>: <value>
+.br 
+end
+table Actions
+  <operation_to_perform>: <action>
+.PP 
+Anything else in the file will be ignored.
+.SH "SETTINGS"
+\fBLocked\fR is boolean (true/false). Setting it to true disables the dragging movement.
+
+\fBTransparency\fR is between 0 (no glow effect) and 255 (invisible without a mouseover).
+
+\fBHighContrast\fR will draw a border around the text in the opposite colour if it is true.  It will draw it in an arbitary colour if it "#aa00aa", for example.  And it will not draw anything at all if it is set to "false".
+
+\fBShadow\fR is boolean (true/false). Turning this on will draw a drop shadow of color ShadowColor behind the text. The shadow will be ShadowX pixels right and ShadowY pixels down (negative values will work). Both ShadowX and ShadowY default to 1.
+
+\fBBold\fR is a boolean (true/false). Setting it to true will make your font bold.
+
+\fBClick Delay\fR is the number of milliseconds that represents a double\-click.
+
+\fBSingleClick\fR is a boolean (true/false). Setting it to true makes a single\-click execute the command associated with the icon. This also means that it is impossible to drag the icon either.
+
+\fBIconSnap\fR is a boolean (true/false). Setting it to true makes the icons snap to a grid defined by "SnapWidth" and "SnapHeight". The icon will snap to the middle of the rectangle defined by "SnapWidth" and "SnapHeight". So if "SnapWidth" = "SnapHeight" = 100, the center of the icon will by in multiples of 50: (50,50), or (50, 100), or (100, 100), or (250, 350)... You will want to make "SnapWidth" and "SnapHeight" greater than or equal to the size of the picture.
+
+\fBSnapWidth\fR and \fBSnapHeight\fR is a positive integer, see description in "IconSnap".
+
+\fBSnapOrigin\fR defines where the snap grip starts from. Valid values are: 
+  TopLeft, TopRight, BottomLeft, BottomRight.
+
+\fBSnapShadow\fR is a boolean (true/false) value. Setting it to true will make a shadow of the icon appear where the icon will snap if the drag was released there. Turn "IconSnap" on and check this out, pretty cool effect.  
+
+\fBSnapShadowTrans\fR is a integer between 0 (opaque) and 255 (invisible). It represents the transparency of the SnapShadow
+
+\fBCaptionOnHover\fR is a boolean (true/false) value. Setting it to true will make the icon's caption only appear when the mouse hovers over an icon. False is the default behavior.
+
+.SH "BETTER SNAP EXPLANATION"
+               .          .          .
+               .          .          .
+               |__________|__________|_______ . . .
+               |          |          |
+               |          |          |
+           y   |          |          |
+               |          |          |
+               |          |          |
+         [>    |__________|__________|________ . . .
+         |           x
+         |
+         |
+                                                                                                               
+This is the bottom left of the desktop (SnapOrigin: BottomLeft)
+                                                                                                               
+X represents the snap width
+Y represents the snap height
+Snap origin only describes which corner of the screen
+                                                                                                               
+So basically set snap width to the width of the "box" you want the icon contained in and set snap height to the height of the "box" you want the icon contained in.
+                                                                                                               
+The icon will snap to the middle of that box specified by snap width and snap height. You will typically want the width and heihgt to be a bit larger than the width and height of the icons (make the height bigger if you use a caption).
+.SH "ACTION CONFIGURATION"
+In the Action table 5 different actions can be configured.
+.IP 
+    \fBLock\fR:       Disables icon dragging to prevent accidental movement.
+
+    \fBReload\fR:     Reloads all of the config options and gets a new background.
+
+    \fBDrag\fR:       Puts the icon in drag mode. Icon follows cursor.
+
+    \fBEndDrag\fR:    End the drag mode, icon will be positioned at the cursor.
+
+    \fBExectue[i]\fR: Executes the ith icon command. So the Execute[0] action is the
+                default action and run Command[0] (in the icon config file),
+                Execute[1] runs Command[1] and so forth.
+.PP 
+The options for each command are as follows:
+.IP 
+    <shift> <control> <alt> [Button] [ClickType]
+    [Button] = left, middle, or right (more than one is allowed)
+    [ClickType] = singleClk, doubleClk, tripleClk, or hold
+.PP 
+\fBSome examples\fR
+.br 
+The default settings, should be self explanitory.
+.IP 
+Lock: right doubleClk
+.br 
+Reload: middle doubleClk
+.br 
+Drag: left hold  <== Drag starts when left button is pressed.
+.br 
+EndDrag: left singleClk <== Drag ends when left button is released.
+.br 
+Execute[0]: left doubleClk
+.PP         
+
+\fBOther examples\fR
+.br 
+Left single click while holding shift on the keyboard
+.br 
+Execute[0]: shift left singleClk
+
+Left double click while holding down the right mouse button.
+.br 
+Execute[0]: left doubleClk right hold
+
+And for those with too many fingers, middle double click while holding
+down the left and right mouse buttons, and control, alt, and shift
+on the keyboard.
+.br 
+Execute[0]: control shift alt left hold middle doubleClk right hold
+.IP  
+\fBNotes:\fR
+.br 
+For the Drag action I reccomend only doing button holds and for the
+EndDrag I recommend using single clicks. This way the icon begins
+dragging as soon as you press the button and stops dragging as soon
+as you release the button. Using other actions should work as expected,
+but there are a few small bugs.
+
+If two actions have the same key/button combinations they both will
+occur, unless one is the reload action. The reload action always only
+happens by itself.
+.SH "SEE ALSO"
+\fIidesk(1)\fR
+
+.SH "EXAMPLE"
+table Config
+  FontName: tahoma
+  FontSize: 8
+  FontColor: #ffffff
+  Locked: false
+  Transparency: 150
+  Shadow: true
+  ShadowColor: #000000
+  ShadowX: 1
+  ShadowY: 2
+  Bold: false
+  ClickDelay: 300
+  IconSnap: true
+  SnapWidth: 55
+  SnapHeight: 100
+  SnapOrigin: BottomRight
+  SnapShadow: true
+  SnapShadowTrans: 200
+  CaptionOnHover: false
+.br 
+end
+.br 
+table Actions
+  Lock: control right doubleClk
+  Reload: middle doubleClk
+  Drag: left hold
+  EndDrag: left singleClk
+  Execute[0]: left doubleClk
+  Execute[1]: right doubleClk
+.br 
+end
+.SH "PROGRAM AUTHORS"
+.IP 
+Chris Roberts (nikon) <nikon@sc.rr.com>
+.br 
+Bryn (curious) <curious@ihug.com.au>
+.br 
+Christopher Morris <cmorri9@lsu.edu>
+.br 
+Tim Finley <timmfin@timmfin.net>
+.SH "MANPAGE AUTHOR"
+.IP 
+Dylan Carlson <absinthe@gentoo.org>
+.br 
+Sergey Kuleshov <svyatogor@gentoo.org>
diff --git a/x11-misc/idesk/idesk-0.5.5.ebuild b/x11-misc/idesk/idesk-0.5.5.ebuild
index 0a5cbadfdc3e..b3aa8c9a0aae 100644
--- a/x11-misc/idesk/idesk-0.5.5.ebuild
+++ b/x11-misc/idesk/idesk-0.5.5.ebuild
@@ -1,6 +1,6 @@
 # Copyright 1999-2003 Gentoo Technologies, Inc.
 # Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/x11-misc/idesk/idesk-0.5.5.ebuild,v 1.4 2003/09/05 00:57:57 msterret Exp $
+# $Header: /var/cvsroot/gentoo-x86/x11-misc/idesk/idesk-0.5.5.ebuild,v 1.5 2003/09/06 13:21:31 sergey Exp $
 
 DESCRIPTION="Utility to place icons on the root window"
 HOMEPAGE="http://idesk.timmfin.net"
@@ -41,7 +41,8 @@ src_install() {
 	exeinto /usr/bin
 	doexe idesk
 	dodoc README
-	doman ${FILESDIR}/idesk.1 ${FILESDIR}/ideskrc.5
+	newman ${FILESDIR}/idesk05.1 idesk.1
+	newman ${FILESDIR}/ideskrc05.5 ideskrc.5
 }
 
 pkg_postinst() {
diff --git a/x11-misc/idesk/idesk-0.5.6.ebuild b/x11-misc/idesk/idesk-0.5.6.ebuild
index d557ce54726d..3a376eddeec0 100644
--- a/x11-misc/idesk/idesk-0.5.6.ebuild
+++ b/x11-misc/idesk/idesk-0.5.6.ebuild
@@ -1,6 +1,6 @@
 # Copyright 1999-2003 Gentoo Technologies, Inc.
 # Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/x11-misc/idesk/idesk-0.5.6.ebuild,v 1.2 2003/09/05 00:57:57 msterret Exp $
+# $Header: /var/cvsroot/gentoo-x86/x11-misc/idesk/idesk-0.5.6.ebuild,v 1.3 2003/09/06 13:21:31 sergey Exp $
 
 DESCRIPTION="Utility to place icons on the root window"
 HOMEPAGE="http://idesk.timmfin.net"
@@ -41,7 +41,8 @@ src_install() {
 	exeinto /usr/bin
 	doexe idesk
 	dodoc README
-	doman ${FILESDIR}/idesk.1 ${FILESDIR}/ideskrc.5
+	newman ${FILESDIR}/idesk05.1 idesk.1
+	newman ${FILESDIR}/ideskrc05.5 ideskrc.5
 }
 
 pkg_postinst() {