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