summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorKevin Chabowski <kevin@kch42.de>2014-07-27 23:07:15 +0200
committerKevin Chabowski <kevin@kch42.de>2014-07-27 23:07:15 +0200
commitbfa8c2a9d76834c4ae434210ed03caf8ea07c5cb (patch)
treed8175def7eef93651df4c61dca03d088f9a559ae /README.markdown
parentb6450973bdfbd6eee3f972cf57e2b4425faf3d24 (diff)
downloadstartpage-bfa8c2a9d76834c4ae434210ed03caf8ea07c5cb.tar.gz
startpage-bfa8c2a9d76834c4ae434210ed03caf8ea07c5cb.tar.bz2
startpage-bfa8c2a9d76834c4ae434210ed03caf8ea07c5cb.zip
Background image will now be resized, if very large
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.markdown b/README.markdown
index 74f1feb..065645d 100644
--- a/README.markdown
+++ b/README.markdown
@@ -9,7 +9,7 @@ A simple start page with a background image from [/r/EarthPorn](http://www.reddi
## Configuration
-The startpage configuration is located in the file ~/.startpagerc. It is a list of commands. A command has a name and can optionally have parameters separated by spaces or tabs. A backspace `\\` will interpret the next charcter literally (can be used to escape whitespace, linebreaks and backspaces). Commands are separated by newlines.
+The startpage configuration is located in the file ~/.startpagerc. It is a list of commands. A command has a name and can optionally have parameters separated by spaces or tabs. A backspace `\` will interpret the next charcter literally (can be used to escape whitespace, linebreaks and backspaces). Commands are separated by newlines.
These commands are implemented:
@@ -38,6 +38,14 @@ Example:
set-earthporn-savepath /home/foobar/Pictures/earthporn
+### `set-maxdim`
+
+Sets the maximum width/height of an EarthPorn image. If the image is larger, it will be resized for the background (it will be saved in it's original size).
+
+Example:
+
+ set-maxdim 4000
+
## Running
If `$GOPATH/bin` is in your `$PATH`, you can run startpage with the command `startpage`. By default, startpage listens on port 25145. You can change that with a command line switch: `startpage -laddr :<port>` \ No newline at end of file