mlvwmrc/README.md

154 lines
6.0 KiB
Markdown
Raw Normal View History

2019-01-05 17:53:46 +00:00
# mlvwmrc
by Morgan Aldridge <morgant@makkintosshu.com>
## OVERVIEW
This a set of configuration files for Takashi HASEGAWA's [Macintosh-like Virtual Window Manager (MLVWM)](https://github.com/morgant/mlvwm) with the following goals:
2019-01-05 17:53:46 +00:00
- More accurate emulation of [System 7](https://en.wikipedia.org/wiki/System_7) and [MacOS 8](https://en.wikipedia.org/wiki/Mac_OS_8) User Interfaces
- A complete configuration out-of-the-box
- Well structured configuration files
MLVWM includes a very rudimentary set of rc ([run command](https://en.wikipedia.org/wiki/Run_commands)) files and requires a fair amount of customization to better emulate Macintosh operating systems' UI. Additionally, since it is generally no more than a hobbyist window manager, no appropriate structure for the rc files (esp. for individual applications), icons (i.e. pixmaps), etc. Last, but not least, I wanted to reduce the amount of configuration needed every time I configure MLVWM on a new workstation.
## PREREQUISITES
* `mlvwm`
* `xpm`
* `locale`
* `curl`
* `make`
2019-01-05 17:53:46 +00:00
## USAGE
Run `make && make install` to install `.mlvwmrc` and `.mlvwm/` in your home directory, including downloading appropriate icons.
## TESTING
It's a good idea to test your `mlvwm` configuration prior to attempting to use it as your default window manager for the first time or after making any changes. The easiest way to do this is using `Xephyr`. I do the following:
Xephyr :32 -screen 1024x768 &
DISPLAY=:32 mlvwm -debug
The above will run `mlvwm` in a window, so you can test within your existing environment and easily troubleshoot or kill it if something goes wrong.
## SUGGESTED ADDITIONAL CONFIGURATION
### GTK+ 3
Some of the included configurations are for GTK+ 3 applications which use [client-side decorations (CSD)](https://en.wikipedia.org/wiki/Client-side_decoration), resulting in window controls being included in the "header bar". These window controls already exist in the `mlvwm` window title bars, so are redundant and look out of place. They can be disabled by editing `~/.config/gtk-3.0/settings.ini` to set `gtk-decoration-layout` to a blank string (or [customize](https://docs.gtk.org/gtk3/property.Settings.gtk-decoration-layout.html) as you see fit), for example:
```
\[Settings\]
gtk-decoration-layout=""
```
### iDesk
Companion [iDesk](https://idesk.sourceforge.net/) configuration files are available via the [mlvwmrc-ideskrc](https://github.com/morgant/mlvwmrc-ideskrc) project.
## APPLICATIONS
Configurations for the following X11 applications are included:
2020-04-27 15:15:37 +00:00
* [ARandR](https://christian.amsuess.com/tools/arandr/)
* [Basilisk II](http://basilisk.cebix.net/)
* [Chromium](https://www.chromium.org/)
2021-07-17 17:31:00 +00:00
* [Clementine](https://www.clementine-player.org/)
* [Firefox](https://www.getfirefox.com/)
* [HandBrake](https://handbrake.fr/)
2020-02-27 03:47:49 +00:00
* [Krita](https://krita.org/)
* [Meld](http://meldmerge.org/)
* [PCManFM](https://en.wikipedia.org/wiki/PCMan_File_Manager)
2022-07-10 15:03:32 +00:00
* [RetroArch](https://www.retroarch.com/)
2022-06-14 16:11:41 +00:00
* [Remmina](https://remmina.org/)
* [VLC](https://www.videolan.org/vlc/)
2022-07-10 22:22:19 +00:00
* [Xarchiver](https://github.com/ib/xarchiver)
* Xcalc
* Xclock
* [Xephyr](https://www.freedesktop.org/wiki/Software/Xephyr/)
* Xload
* Xmag
* Xmessage
* [Xosview2](http://xosview.sourceforge.net/)
2022-10-07 18:44:38 +00:00
* Xterm
* [Xwf](https://github.com/morgant/xwf)
2022-10-07 18:44:38 +00:00
* [Zutty](https://github.com/tomszilagyi/zutty)
2020-03-06 16:38:15 +00:00
## MENU EXTRAS
Configurations for the following X11 applications are included for use in the menu bar:
* [mlclock](https://github.com/morgant/mlclock)
* Xclock
* Xload
Configurations for additional applications and utilities are also available from the following separate projects:
* [OpenBSD APM (Advanced Power Management)](https://github.com/morgant/mlvwmrc-openbsd-apm)
* [Xosview2 mini graphs](https://github.com/morgant/mlvwmrc-xosview2)
* [x11vnc Menu Extra](https://github.com/morgant/mlvwmrc-x11vnc)
## DATA STRUCTURE
MLVWM loads its configuration from `~/.mlvwmrc`, but to break configuration up into more logical and manageable chunks within a `~/.mlvwm/` directory. That directory contains its own `.mlvwmrc` file which `~/.mlvwmrc` gets symlinked to, and it takes advantage of the `Read` command (see [mlvwm/CONFIGURATION](https://github.com/morgant/mlvwm/blob/master/CONFIGURATION)) to import the remaining configuration files.
The current structure is:
~/
.mlvwmrc -> .mlvwm/.mlvwmrc
.mlvwm/
.mlvwmrc
.initrc
.restartrc
MenuBar
VirtualDesktops
theme/
System7
MacOS8
MacOS9
MenuExtras/
xload
apps/
.AppManifest
Xterm
Xcalc
pixmap/
*.xpm
### .mlvwmrc
The main `rc` file. It contains some important configuration settings & commands, esp. `IconPath`, but primarily loads other `rc` & configuration files. The active theme can be changed by editing the `Read .mlvwm/theme/System7` line to one of the other theme files.
### .initrc
Contains an `InitFunction` block which can be modified to run commands upon initialization of MLVWM.
### .restartrc
Contains a `RestartFunction` block which can be modified to run commands upon init or reload of MLVWM.
### VirtualDesktops
Contains configuration settings for virtual desktops, incl. the number of virtual desktops (default is 1.)
### MenuBar
Contains the default menu bar configuration. Note: the Apple menu is actually defined in the theme files as some theme-specific settings need to be applied during creation, incl. icons. For this reason, the theme files _must_ be loaded prior to the default menu bar in `.mlvwmrc`.
### .AppManifest
Includes a `Read` command for each application-specific file in the `apps` directory. This is primarily to limit the complexity of the main `.mlvwmrc` file.
2019-01-05 17:53:46 +00:00
## SPECIAL THANKS
Many thanks to Takashi Hasegawa for creating [MLVWM](http://www2u.biglobe.ne.jp/~y-miyata/mlvwm.html) and Steffen Beyer for providing [Apple/Mac icons in .xpm format](http://sb.fluomedia.org/macintosh/).
2019-01-05 17:53:46 +00:00
## LICENSE
_TBD_
2019-08-03 00:56:46 +00:00
[Xosview icon](https://www.iconfinder.com/icons/9548/xosview_icon) by Oxygen Team.