wok annotate amiwm/stuff/patches/amiwm-man.patch @ rev 21049

updated iniparser and iniparser-dev (3.1 -> 4.1)
author Hans-G?nter Theisgen
date Tue Mar 12 17:00:49 2019 +0100 (2019-03-12)
parents
children
rev   line source
pascal@20385 1 --- a/amiwm.1
pascal@20385 2 +++ b/amiwm.1
pascal@20385 3 @@ -1,6 +1,3 @@
pascal@20385 4 -.\" @(#)amiwm.1
pascal@20385 5 -'\"macro stdmacro
pascal@20385 6 -.nr X
pascal@20385 7 .TH amiwm 1 "19 Jul 2010"
pascal@20385 8 .SH NAME
pascal@20385 9 amiwm \- Amiga Workbench-like X Window Manager
pascal@20385 10 @@ -16,17 +13,17 @@
pascal@20385 11 .I Amiwm
pascal@20385 12 is configurable with a $HOME/\.amiwmrc-file containing some or all
pascal@20385 13 of the following options:
pascal@20385 14 -.SH FastQuit: {yes|no}
pascal@20385 15 +.SH FastQuit: {yes | no}
pascal@20385 16
pascal@20385 17 Specifies whether amiwm should quit directly when the Quit
pascal@20385 18 menu item is selected, rather than popping up a requester.
pascal@20385 19 (on/off or true/false can be used instead of yes/no.)
pascal@20385 20
pascal@20385 21 -.SH SizeBorder {right|bottom|both|none}
pascal@20385 22 +.SH SizeBorder {right | bottom | both | none}
pascal@20385 23
pascal@20385 24 Specifies which border should be enlarged when a sizegadget is present.
pascal@20385 25
pascal@20385 26 -.SH ForceMove {manual|auto|always}
pascal@20385 27 +.SH ForceMove {manual | auto | always}
pascal@20385 28
pascal@20385 29 Enables you to move windows outside the perimeter of the root window
pascal@20385 30 when pressing shift, when trying to drag at least 25% of the window
pascal@20385 31 @@ -41,59 +38,60 @@
pascal@20385 32 Gives the filename of the .info file to use as a default icon.
pascal@20385 33 It is relative to the IconDir.
pascal@20385 34
pascal@20385 35 -.SH IconPalette {system|magicwb|schwartz|\f1\*(lq\f3filename"}
pascal@20385 36 +.SH IconPalette {system | magicwb | schwartz | \(lqfilename\(rq}
pascal@20385 37
pascal@20385 38 Selects either the Workbench\*R default palette, or the MagicWorkbench
pascal@20385 39 standard palette for use with icons. The third option is a 16 color
pascal@20385 40 palette used on the "Eric Schwartz Productions CD Archive". Alternatively,
pascal@20385 41 the filename of a PPM file representing the palette to use can be used.
pascal@20385 42
pascal@20385 43 -.SH ScreenFont \f1\*(lq\f3fontname"
pascal@20385 44 +.SH ScreenFont \(lqfontname\(rq
pascal@20385 45
pascal@20385 46 Selects a font to use for windowtitles etc.
pascal@20385 47
pascal@20385 48 -.SH IconFont \f1\*(lq\f3fontname"
pascal@20385 49 +.SH IconFont \(lqfontname\(rq
pascal@20385 50
pascal@20385 51 Selects a font for icontitles.
pascal@20385 52
pascal@20385 53 -.SH {detailpen|blockpen|textpen|shinepen|shadowpen|fillpen|filltextpen|
pascal@20385 54 - backgroundpen|highlighttextpen|bardetailpen|barblockpen|
pascal@20385 55 - bartrimpen} \f1\*(lq\f3colorname"
pascal@20385 56 +.SH {detailpen | blockpen | textpen | shinepen | shadowpen | fillpen | filltextpen | backgroundpen | highlighttextpen | bardetailpen | barblockpen | bartrimpen} \(lqcolorname\(rq
pascal@20385 57
pascal@20385 58 Modifies the colour scheme for the window manager.
pascal@20385 59
pascal@20385 60 -.SH CustomIconsOnly {yes|no}
pascal@20385 61 +.SH CustomIconsOnly {yes | no}
pascal@20385 62
pascal@20385 63 This prevent applications to display their own icons when in iconified state.
pascal@20385 64 Only icons defined in amiwmrc for each apps will be used.
pascal@20385 65 Because apps own icon are too different from one eachother.
pascal@20385 66 They comes in various sizes and themes. Some icons will be 32x32,
pascal@20385 67 -while some other will be a 128x128 or even bigger .. By using this option,
pascal@20385 68 +while some other will be a 128x128 or even bigger. By using this option,
pascal@20385 69 You have the possibility to decide which icon should be used for each app.
pascal@20385 70 If no custom icons are defined at all, the def_tool.info will be used for
pascal@20385 71 -all iconified apps. Format is: style { class "myClass" icon "myIcon.info" }
pascal@20385 72 +all iconified apps. Format is:
pascal@20385 73 +.nf
pascal@20385 74 +style { class "myClass" icon "myIcon.info" }
pascal@20385 75 +.fi
pascal@20385 76 To find out a given program's class, use "xlsclients -l" to list all opened
pascal@20385 77 applications, and then use "xprop -id <0x0000000>" to list a
pascal@20385 78 given app's properties. Use either WM_CLASS or WM_ICON_NAME strings in amiwmrc.
pascal@20385 79
pascal@20385 80 -.SH ShortLabelIcons {yes|no}
pascal@20385 81 +.SH ShortLabelIcons {yes | no}
pascal@20385 82
pascal@20385 83 This limit the length of the text for iconified programs. For example, if this
pascal@20385 84 option is activated, an iconified program text will be limited to 8 chars + ".."
pascal@20385 85 Use this option if you don't want iconified program text to be loong strings..
pascal@20385 86
pascal@20385 87 -.SH TitleBarClock {yes|no}
pascal@20385 88 +.SH TitleBarClock {yes | no}
pascal@20385 89
pascal@20385 90 Enables a clock in the titlebar. It displays the date and time.
pascal@20385 91
pascal@20385 92 -.SH TitleClockFormat [<number>] "time string"
pascal@20385 93 +.SH TitleClockFormat [<number>] \(lqtime string\(rq
pascal@20385 94
pascal@20385 95 This lets you choose a new format to display the Title Bar Clock.
pascal@20385 96 The time string is formatted with the standard strftime() parameters.
pascal@20385 97 The default is "%c". It has been found that "%a %b %e %Y %l:%M %p" works
pascal@20385 98 well too. Number is the update interval in seconds.
pascal@20385 99
pascal@20385 100 -.SH ToolItem \f1\*(lq\f3name" \f1\*(lq\f3command" \f1\*(lq\f3hotkey"
pascal@20385 101 +.SH ToolItem \(lqname\(rq \(lqcommand\(rq \(lqhotkey\(rq
pascal@20385 102
pascal@20385 103 Adds an item in the Tools menu with the specified name, which executes
pascal@20385 104 the command when selected. A string containing a single uppercase letter
pascal@20385 105 @@ -104,26 +102,26 @@
pascal@20385 106
pascal@20385 107 Inserts a separator bar in the Tools menu.
pascal@20385 108
pascal@20385 109 -.SH ToolItem \f1\*(lq\f3name" { <tool item commands>}
pascal@20385 110 +.SH ToolItem \(lqname\(rq { <tool item commands>}
pascal@20385 111
pascal@20385 112 Create ToolItem:s in a submenu with the specified name. It is not legal
pascal@20385 113 to create a submenu inside another submenu.
pascal@20385 114
pascal@20385 115 -.SH Screen [<number>] \f1\*(lq\f3name"
pascal@20385 116 +.SH Screen [<number>] \(lqname\(rq
pascal@20385 117
pascal@20385 118 Create a new screen with the specified name. It will be placed below all
pascal@20385 119 earlier created screens. To move a window between two screens, iconify it
pascal@20385 120 and drag the icon over to the other screen. If the second argument is given,
pascal@20385 121 this screen is placed on the corresponding X screen.
pascal@20385 122
pascal@20385 123 -.SH ModulePath \f1\*(lq\f3path(:path...)"
pascal@20385 124 -
pascal@20385 125 +.SH ModulePath \(lqpath(:path...)\(rq
pascal@20385 126 +
pascal@20385 127 Sets one or more directories where amiwm will look for module binaries.
pascal@20385 128 The default is AMIWM_HOME. Note that the module binaries cannot be
pascal@20385 129 shared amongst different architectures.
pascal@20385 130 -
pascal@20385 131 -.SH Module \f1\*(lq\f3name" ["initstring"]
pascal@20385 132 -
pascal@20385 133 +
pascal@20385 134 +.SH Module \(lqname\(rq ["initstring"]
pascal@20385 135 +
pascal@20385 136 Start a module with the specified name. If initstring is specified, it
pascal@20385 137 is sent to the module. There are currently two modules shipped with
pascal@20385 138 amiwm; Background and Keyboard. These are documented in the file
pascal@20385 139 @@ -131,16 +129,16 @@
pascal@20385 140 Background module, the screen that was created last is used.
pascal@20385 141
pascal@20385 142 .SH InterScreenGap number
pascal@20385 143 -
pascal@20385 144 +
pascal@20385 145 Sets the size in number of pixels of the "video DMA off" area that appears
pascal@20385 146 between screens when they are dragged.
pascal@20385 147 -
pascal@20385 148 -.SH AutoRaise {yes|no}
pascal@20385 149 -
pascal@20385 150 +
pascal@20385 151 +.SH AutoRaise {yes | no}
pascal@20385 152 +
pascal@20385 153 Selects whether windows will automatically be moved to the front when
pascal@20385 154 they are activated.
pascal@20385 155
pascal@20385 156 -.SH Focus {followmouse|sloppy|clicktotype}
pascal@20385 157 +.SH Focus {followmouse | sloppy | clicktotype}
pascal@20385 158
pascal@20385 159 Sets the policy by which windows are given focus. Followmouse is the
pascal@20385 160 default and means that the window that contains the mouse pointer will
pascal@20385 161 @@ -158,7 +156,7 @@
pascal@20385 162 sure that either 'make install' runs successfully (in which case
pascal@20385 163 amiwm will know where its icon is), or that the file .amiwmrc
pascal@20385 164 contains a correct specification of the icon's location.
pascal@20385 165 -
pascal@20385 166 +
pascal@20385 167 .SH FILES
pascal@20385 168 .nf
pascal@20385 169 $HOME/.amiwmrc