40 |
41 | #### Visor has a [new home](http://totalterminal.binaryage.com) and it is called **TotalTerminal** now.
42 |
43 | Don't worry it is still open-source and I will continue to support TotalTerminal in the future.
44 |
45 | ## Installation
46 |
47 | 1. **[Install SIMBL](http://www.culater.net/software/SIMBL/SIMBL.php)** and make sure you have latest SIMBL 0.9.x
48 | 2. Place Visor.bundle into `~/Library/Application Support/SIMBL/Plugins` (create this directory if it does not already exist)
49 | 3. Relaunch Terminal.app - You should now see the Visor Status Menu Item
50 | 4. Configure your keyboard trigger by selecting the Visor Status Menu Item -> `Visor Preferences ...` and edit your keyboard `hot-key`
51 |
52 | #### You can now trigger Visor with your hot-key from any application to get an instant terminal session.
53 |
54 | To hide Visor, you can either:
55 |
56 | * re-trigger with your key-combo
57 | * optionally, you can click off the Visor window
58 |
59 | ### Compatibility
60 |
61 | * **Visor 2.2** is tested to work with
62 | * SIMBL 0.9.x on Snow Leopard (both 32-bit and 64-bit)
63 | * SIMBL 0.8.x on Leopard (32-bit)
64 |
65 | * **Visor 2.1** is tested to work with
66 | * SIMBL 0.9.x on Snow Leopard (both 32-bit and 64-bit)
67 | * SIMBL 0.8.x on Leopard (32-bit)
68 |
69 | * **Visor 2.0** is tested to work with
70 | * SIMBL 0.8.x on Snow Leopard but Terminal.app has to be forced to run in 32-bit mode
71 | * SIMBL 0.8.x on Leopard
72 |
73 | * **Visor 1.9** is tested to work with
74 | * SIMBL 0.8.x on Leopard
75 |
76 | **[Where can I get older versions?](http://github.com/darwin/visor/downloads)**
77 |
78 | ## Source
79 |
80 | ### Installation from source
81 |
82 | #### Prerequisities:
83 |
84 | * [SIMBL](http://www.culater.net/software/SIMBL/SIMBL.php)
85 | * ruby + rubygems
86 | * XCode 3.2+
87 | * zip/unzip
88 |
89 | #### Custom installation steps:
90 |
91 | git clone https://github.com/darwin/visor.git
92 | cd visor
93 | rake
94 | rake install
95 |
96 | Feel free to [fork and contribute][contribute].
97 |
98 | Source code licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
99 |
100 | ## FAQ
101 |
102 | #### I like the idea, but I want to use Terminal.app features. Do you plan to support tabs/unicode/whatever?
103 | > Visor is just a light-weight plugin for Terminal.app (SIMBL). You should be able to use most of Terminal.app features with Visor. The only broken feature is "Windows Groups".
104 |
105 | #### Does Visor work on OSX 10.6 (Snow Leopard)?
106 | > 64-bit Terminal.app in Snow Leopard is supported by Visor 2.1 and later.
107 |
108 | #### Does Visor work on OSX 10.5 (Leopard)?
109 | > Leopard is supported by Visor 1.5 and later, the best version is Visor 2.1.
110 |
111 | #### Does Visor work on OSX 10.4 (Tiger)?
112 | > Tiger was supported by early Visors (pre 1.5). It was in the days when I was a young Windows hacker. I will never look back, so your only chance is to upgrade to (Snow) Leopard.
113 |
114 | #### How do I uninstall Visor?
115 | > Visor is a standard SIMBL plugin. Remove `Visor.bundle` from `~/Library/Application Support/SIMBL/Plugins`:
116 |
117 | rm -rf ~/Library/Application\ Support/SIMBL/Plugins/Visor.bundle
118 |
119 | > Or alternatively you can run `rake uninstall` task if you have a cloned git repo.
120 |
121 | #### Where are Visor settings stored?
122 | > Visor settings are stored with Terminal.app settings. You can `open ~/Library/Preferences/com.apple.Terminal.plist` and tweak the values (better to do this when Terminal.app is not running).
123 | If you have troubles with Visor settings or the generated Visor profile, delete this file and restart Terminal.app. The file will be recreated with default values.
124 |
125 | #### My Visor menu-bar icon is dimmed out. My hot-key doesn't work and just beeps. What's wrong?
126 | > There can be only one visor-ed terminal window in the system. If you close this terminal window (for example `Control+D` or typing exit in shell), Visor gets into the disabled state you are describing. Just open a new terminal window and it gets visor-ed again. You can do this for example by clicking on Terminal.app icon in the Dock.
127 |
128 | #### How can I open a new terminal window the old way, as a classic OSX window?
129 | > If there is a visor-ed terminal window (Visor menu-bar icon is active) every new terminal window will be opened as a classic OSX window. In other words, open at least two terminal windows. The second one will be classic terminal window for sure.
130 |
131 | #### How can I change the height of Visor?
132 | > Go to Terminal.app's Preferences -> Window -> Rows
133 |
134 | #### How can I stick Visor to left screen edge?
135 | > Look for the "Position" option in Visor Preferences and pick "Left-Stretch" window placement.
136 |
137 | #### How can I change the width of Visor?
138 | > By default Visor window stretches to the full screen width. Set some non-stretching positioning for Visor window in Visor Preferences, then Go to Terminal.app's Preferences -> Window -> Columns.
139 |
140 | #### Is it possible to show Visor only on a secondary monitor?
141 | > Go to Visor Preferences -> Screen
142 |
143 | #### Is it possible to see Visor on every Space?
144 | > Visor 1.6 does not respect Spaces settings ([Issue 52](http://code.google.com/p/blacktree-visor/issues/detail?id=52)). Visor 1.7+ forces its window to be visible on every space.
145 | You may disable this in Visor Preferences. Note: Spaces configuration for Terminal.app doesn't apply to the visor-ed terminal window, it is effective only for other (classic) terminal windows.
146 |
147 | #### I want to keep different preferences for Visor and other (classic) terminal windows. What is the best way manage this?
148 | > Well this was quite a pain point in older Visor releases. From Visor 2.0 there must be a profile in Terminal.app called "Visor". Visor-ed window always use the "Visor" profile for opening new tabs
149 | (regardless of "default profile" or "startup profile" settings in Terminal.app). To make your life easier Visor creates this profile for you if it does not exist and fills in Darwin's preferred Visor settings (black background with fine colors, 90% opacity).
150 |
151 | #### How can I revert to Darwin's Visor profile?
152 | > You can always delete (or better rename) the "Visor" profile and relaunch Terminal.app. Visor will then create a new "Visor" profile from scratch with Darwin's preferred settings.
153 |
154 | #### Do I need to install TerminalColours SIMBL with Visor?
155 | > No, TerminalColours is integrated into Visor 2.0 and later. My motivation was to allow people to get cool Visor colors out of the box (with generated Visor profile).
156 |
157 | #### Do I need to install CopyOnSelect SIMBL with Visor?
158 | > No, CopyOnSelect is integrated into Visor 2.0 and later. It is a configurable option in Visor Preferences (disabled by default).
159 |
160 | ## Changelog
161 |
162 | #### The original Visor 1.5 brought to you by Alcor ([Blacktree](http://blacktree.com)), kudos man!
163 |
164 | ### History
165 |
166 | * **v2.2** (26.09.2009) code name: **Stable Visor**
167 | * [[darwin][darwin]] fixed crash when [changing display settings](http://github.com/darwin/visor/issues/closed#issue/37) or [fast-switching user](http://github.com/darwin/visor/issues/closed#issue/38)
168 | * [[darwin][darwin]] fixed some [redrawing issues](http://github.com/darwin/visor/issues/closed#issue/33)
169 | * [[darwin][darwin]] using new API on Snow Leopard for returning focus to previous application (not using applescript => faster!)
170 | * [[darwin][darwin]] fixed rake tasks, xcodebuild might fail in some rare situations
171 |
172 | * **v2.1** (21.09.2009) code name: **Lovely Visor** <= [Google's QSB](http://code.google.com/p/qsb-mac/) codebase made this release possible!
173 | * [[darwin][darwin]] support for SIMBL 0.9.x
174 | * [[darwin][darwin]] 64-bit version for 64-bit Terminal.app in Snow Leopard
175 | * [[darwin][darwin]] embedded Visor preferences pane into Terminal.app Preferences Window
176 | * [[darwin][darwin]] you can activate Visor by double tapping Control key (disabled by default)
177 | * [[darwin][darwin]] generated Visor profile does not use bold bright fonts
178 | * [[darwin][darwin]] resetting window size is performed only in rare cases of visor reconfiguration (fixed [headaches with 'jumping lines'](http://github.com/darwin/visor/issues/closed#issue/27), also fixed [performance issue](http://github.com/darwin/visor/issues/closed/#issue/13))
179 | * [[darwin][darwin]] 'restore app key focus' applescript checks if app which has to be restored is still alive (prevents [reopening closed app when leaving Visor](http://github.com/darwin/visor/issues/closed#issue/8))
180 | * [[darwin][darwin]] removed dependency on QuartzCore.framework
181 | * [[darwin][darwin]] XCode project cleanup, executable now includes binaries for x86_64, i386 and ppc architectures
182 |
183 | * **v2.0.1** (11.09.2009)
184 | * [[darwin][darwin]] Fixed resizing issue ([Issue #22](http://github.com/darwin/visor/issues/closed#issue/22))
185 |
186 | * **v2.0** (06.09.2009) code name: **Snow Visor**
187 | * [[darwin][darwin]] Compatibility with OSX 10.6 (Snow Leopard)
188 | * [[ciaran][ciaran]+[evanphx][evanphx]+[darwin][darwin]] integrated [Terminal Colours SIMBL](http://ciaranwal.sh/2007/11/01/customising-colours-in-leopard-terminal)
189 | * [[darwin][darwin]] Visor uses profile "Visor" or creates a new one if it does not exist ([Issue 57](http://code.google.com/p/blacktree-visor/issues/detail?id=71), [Issue #19](http://github.com/darwin/visor/issues/closed#issue/19)).
190 | * [[darwin][darwin]] "Visor" profile is created with finest settings from Darwin's Visor profile including setup for Terminal Colours (black background with fine colors, 90% opacity)
191 | * [[darwin][darwin]] Visor stays hidden after Terminal.app launch (seamless experience when including Terminal.app into startup items)
192 | * [[genki][genki]+[darwin][darwin]] integrated [CopyOnSelect SIMBL](http://github.com/genki/terminalcopyonselect)
193 |
194 | * **v1.9.1** (14.04.2009)
195 | * [[darwin][darwin]] Fixed missing "Visor Preferences..." menu item (thanks [gestes](http://github.com/gestes)).
196 |
197 | * **v1.9** (14.04.2009)
198 | * [[darwin][darwin]] Fixed bottom window is off-screen in left-stretch/right stretch mode ([Issue 60](http://code.google.com/p/blacktree-visor/issues/detail?id=60)).
199 | * [[darwin][darwin]] Window size gets properly reset during switching Position in Preferences.
200 | * [[darwin][darwin]] Added "Full Screen" option into Positions in Preferences ([Issue 57](http://code.google.com/p/blacktree-visor/issues/detail?id=57)).
201 | * [[darwin][darwin]] Debug messages are not being logged in Release builds.
202 | * [[darwin][darwin]] Visor restores focus of previous app only in case of closing with hotkey or ESC key ([Issue 67](http://code.google.com/p/blacktree-visor/issues/detail?id=67)).
203 | * [[darwin][darwin]] Visor does not hang when trying to return focus to a hanging application ([Issue 64](http://code.google.com/p/blacktree-visor/issues/detail?id=64)).
204 | * [[darwin][darwin]] Going to an empty space no more triggers visor terminal to appear ([Issue 58](http://code.google.com/p/blacktree-visor/issues/detail?id=58)).
205 | * [[darwin][darwin]] Menu item changes title to "Hide Visor" when Visor is opened ([Issue 43](http://code.google.com/p/blacktree-visor/issues/detail?id=43)).
206 | * [[darwin][darwin]] Fixed: Switching Space let Visor show and hide in an infinite loop ([Issue 61](http://code.google.com/p/blacktree-visor/issues/detail?id=61)).
207 | * [[darwin][darwin]] Removed option "Main Screen" from Preferences/Screen ([Issue 59](http://code.google.com/p/blacktree-visor/issues/detail?id=59)).
208 | * [[darwin][darwin]] Removed pin icon, toggle added under status menu ([Issue 56](http://code.google.com/p/blacktree-visor/issues/detail?id=56)).
209 |
210 | * **v1.8.1** (05.03.2009)
211 | * [[darwin][darwin]] Fixed "NSUserDefaults setString:ForKey:" crash on startup (affected upgrading users from 1.7 to 1.8). Reported by [Kleinman][kleinman], thanks.
212 | * [[darwin][darwin]] Compilation from sources clears previous build folder (this could possibly make troubles for people developing Visor and then doing release [like me]).
213 |
214 | * **v1.8** (04.03.2009)
215 | * [[darwin][darwin]+[cglee][cglee]] Visor can be positioned to other screen edges. Also non-stretching mode is possible. See Position in Visor Preferences.
216 | * [[darwin][darwin]] Visor window can be pinned, so it doesn't auto-hide (see icon in the top-right window corner).
217 | * [[darwin][darwin]] Better behavior of confirmation sheets (Previously, sheet might appear on different space or might be hidden behind Visor window).
218 | * [[darwin][darwin]] Custom build from sources is marked as "Custom", no need to specify version.
219 |
220 | * **v1.7** (12.02.2009)
221 | * [[darwin][darwin]] Visor appears on every space by default. You may disable it in Visor Preferences.
222 | * [[darwin][darwin]] Visor is correctly hidden in fullscreen mode.
223 | * [[darwin][darwin]] Visor plays nicely when screen resolution changes.
224 | * [[pumpkin][pumpkin]] Fixed extra shadow under menu-bar.
225 | * [[blinks][blinks]] Fixed rake install task for case there is no SIMBL plugins directory.
226 |
227 | * **v1.6** (03.02.2009)
228 | * [[darwin][darwin]] Build infrastructure.
229 | * [[darwin][darwin]] It is possible to specify on which screen visor will appear - see preferences ([Issue 15](http://code.google.com/p/blacktree-visor/issues/detail?id=15)).
230 | * [[darwin][darwin]] Visor exits gratefully without locking UI ([Issue 50](http://code.google.com/p/blacktree-visor/issues/detail?id=50)).
231 | * [[darwin][darwin]] Visor becomes inactive when you close visor-ed terminal window or exit it's shell (fixes [Issue 10](http://code.google.com/p/blacktree-visor/issues/detail?id=10)).
232 | * [[darwin][darwin]] When inactive, Visor eats next coming terminal window (right click terminal.app icon and select "new window").
233 | * [[darwin][darwin]] Re-implemented window sliding animation using standard NSWindow functions, should fix weird bugs with mouse cursor state.
234 | * [[darwin][darwin]] Removed support for Quartz powered backgrounds (want simpler codebase!).
235 | * [[darwin][darwin]] Gentle terminal window hijacking (solves [Issue 5](http://code.google.com/p/blacktree-visor/issues/detail?id=5), [Issue 6](http://code.google.com/p/blacktree-visor/issues/detail?id=6) and related problems. What more? It properly enables [applescript automation in visor-ed terminal](http://onrails.org/articles/2007/11/28/scripting-the-leopard-terminal), which was my original motivation to get dirty with Visor internals).
236 | * [[darwin][darwin]] Whenever you open Visor window, it steals focus and you may start typing without touching mouse. Visor is a good guy and returns the focus back to original app when being hidden. I said ... don't touch that mouse!
237 | * [[torsten][torsten]] Fixed the "White Line Bug" ([Issue 16](http://code.google.com/p/blacktree-visor/issues/detail?id=16)).
238 | * [[torsten][torsten]] Added the option to hide Visor on Escape press. Press Shift+Escape, if you need a "Escape" in the Terminal.
239 | * [[torsten][torsten]] If you start Visor you get now initial focus. ([Issue 20](http://code.google.com/p/blacktree-visor/issues/detail?id=20)).
240 |
241 | * **v1.5a1** (Nov 2007?)
242 | * Leopard Support
243 |
244 | * **v1.2.1**
245 | * Fixed Choose File button
246 |
247 | * **v1.2**
248 | * Added Animation Speed Preferences
249 | * Added Transition Preferences for Slide and Fade (both optional)
250 | * Menu Item is optional
251 | * Fix for users with Dock on top left or right (Visor appears above the dock)
252 | * Fixes animation glitches from alternate unsupported version.
253 | * New icon
254 | * No longer forked code - one version.
255 |
256 | * **v1.1** (drparallax's unsupported version?)
257 | * Dismissing visor now 'slides up'
258 | * Options for animation
259 | * New icon
260 |
261 | * **v1.0**
262 | * Initial release
263 |
264 | ... hic sunt leones ...
265 |
266 | ## Links
267 |
268 | #### Source code
269 | * [sources are hosted at GitHub](http://github.com/darwin/visor)
270 |
271 | #### Original Visor 1.5
272 | * [Blacktree Homepage](http://blacktree.com)
273 |
274 | ### Articles
275 | * **[Donnez du style à votre terminal avec Visor](http://maxime.sh/2010/01/donnez-du-style-a-votre-terminal-avec-visor)** by Maxime
276 | * **[Quake like Terminal on Mac OS X: Visor Plugin](http://www.rngtng.com/2009/08/14/quake-like-terminal-on-mac-os-x-visor-plugin/)** by Tobi
277 | * **[Visor Terminal on Snow Leopard](http://www.metaskills.net/2009/8/18/visor-terminal-on-snow-leopard)** by Ken Collins
278 | * **[Getting Terminal Visor for OSX working with Snow Leopard](http://aralbalkan.com/2366)** by Aral Balkan
279 | * **[Re-enabling Visor in Snow Leopard](http://terrychay.com/blog/article/visor-in-snow-leopard.shtml)** by Terry Chay
280 | * Featured Project in **[Rebase #13](http://github.com/blog/346-github-rebase-13)**, thanks [qrush](http://github.com/qrush)!
281 |
282 | [darwin]: http://github.com/darwin
283 | [torsten]: http://github.com/torsten
284 | [pumpkin]: http://github.com/pumpkin
285 | [blinks]: http://github.com/blinks
286 | [cglee]: http://github.com/cglee
287 | [kleinman]: http://github.com/kleinman
288 | [genki]: http://github.com/genki
289 | [ciaran]: http://github.com/ciaran
290 | [evanphx]: http://github.com/evanphx
291 | [contribute]: http://github.com/darwin/visor
292 |
--------------------------------------------------------------------------------
/license.html:
--------------------------------------------------------------------------------
1 | This work is licensed under a Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 United States License.
--------------------------------------------------------------------------------
/partial.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
8 |
9 |
10 | 
13 | 19 | Visor provides a systemwide terminal window accessible via a hotkey, much like the consoles found in games such as Quake. 20 |
21 |22 | 25 | 26 | for Mac OS X 10.5 & 10.6 27 | 28 |
29 |