mirror of
https://github.com/amiwm/amiwm.git
synced 2026-03-24 01:24:15 +00:00
e6f7a1bc17
The README file in this repo is called README.md and the old README.modules is now named MODULES.md. Changed references to those files (including in the man page) to reflect what is in the repo today.
194 lines
6.4 KiB
Groff
194 lines
6.4 KiB
Groff
.\" @(#)amiwm.1
|
|
'\"macro stdmacro
|
|
.nr X
|
|
.TH amiwm 1 "14 Jul 2017"
|
|
.SH NAME
|
|
amiwm \- Amiga Workbench-like X Window Manager
|
|
|
|
.SH SYNOPSIS
|
|
amiwm
|
|
|
|
.SH DESCRIPTION
|
|
.I amiwm
|
|
is an X Window manager that tries to make your workstation look like
|
|
an Amiga\*R.
|
|
|
|
.SH OPTIONS
|
|
.I Amiwm
|
|
is configurable with a $HOME/\.amiwmrc-file containing some or all
|
|
of the following options:
|
|
.SH FastQuit: {yes|no}
|
|
|
|
Specifies whether amiwm should quit directly when the Quit
|
|
menu item is selected, rather than popping up a requester.
|
|
(on/off or true/false can be used instead of yes/no.)
|
|
|
|
.SH SizeBorder {right|bottom|both|none}
|
|
|
|
Specifies which border should be enlarged when a sizegadget is present.
|
|
|
|
.SH ForceMove {manual|auto|always}
|
|
|
|
Enables you to move windows outside the perimeter of the root window
|
|
when pressing shift, when trying to drag at least 25% of the window
|
|
ofscreen, or always, respectively.
|
|
|
|
.SH IconDir path
|
|
|
|
Specifies a directory in which amiwm will look for icons.
|
|
|
|
.SH DefaultIcon name
|
|
|
|
Gives the filename of the .info file to use as a default icon.
|
|
It is relative to the IconDir.
|
|
|
|
.SH IconPalette {system|magicwb|schwartz|\f1\*(lq\f3filename"}
|
|
|
|
Selects either the Workbench\*R default palette, or the MagicWorkbench
|
|
standard palette for use with icons. The third option is a 16 color
|
|
palette used on the "Eric Schwartz Productions CD Archive". Alternatively,
|
|
the filename of a PPM file representing the palette to use can be used.
|
|
|
|
.SH ScreenFont \f1\*(lq\f3fontname"
|
|
|
|
Selects a font to use for windowtitles etc.
|
|
|
|
.SH IconFont \f1\*(lq\f3fontname"
|
|
|
|
Selects a font for icontitles.
|
|
|
|
.SH {detailpen|blockpen|textpen|shinepen|shadowpen|fillpen|filltextpen|
|
|
backgroundpen|highlighttextpen|bardetailpen|barblockpen|
|
|
bartrimpen} \f1\*(lq\f3colorname"
|
|
|
|
Modifies the colour scheme for the window manager.
|
|
|
|
.SH CustomIconsOnly {yes|no}
|
|
|
|
This prevent applications to display their own icons when in iconified state.
|
|
Only icons defined in amiwmrc for each apps will be used.
|
|
Because apps own icon are too different from one eachother.
|
|
They comes in various sizes and themes. Some icons will be 32x32,
|
|
while some other will be a 128x128 or even bigger .. By using this option,
|
|
You have the possibility to decide which icon should be used for each app.
|
|
If no custom icons are defined at all, the def_tool.info will be used for
|
|
all iconified apps. Format is: style { class "myClass" icon "myIcon.info" }
|
|
To find out a given program's class, use "xlsclients -l" to list all opened
|
|
applications, and then use "xprop -id <0x0000000>" to list a
|
|
given app's properties. Use either WM_CLASS or WM_ICON_NAME strings in amiwmrc.
|
|
|
|
.SH ShortLabelIcons {yes|no}
|
|
|
|
This limit the length of the text for iconified programs. For example, if this
|
|
option is activated, an iconified program text will be limited to 8 chars + ".."
|
|
Use this option if you don't want iconified program text to be loong strings..
|
|
|
|
.SH TitleBarClock {yes|no}
|
|
|
|
Enables a clock in the titlebar. It displays the date and time.
|
|
|
|
.SH TitleClockFormat [<number>] "time string"
|
|
|
|
This lets you choose a new format to display the Title Bar Clock.
|
|
The time string is formatted with the standard strftime() parameters.
|
|
The default is "%c". It has been found that "%a %b %e %Y %l:%M %p" works
|
|
well too. Number is the update interval in seconds.
|
|
|
|
.SH BatteryInfo {yes|no}
|
|
|
|
This lets you display battery information on the menu bar.
|
|
It reqiures a module (such as Battery) to gather current battery status
|
|
and push it into amiwm to display.
|
|
|
|
.SH ToolItem \f1\*(lq\f3name" \f1\*(lq\f3command" \f1\*(lq\f3hotkey"
|
|
|
|
Adds an item in the Tools menu with the specified name, which executes
|
|
the command when selected. A string containing a single uppercase letter
|
|
may be specified as the third argument, making this letter a hotkey for the
|
|
item.
|
|
|
|
.SH ToolItem Separator
|
|
|
|
Inserts a separator bar in the Tools menu.
|
|
|
|
.SH ToolItem \f1\*(lq\f3name" { <tool item commands>}
|
|
|
|
Create ToolItem:s in a submenu with the specified name. It is not legal
|
|
to create a submenu inside another submenu.
|
|
|
|
.SH Screen [<number>] \f1\*(lq\f3name"
|
|
|
|
Create a new screen with the specified name. It will be placed below all
|
|
earlier created screens. To move a window between two screens, iconify it
|
|
and drag the icon over to the other screen. If the second argument is given,
|
|
this screen is placed on the corresponding X screen.
|
|
|
|
.SH ModulePath \f1\*(lq\f3path(:path...)"
|
|
|
|
Sets one or more directories where amiwm will look for module binaries.
|
|
The default is AMIWM_HOME. Note that the module binaries cannot be
|
|
shared amongst different architectures.
|
|
|
|
.SH Module \f1\*(lq\f3name" ["initstring"]
|
|
|
|
Start a module with the specified name. If initstring is specified, it
|
|
is sent to the module. There are currently two modules shipped with
|
|
amiwm; Background and Keyboard. These are documented in the file
|
|
MODULES.md. If a module is limited to a single screen, like the
|
|
Background module, the screen that was created last is used.
|
|
|
|
.SH InterScreenGap number
|
|
|
|
Sets the size in number of pixels of the "video DMA off" area that appears
|
|
between screens when they are dragged.
|
|
|
|
.SH AutoRaise {yes|no}
|
|
|
|
Selects whether windows will automatically be moved to the front when
|
|
they are activated.
|
|
|
|
.SH Focus {followmouse|sloppy|clicktotype}
|
|
|
|
Sets the policy by which windows are given focus. Followmouse is the
|
|
default and means that the window that contains the mouse pointer will
|
|
have focus. Sloppy means that the window that had focus last will keep
|
|
it when the pointer is not over a window. ClickToType is the original AmigaOS
|
|
policy in which you have to explicitly give focus to windows by clicking
|
|
in them.
|
|
|
|
|
|
.SH TROUBLESHOOTING
|
|
|
|
The most likely reason for amiwm to crash is if it
|
|
can't find its default icon, or if this is not accepted as a
|
|
*.info file. If this happens, amiwm _will_ dump core. So make
|
|
sure that either 'make install' runs successfully (in which case
|
|
amiwm will know where its icon is), or that the file .amiwmrc
|
|
contains a correct specification of the icon's location.
|
|
|
|
.SH CONFIGURATION FILES
|
|
.nf
|
|
$HOME/.amiwmrc
|
|
$AMIWM_HOME/system.amiwmrc
|
|
.fi
|
|
|
|
.SH COPYRIGHT NOTICES
|
|
This program is distributed as freeware. The copyright remains with
|
|
the author. See the file LICENSE for more information.
|
|
Amiga and Workbench are registered trademarks of AMIGA International Inc.
|
|
|
|
.SH ORIGINAL AUTHOR
|
|
Marcus Comstedt,
|
|
.I marcus@mc.pp.se
|
|
|
|
.SH CONTRIBUTORS
|
|
|
|
Scott Lawrence,
|
|
.I amiwm10@umlautllama.com
|
|
|
|
Nicolas Sipieter,
|
|
.I freeeaks@gmail.com
|
|
|
|
redsPL,
|
|
.I reds@sakamoto.pl
|