diff options
Diffstat (limited to 'extra/arandr/arandr-0.1.3/README')
-rw-r--r-- | extra/arandr/arandr-0.1.3/README | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/extra/arandr/arandr-0.1.3/README b/extra/arandr/arandr-0.1.3/README new file mode 100644 index 000000000..c0a4db154 --- /dev/null +++ b/extra/arandr/arandr-0.1.3/README @@ -0,0 +1,139 @@ +========================== +ARandR: Another XRandR GUI +========================== + + +Design intent +------------- + +Provide a simple visual front end for XRandR_ 1.2, client side X only (no xorg.conf involved, no pre-1.2 options). + + + +Features +-------- + +* Full controll over positioning (instead of plain "left of") with edge snapping +* Saving configurations as executable shell scripts (configurations can be loaded without using this program) +* Configuration files can be edited to include additional payload (like xsetwacom_ commands tablet PC users need when rotating), which is preserved when editing +* Metacity keybinding integration: + * Saved configurations can be bound to arbitrary keys via metacity's custom commands. + * Several layouts can be bound to one key; they are cycled through. (Useful for "rotate" buttons on tablet PCs.) +* Main widget separated from packaged application (to facilitate integration with existing solutions) + + + +Status +------ + +Works with recent X servers supporting XRandR 1.2 or 1.3 (which is 1.2 compatible). + +See TODO_ for planned features. + + + +Installation +------------ + +* Using your distribution's instaler: + + * Debian_ / Ubuntu_:: + + aptitude install arandr + + * archlinux using a PKGBUILD_ on AUR:: + + yaourt -S arandr + + * Slackware using a `slackbuild by PhantomX`_:: + + wget http://cloud.github.com/downloads/PhantomX/slackbuilds/arandr.tar.bz2 + tar xjf arandr.tar.bz2 + cd arandr + ./arandr.SlackBuild 2>&1 | tee build.log + +* From source: + + * Fetch either + + * the `latest release`_:: + + wget http://christian.amsuess.com/tools/arandr/files/arandr-0.1.3.tar.gz + tar xzf arandr-0.1.3.tar.gz + cd arandr-0.1.3 + + * or get it directly from GIT (`hosted on gitorious`_):: + + git clone git://gitorious.org/arandr/arandr.git + cd arandr + + * and start it using:: + + ./arandr + + * or install it:: + + sudo ./setup.py install + + + +Dependencies +------------ + + * python_ + * PyGTK_ + * xrandr_ + * docutils_ (>=0.6; for building the man page) + + + +Bugs / Caveats +-------------- + + * Changes while running are not caught. + * Depends on all modes to have a <width>x<height> name. + + +Contributing +------------ + +If you are fluent with languages not yet supported, you can add translations to ARandR using gettext_. An easy way to do this is `ARandR's transifex site`_. + +Please send bug reports, suggestions, patches and git pull requests to me_. + + +About +----- + +Copyright © chrysn_ <chrysn@fsfe.org> 2008–2010, published under GPLv3_ or any later version. + +Inspired by the `dual head sketch`_ in the ThinkWiki_. + +Translations by + +* Quizzlo (Italian) +* Phantom X (Brasilian) +* Joe Hansen (Danish) +* gundachandru (Kannada) +* chrysn (German, English) + + + .. _XRandR: http://www.x.org/wiki/Projects/XRandR + .. _xsetwacom: http://linuxwacom.sourceforge.net/index.php/howto/xsetwacom + .. _TODO: ./TODO + .. _`latest release`: http://christian.amsuess.com/tools/arandr/files/arandr-0.1.3.tar.gz + .. _PKGBUILD: http://aur.archlinux.org/packages.php?ID=17385 + .. _chrysn: http://christian.amsuess.com + .. _GPLv3: http://www.gnu.org/licenses/gpl-3.0.txt + .. _`dual head sketch`: http://www.thinkwiki.org/wiki/Image:Intel-DualHead.png + .. _ThinkWiki: http://thinkwiki.org/ + .. _`hosted on gitorious`: http://gitorious.org/arandr/arandr + .. _Debian: http://packages.debian.org/arandr + .. _Ubuntu: http://packages.ubuntu.com/arandr + .. _gettext: http://www.gnu.org/software/gettext/ + .. _`ARandR's transifex site`: https://transifex.net/projects/p/arandr/c/main/ + .. _me: mailto:chrysn@fsfe.org + .. _python: http://www.python.org/ + .. _PyGTK: http://www.pygtk.org/ + .. _`slackbuild by PhantomX`: http://github.com/PhantomX/slackbuilds/tree/master/arandr/ + .. _docutils: http://docutils.sourceforge.net/ |