[Assorted-commits] SF.net SVN: assorted:[1396] configs/trunk/src
Brought to you by:
yangzhang
Menu
▾
▴
[Assorted-commits] SF.net SVN: assorted:[1396] configs/trunk/src
|
From: <yan...@us...> - 2009-05-07 07:44:41
|
Revision: 1396
http://assorted.svn.sourceforge.net/assorted/?rev=1396&view=rev
Author: yangzhang
Date: 2009-05-07 07:44:39 +0000 (Thu, 07 May 2009)
Log Message:
-----------
- added vim doc
- added dput.cf for ppa packaging
Added Paths:
-----------
configs/trunk/src/dput.cf
configs/trunk/src/vim/doc/ps_color.txt
configs/trunk/src/vim/doc/vimexplorer.txt
Added: configs/trunk/src/dput.cf
===================================================================
--- configs/trunk/src/dput.cf (rev 0)
+++ configs/trunk/src/dput.cf 2009-05-07 07:44:39 UTC (rev 1396)
@@ -0,0 +1,9 @@
+[my-ppa]
+fqdn = ppa.launchpad.net
+method = ftp
+incoming = ~yaaang/ubuntu/
+login = anonymous
+allow_unsigned_uploads = 0
+
+[DEFAULT]
+default_host_main = my-ppa
Added: configs/trunk/src/vim/doc/ps_color.txt
===================================================================
--- configs/trunk/src/vim/doc/ps_color.txt (rev 0)
+++ configs/trunk/src/vim/doc/ps_color.txt 2009-05-07 07:44:39 UTC (rev 1396)
@@ -0,0 +1,657 @@
+*ps_color.txt* PSC For Vim version 7.0 Last change: 23 Oct 2006
+
+
+PERSONAL COLOUR SWITCHER *ps_colour* *pscolor*
+
+
+Author: Pan, Shi Zhu. <see vim online for my e-mail>
+
+==============================================================================
+CONTENTS *psc* *psc-contents*
+
+ 1. Contents.....................|psc-contents|
+ 2. PSC Overview.................|psc-overview|
+ 3. PSC Installation.............|psc-usage|
+ 4. PSC Options..................|psc-options|
+ 5. PSC under colour term .......|psc-cterm|
+ 6. PSC FAQ and Tips ............|psc-faq|
+ 7. PSC Release notes............|psc-release-notes|
+ 8. PSC Todo List................|psc-todo|
+
+For release notes, please see the header of ps_color.vim
+
+==============================================================================
+PSC FEATURES OVERVIEW *psc-features* *psc-overview*
+
+ Features ~
+
+ . PSC is firstly a color scheme which have both dark and light
+ background styles.
+ . It can have the same appearance in [cterm] as in [gui].
+ . It is designed with gentle color to minimize fatigue of eye.
+ . It also works with other color schemes.
+ . Default foreground and background can easily be changed, it is more
+ configurable than most other color schemes
+ . Works with the optional tool reloaded.vim, can change the whole
+ color scheme in Hue,Saturation,Luminance color space.
+
+ Design Concern ~
+
+ At the first glance this colour scheme may look pretty 'dull', don't be
+ afraid, this is quite normal. Bear in mind that a text editor is not
+ a photo album, if a text editor looks exciting you may not be able to
+ stare at it for a long time.
+
+ Predefined Vim Syntax highlighting can be too colourful or contrasted so
+ that many programmers prefer to switch off the syntax highlighting at
+ work. That is not a good idea because you will lost the advantages of
+ syntax high-lighting. It is often the case that we have to work for
+ 300+ minutes, then I decide to do-it-myself.
+
+ Many user-defined color schemes in vim.sf.net tend to achieve low
+ contrast by having a strong color-cast, i.e., looks blueish or
+ yellowish or reddish. This does look comfortable at first, however,
+ any type of color-cast will cause the eyes less sensitive for
+ particular color after a long-time work session, and that's no good to
+ health.
+
+ Efforts had been made to ensure no color-cast for this scheme, all
+ elementary colours like RGB and CYMK are evenly used. Like TeX,
+ 'consistency' is the principle this color scheme based on. Default
+ values which hurt consistency are amended according to the vim script
+ syntax/hitest.vim
+
+ There are 3 parameters to describe a color: Hue, Saturation and
+ Brightness. In this color scheme, the saturation is low and the
+ brightness are designed to be very close to each other in order not to
+ fatigue our eyes after a whole day's programming work.
+
+ Portability ~
+
+ Different monitor settings led to different look. In this color
+ scheme, it is assumed that the monitor adjust at 6500k color
+ temperature with a good gamma curve. If you have a 9300k monitor or
+ if the gamma curve is not optimal, the appearance may be less
+ comfortable, use adobe gamma loader or similar tools to adjust
+ your monitor if your monitor do not have the option to change color
+ temperature and/or gamma curve.
+
+ Needless to say, VI is an editor originally designed to do edit tasks
+ in a text terminal, and VIM is an improved version of VI. Its a shame
+ that a color scheme cannot have a satisfactory appearance in cterm.
+ The cterm compatibility should be considered high priority when
+ designing ViM color scheme.
+
+ I had made much attempt to make support for 8-color terminals,
+ however, 8 colours is not enough to represent a color scheme. Finally
+ I end up making the cterm support for 16-color terminal. Have to say
+ sorry if the color scheme sucks in your 8-color terminal, I had tried
+ my best. More details about cterm please see |psc-cterm|.
+
+ *psc-about-background*
+ About the Background ~
+
+ We have talked about off-white backgrounds, any background which is
+ not black, grey or white should be changed constantly in order not to
+ make the eyes less sensitive to particular color. i.e., you can use
+ blue background on Monday, red background on Tuesday, green background
+ on Wednesday, but if you use blue background everyday, that's no good
+ to your health.
+
+ Now we talk about the brightness of the background. Why dark
+ background is preferred over others? There are many reasons, such as,
+ the monitor emits lower radiation for black background. You may have
+ lots of similar reasons...
+
+ But I'll talk about something you may not know:
+>
+ It is easier to distinguish foreground colours on a dark background
+ than on a light background.
+
+ At the same time, it is easier to distinguish background colours on
+ a light background than on a dark background.
+
+ We will mainly change foreground colours for syntax highlighting.
+<
+ Hence, we can reduce the contrast and saturation of the color in
+ a dark-background scheme, while retain the readability. Schemes with
+ white background usually comes with higher contrast and saturation.
+ This is probably the most important reason that the color scheme is
+ designed to be dark-background instead of light one.
+
+ Now we came to know, that change the foreground color is enough to
+ emphasis text in a dark background, while for a white background, we
+ need to change the font shape (bold or italic, etc.), or change the
+ background color to effectively emphasis the text. This is probably
+ the reason Vim default scheme has bold properties for highlighting
+ groups, because the default scheme is a light background one.
+
+ No one knows what color scheme is best for you, except yourself. Try!
+
+==============================================================================
+PSC INSTALLATION *psc-usage*
+
+ Step 1, Enable the color scheme ~
+
+ To use PSC is simple, just put ps_color.vim into your
+ [runtimepath]/colors and append the line >
+
+ colorscheme ps_color
+<
+ to your |.vimrc|. The [runtimepath] can be any directory listed in
+ |vimfiles|, normally your $HOME/.vim in Unix or $HOME/vimfiles in
+ Windows.
+
+ Step 2, Install the help document ~
+
+ The help document will be automatically installed when the colorscheme
+ be sourced the first time. If it is not, type :colo ps_color now.
+
+ After successfully installed the help document, you can use >
+
+ :help psc-options
+<
+ to go to the following section.
+
+==============================================================================
+PSC OPTIONS *psc-options*
+
+ You can let these options in your ~/.vimrc, most options works for
+ both GUI and cterm, only some of them do not work for both.
+
+ Options set using the 'let' command must present [BEFORE] the color
+ scheme been sourced.
+
+ *psc_style*
+ Style ~
+>
+ let psc_style='cool'
+ let psc_style='warm'
+ let psc_style='default'
+ let psc_style='defdark'
+<
+ This selects between styles of colors,
+ The 'cool' is the default, dark background.
+ The 'warm' is the alternative, light background scheme.
+
+ See |psc-about-background| for more knowledge about the background,
+ and the differences of two style.
+
+ The 'default' and 'defdark' refers to Vim system default color scheme.
+ Which are provided only for reference.
+
+ Let psc_style to any string other than the above 4 will switch to the
+ specified color scheme. For example, let psc_style='desert' and then
+ activate the ps_color, the color scheme will be chosen according to
+ desert.vim color scheme.
+
+ *psc_cterm_style*
+ Color Term Style ~
+>
+ let psc_cterm_style='cool'
+<
+ This is exactly the same to psc_style, except that it only affects the
+ console version of vim in a color terminal, the 'warm' is not
+ available for cterm.
+ By default, it will be set to the same value as 'psc_style'. You can
+ change it if you want different style in cterm from gui.
+
+ *psc_cterm_transparent*
+ Color Term Transparent ~
+>
+ let psc_cterm_transparent=1
+<
+ If this is set, cterm will use the transparent background.
+ i.e. the background will be the same as your terminal.
+ When background=dark, you should have a dark background for your
+ terminal, otherwise will result in poor readability.
+
+ If this is reset (the default), cterm will use the Black background
+ anyway.
+
+ *psc_fontface*
+ Font face ~
+>
+ let psc_fontface='plain'
+ let psc_fontface='mixed'
+<
+ The Vim default behavior is the 'mixed', however, the mixed font style
+ in a dark colorscheme is not optimal. This color uses 'plain' for
+ 'cool' style, i.e. No texts are bold font. For 'warm', the default
+ is still 'mixed', If you want the mixed style in which the highlighted
+ statements are bold font, choose this. If you want all texts be
+ bold, choose 'plain' and specify a bold guifont or terminal font.
+
+ In GUI, this option also works for other color schemes. You can
+ disable the bold font and use your favorite color scheme. See
+ |psc-faq-ffothers| for detail.
+
+ *psc_inversed_todo*
+ Inversed Todo ~
+>
+ let psc_inversed_todo=1
+<
+ When set to 1, the TODO group will be dark background with light font,
+ Otherwise, the TODO group have light background with dark foreground.
+ Default is 0.
+
+ *psc_use_default_for_cterm*
+ Use default for cterm (obsoleted)~
+
+ This option is Obsoleted, retained only for backward compatibility,
+ see |psc_cterm_style| for alternative.
+
+ *psc_statement_different_from_type*
+ Statement different from type ~
+>
+ let psc_statement_different_from_type=1
+<
+ The Statement-group and Type-group are easy to distinguish, different
+ color for them are not necessary, I use similar color for S-group
+ & T-group in order not to make the screen too 'colorful', also this
+ saves a color name for cterm. But if you do want the Statement & Type
+ to be different color, try 'let statement_different_from_type=1' in
+ your .vimrc file, which is available only for GUI. Since the color
+ names in cterm is limited to 16 we cannot have too many different
+ colors in cterm.
+ Default is 0, i.e. they have very similar color.
+
+ *psc-change-background*
+ Changing the Background color ~
+
+ You may prefer a black background over the dark one, and it is
+ possible to customize it, this may make life more interesting. To do
+ this is quite straight forward for GUI, just define the Normal
+ highlight in your .gvimrc, [AFTER] the color scheme has been sourced.
+
+ For example:
+>
+ highlight Normal guibg=#000000
+<
+ The #103040 will give a taste similar to oceandeep, #152535 for
+ hhazure, #303030 for desert, #404040 for zenburn... Replace #103040
+ with any color you like. You can do the same to guifg foreground if
+ you are careful enough, remember this is only possible for GUI.
+
+ You can do this to the NonText group also, for example.
+>
+ highlight NonText guibg=#202020
+<
+ will give you a taste similar to most color schemes on vim.sf.net, in
+ which the NonText has a different background than Normal text.
+ However, this is only useful in GUI, in cterm, there are only
+ 8 background colors, so it is wise not to have a different color.
+
+ If you want more variations, please try the optional utility
+ reloaded.vim, this optional utility provides an amazing level of
+ customization.
+
+ Quick switching between warm and cold styles ~
+
+ Here is an example to define hot key of different style switching,
+ note that I had only given this example without actually define it.
+ You can choose to define it in .vimrc or anyway you prefer.
+>
+ nnoremap <Leader>pc :let psc_style='cool'<CR>:colo ps_color<CR>
+ nnoremap <Leader>pw :let psc_style='warm'<CR>:colo ps_color<CR>
+<
+ Alternatively, you can use the capitalized :Colo command, like
+ :Colo cool or :Colo warm
+
+==============================================================================
+PSC WITH CTERM *psc-cterm*
+
+ Colour Term ~
+
+ The cterm color is designed mainly in these terminals:
+>
+ 1. Cygwin bash shell in NT command prompt box
+ 2. XTERM and RXVT
+ 3. Other color terminals which have at least 16 colors
+<
+ *psc-cterm-nt*
+ In Windows NT Prompt console you can change the exact value of each
+ color, so you can have the same color with your GUI version of Vim,
+ for 'cool' color style you just change the color according to the
+ |psc-cterm-color-table|, for how to redefine the color of Windows NT
+ prompt console please see Windows Help.
+
+ NT Cygwin bash shell console supports 16 foreground colors by add bold
+ attribute to 8 color, the cterm=bold specifies which should be bright
+ color, so totally the 16 color foreground is available, but color
+ name DarkXXX and LightXXX are the same.
+
+ The pre-configured Cygwin.lnk is available for download on my web page
+ for Vim, but the site seems down, and the my site would not be on
+ recently, you may need to change colors in the Properties menu...
+
+ Cygwin is highly recommended for Vim user if you are using Windows NT
+ based systems (e.g. NT 4.0, Win2k, WinXP, Win2003, etc). But Cygwin is
+ not that versatile under Windows 95/98/ME. I'm not sure whether this
+ works for DOS DJGPP or Windows 95 console version of Vim because
+ I don't have the system, in case you encountered problem please
+ contact me, if you like.
+
+ *psc-cterm-xterm*
+ XTERM is a much more feature-rich terminal than Windows Console so the
+ support is much better. Normally, add the following recommend line
+ into your .Xdefaults and you can achieve the same color as in GUI
+ version, currently only works for XTERM and RXVT.
+
+ However, most modern GUI terminal emulators do not read .Xdefaults
+ at all, in that case you will have to set the color manually according
+ to |psc-cterm-color-table|.
+
+ In case your term supports .Xdefaults, Add the following in it:
+>
+ XTerm*color0: #000000
+ XTerm*color1: #800000
+ XTerm*color2: #008000
+ XTerm*color3: #d0d090
+ XTerm*color4: #000080
+ XTerm*color5: #800080
+ XTerm*color6: #a6caf0
+ XTerm*color7: #d0d0d0
+ XTerm*color8: #b0b0b0
+ XTerm*color9: #f08060
+ XTerm*color10: #60f080
+ XTerm*color11: #e0c060
+ XTerm*color12: #80c0e0
+ XTerm*color13: #f0c0f0
+ XTerm*color14: #c0d8f8
+ XTerm*color15: #e0e0e0
+ XTerm*cursorColor: #00f000
+
+ ! The following are recommended but optional
+ XTerm*reverseVideo: False
+ XTerm*background: #202020
+ XTerm*foreground: #d0d0d0
+ XTerm*boldMode: False
+<
+ There is an assumption that your RXVT or XTERM supports 16 colors,
+ most RXVTs and XTERMs support this, if yours do not, get a source of
+ RXVT and recompile it.
+
+ Sometimes the color mode are not recognized well, or you do not want
+ bright foreground be bold. If this is the case, add the following in
+ your .vimrc (before the color scheme been sourced)
+>
+ if &term=='xterm' " Change 'xterm' to your term name if necessary
+ set t_Co=16
+ endif
+<
+ If the t_Co=16 have problem, set t_Co=8 and :colo ps_color again.
+ and vice versa.
+
+ My rxvt works well with t_Co=16: >
+ Rxvt v2.7.10 - released: 26 MARCH 2003
+ Options:
+ XPM,transparent,utmp,menubar,frills,linespace,multichar_languages,
+ scrollbars=rxvt+NeXT+xterm,.Xdefaults
+< But I've know that my rxvt v2.6.4 in another machine has problem with
+ t_Co=16, if that is the case, set t_Co=8 instead.
+
+ *psc-cterm-others*
+ For other terminals, you can manually set the color according to the
+ following table
+
+ Hints for Manually set the color (for 'cool' style only):
+ *psc-cterm-color-table*
+ Color name Hex value Decimal value (r,g,b)~
+ 0 Black = #000000 0,0,0
+ 4 DarkBlue = #000080 0,0,128
+ 2 DarkGreen = #008000 0,128,0
+ 6 DarkCyan = #a6caf0 166,202,240
+ 1 DarkRed = #800000 128,0,0
+ 5 DarkMagenta = #800080 128,0,128
+ 3 DarkYellow = #d0d090 208,208,144
+ 7 Grey = #d0d0d0 208,208,208
+ 8 DarkGrey = #b0b0b0 176,176,176
+ 12 Blue = #80c0e0 128,192,224
+ 10 Green = #60f080 96,240,128
+ 14 Cyan = #c0d8f8 192,216,248
+ 9 Red = #f08060 240,128,96
+ 13 LMag. = #f0c0f0 240,192,240
+ 11 Yellow = #e0c060 224,192,96
+ 15 White = #e0e0e0 224,224,224
+
+ *psc-cterm-incompatible*
+ If your color terminal does only have 8 colors and cannot achieve 16
+ colors with cterm=bold, you may want to switch to other color schemes
+ to gain more readability. Anyway, you can specify in your .vimrc to
+ use different color scheme under different consoles and GUI.
+ For example:
+>
+ let psc_cterm_style = 'foobarcolor'
+ let psc_style = 'cool'
+ colo ps_color
+<
+ The 'foobarcolor' means the color scheme you want to choose, such as
+ 'desert', I recommend to try vim default schemes 'default' and
+ 'defdark' before experience others.
+
+==============================================================================
+PSC FAQ AND TIPS *psc-faq* *psc-tips*
+>
+ Q: What is meant by `PS' ?
+<
+ A: PS means: PostScript, PhotoShop, PerSonal, ..., or anything you can
+ imagine and anything you want it do be.
+>
+ Q: How to obtain the same appreance as gui in color term?
+<
+ A: This need some work around, see |psc-cterm| for details.
+ Generally speaking, you should ensure your color term has support
+ for 16 foreground colors, and each color is customizable.
+
+ *psc-faq-ffothers* >
+ Q: How to use psc_fontface with other colorschemes?
+<
+ A: Make sure you had sourced :colo ps_color in your .vimrc, then you
+ can use the Capitalized :Colo instead of :colo
+ e.g. you want to use 'murphy', just type :Colo murphy after you
+ sourced the ps_color, the 'defdark', 'cool', 'warm' can also be
+ used here.
+>
+ Q: I updated from v2.0 to v2.3 or above, why the cterm color scheme
+ for Comment is different?
+<
+ A: The color map of DarkYellow and Yellow have been exchanged,
+ You need to reconfigure your terminal to meet the change,
+ see |psc-cterm-color-table| for guide, or if you are using xterm
+ compatible terminal, just update the .XDefaults according to
+ |psc-cterm-xterm|.
+>
+ Q: What do you mean by 'Vanilla Windows'?
+<
+ A: People often argue that Windows is not a REAL operating system.
+ Well, I agree this, but only for vanilla windows. i.e. with no
+ plug-ins installed. Vanilla windows is a very limited platform,
+ since it is not POSIX compliant.
+
+ There are currently many working around to make Windows POSIX
+ Compliant, do you still mind which OS to use when it is POSIX
+ Compliant? I don't. If you installed Cygwin kernel in your
+ NT-based Windows, the Windows will be more or less POSIX compliant
+ and you can use it in the same way as you use any Unix, BSD,
+ Solaris, Linux, XWindow, etc... What is more, Cygwin is not the
+ only kernel which makes Windows POSIX Compliant, make a google
+ search and you will find many alternatives.
+>
+ Q: How to change the Normal background color? Why don't you use
+ different background for NonText group?
+<
+ A: This is for compatibility, since we have to use only 8 colors as
+ background in a color terminal. For GUI you can change this, see
+ |psc-change-background| for details.
+>
+ Q: I updated from 2.81- to 2.82+, why the default background changed?
+<
+ A: This is for Bram's guideline, that dark schemes with black
+ background has too much contrast.
+
+ However, you can change it back. See |psc-change-background| for
+ details.
+>
+ Q: Something changed/doesn't work on 3.00...
+<
+ A: See 3.00 Release note.
+
+==============================================================================
+PSC RELEASE NOTES *psc-release-notes*
+
+ 3.00 Release Note: ~
+
+ GUI: now we accept the &background instead of the "warm" and "cool"
+ style value. So the "warm" and "cool" for psc_style are silently
+ ignored, all users must set the 'background' option manually before
+ :colo ps_color.
+
+ Since this is an incompatible change, I bump the version to 3.00
+
+ CTERM: if psc_style set to 'warm', the v2.90 before will set the style
+ to 'cool', the 3.00 will set the style to 'default' since the
+ background change are eliminated in 3.00. So basically, if you had the
+ background=light in your color terminal, :color ps_color will have
+ little effect.
+
+ Since the background setting can be wrong in cterm, the transparent
+ background are not the default. We added |psc_cterm_background| option
+ to change the bahavior.
+
+ Checked spell with spelllang=en, changes in typos for document.
+
+ 2.95 Release Note: ~
+
+ GUI: Make many foregrounds and backgrounds transparent, in most cases you
+ will not notice any difference. But you may feel better in some rare
+ case.
+
+ CTERM: if your terminal has a transparent background, then we can have
+ the transparent background in vim. Note that the terminal color scheme
+ has to be dark-background for maximum portability. If you have
+ a light-background terminal emulator and want to use ps_color color
+ scheme, please keep v2.90, or change your terminal background color to
+ a dark one.
+
+ 2.90 Release Note: ~
+
+ Upon the release of Vim 7, many new highlight groups have been added.
+
+ A style has been tuned a little to increase contrast.
+
+
+ 2.83 Release Note: ~
+
+ This is an identical version, but my e-mail address changed.
+
+
+ 2.82 Release Note: ~
+
+ Fixed bug with the reversed group for the Vim default, or other
+ schemes.
+
+ Fixed bug with the Diff mode fg mistaken as fg.
+
+ Shrink the script a lot to improve load performance, moved the release
+ notes into document.
+
+ Change the default gui background color to #202020 (Dark Grey)
+
+
+ 2.81 Release Note: ~
+
+ Provided a separate utility reloaded.vim to fine tune the GUI color
+ scheme based on Hue, Saturation and Brightness(Luminance).
+
+ Added some groups to meet the need of reloaded.vim, no essential
+ change.
+
+ 2.8 Release Note: ~
+
+ Bugfix : when psc_style=='mixed', the visual got reversed wrong.
+
+ 'mixed' is now the default for 'warm' style.
+
+ changed the function name to lower case.
+
+ removed pre-2.0 compatibility, (the non-psc version of s-d-f-t).
+
+ Added variable psc_cterm_style, see |psc_cterm_style|
+
+ Added group Underline
+
+ Tuned the function call.
+
+ 2.7 Release Note: ~
+
+ Now it is possible to change the Background,
+ see :h psc-change-background for details.
+
+ Linked the Tag group to Identifier.
+
+ NonText as Notice is not good for 'warm', changed to Constant.
+
+ Added links for the most popular plug-ins: taglist, calendar
+
+ Tuned the 'Statement' color when different from Type (gui only).
+
+ Re-adjusted cterm scheme according to syntax/hitest.vim
+
+ The 'defdark' style for cterm is not functioning, fixed.
+
+ Many 'cosmetic' changes, makes no difference for functionality.
+
+ Use of DrChip's help extractor to auto-install help document.
+
+ Added command define, :Colo
+
+ 2.6 Release Note: ~
+
+ As stated in the v2.3, the only 'todo' thing seems to be the 'warm'
+ style, now in this version I had been working on it.
+
+ There also are some minor fixes for the document, to be more friendly
+ for new readers.
+
+ The 'StatusLine' of 'cold' style is modified by mistake in the v2.3,
+ this time the bug is fixed.
+
+ The 'Directory' in GUI 'cold' style is different from 'cterm' one,
+ now fixed.
+
+ 2.3 Release Note: ~
+
+ This is an incompatible update, main changes are in 'cterm'.
+ A new group 'SignColumn' had been added, new links added for engspchk
+ v52, hundreds of typos fixed in the document, thanks to the engspchk.
+
+ The support for 8-color cterm is slightly better now, but the mappings
+ of the DarkYellow and Yellow are exchanged, you need to update the
+ .Xdefaults or your terminal configuration before apply this update if
+ you are using v2.0. Guide for redefinition the color value is
+ available in the document, make sure you had updated the ps_color.txt,
+ then see |psc-cterm-color-table|
+
+ 2.0 Release Note: ~
+
+ There have been great enhancement since this version, so I'd choose to
+ bump the version number to 2. This version comes with Vim online help,
+ if you had installed ps_color.txt, you can see for details in
+ |pscolor|
+
+ n/a Release: ~
+
+ Initial upload, can be called as v1.8
+
+
+==============================================================================
+PSC TODO LIST *psc-todo*
+
+ . Fix the remain bugs.
+ . Follow the new Vim versions for new added highlighting group
+ . This cannot work in Vim Small and Tiny mode, and will never work!
+
+==============================================================================
+
+vim:tw=78:ts=8:noet:ft=help:fo+=t:norl:noet:
Added: configs/trunk/src/vim/doc/vimexplorer.txt
===================================================================
--- configs/trunk/src/vim/doc/vimexplorer.txt (rev 0)
+++ configs/trunk/src/vim/doc/vimexplorer.txt 2009-05-07 07:44:39 UTC (rev 1396)
@@ -0,0 +1,542 @@
+*VimExplorer* A powerful file manager v0.98
+
+
+ VimExplorer Reference Manual
+ by Ming Bai (mbbill AT gmail.com)
+
+
+==============================================================================
+CONTENTS *VimExplorer-contents*
+
+1. Intro.......................................|VimExplorer-start|
+2. Functionality...............................|VimExplorer-functionality|
+ 2.1 Tree Panel Hotkeys.....................|VimExplorer-treehotkey|
+ 2.2 File Panel Hotkeys.....................|VimExplorer-filehotkey|
+ 2.3 Commands...............................|VimExplorer-commands|
+3. Directory Browsing..........................|VimExplorer-browse|
+ 3.1 Tree Browsing..........................|VimExplorer-treebrowse|
+ 3.2 File Browsing..........................|VimExplorer-filebrowse|
+ 3.3 Forward and Backward...................|VimExplorer-forbackward|
+ 3.4 Favorites..............................|VimExplorer-favorite|
+ 3.5 Temp Marks.............................|VimExplorer-tempmark|
+4. Marks.......................................|VimExplorer-mark|
+ 4.1 Single File Marks......................|VimExplorer-marksingle|
+ 4.2 Visual Marks...........................|VimExplorer-markvisual|
+ 4.3 Regexp Marks...........................|VimExplorer-markregexp|
+5. File operations.............................|VimExplorer-fileoperation|
+ 5.1 Create.................................|VimExplorer-new|
+ 5.2 Move...................................|VimExplorer-move|
+ 5.3 Delete.................................|VimExplorer-delete|
+ 5.4 Diff...................................|VimExplorer-diff|
+ 5.5 Search.................................|VimExplorer-search|
+ 5.6 Other Operations.......................|VimExplorer-otherfileopt|
+6. Other Functionalities.......................|VimExplorer-otherfuncs|
+7. Customization...............................|VimExplorer-customize|
+ 7.1 Normal Options.........................|VimExplorer-custnormal|
+ 7.2 Hotkey Customization...................|VimExplorer-custhotkey|
+ 7.3 Command Customization..................|VimExplorer-custcommand|
+8. The Author..................................|VimExplorer-author|
+9. Problems and Fixes..........................|VimExplorer-problems|
+10. Changelog...................................|VimExplorer-changelog|
+11. TODO........................................|VimExplorer-todo|
+
+
+==============================================================================
+1. Intro *VimExplorer-start*
+
+What is VimExplorer ?
+VimExplorer is a file manager, it can do a lot of file operations such as
+copy, delete, move, preview, search and so on. Also it has a variety of other
+capacities and customization abilities.
+
+You can start VimExplorer by the following command:
+>
+ :VE
+<
+Then it will ask you for the starting directory, default is the current path.
+>
+ VimExplorer (directory): /home/username/
+<
+You can change it to some other directories or just push "Enter" to start it.
+
+The second approach to start VimExplorer:
+>
+ :VE [directory]
+<
+Example:
+>
+ :VE /usr/src/
+<
+Now, VimExplorer will start using the path '/usr/src/'. When you are typing
+the path, <tab> and <ctrl-d> will help you to complete the path automatically.
+After all of these operations, you can see a new tab which has two panels
+within it, one is the "Tree Panel" and the other is "File Panel". From now you
+will have a happy journey using the powerful file manager.
+
+
+==============================================================================
+2. Functionality *VimExplorer-functionality*
+
+2.1 Tree Panel Hotkeys *VimExplorer-treehotkey*
+
+Member of |VEConf_treeHotkey|, refer to section 7.2 .
+
+Mapping Key Description~
+help ? Help.
+toggleNode <cr> Open/Close/Switch to current node.
+toggleNodeMouse <2-LeftMouse> Open/Close/Switch to current node.
+refresh r Refresh the tree panel.
+favorite f View favorite folder list.
+addToFavorite F Add the folder under cursor to
+ favorite list. If no path under
+ cursor, use current working path.
+browseHistory b View browse history.
+toggleFilePanel t Toggle the file panel.
+toUpperDir <bs> Go to upper directory.
+switchPanel <c-tab> Switch to File Panel.
+gotoPath <c-g> Change to another path.
+quitVE Q Quit VimExplorer.
+
+2.2 File Panel Hotkeys *VimExplorer-filehotkey*
+
+Member of |VEConf_fileHotkey|, refer to section 7.2 .
+
+Mapping Default Description~
+help ? Help.
+itemClicked <cr> Enter the directory or open the file
+ by default association.
+itemClickMouse <2-LeftMouse> Enter the directory or open the file
+ by default association.
+refresh r Refresh.
+toggleTreePanel t Toggle the Tree Panel.
+toggleModes i Toggle file sort mode (type/data/file
+ extension).
+newFile +f Create a new file.
+newDirectory +d Create a new directory.
+switchPanel <c-tab> Switch to the Tree Panel.
+quitVE Q Quit VimExplorer.
+toggleHidden H Toggle show hidden files.(files start
+ with '.')
+search g/ Search.
+markPlace m{a-z} Put current path to register(a-z).
+gotoPlace '{a-z} Jump to path in register(a-z).
+viewMarks J View path in register.
+toUpperDir <bs> Go to upper directory.
+gotoForward <c-i> Forward.
+gotoBackward <c-o> Backward.
+favorite f View favorite folder list.
+addToFavorite F Add the folder under cursor to
+ favorite list. If no path under
+ cursor, use current working path.
+browseHistory b View browse history.
+gotoPath <c-g> Change to another path.
+rename R Rename the file under cursor.
+yankSingle yy Copy file under cursor.
+cutSingle xx Cut file under cursor.
+showYankList yl Show clipboard.
+deleteSingle dd Delete file under cursor.
+openPreview u Preview.
+closePreview U Close the preview panel.
+toggleSelectUp <s-space> Move the cursor up and mark/unmark the
+ file under cursor.
+toggleSelectDown <space> Mark/unmark the file under cursor and
+ move the cursor down.
+markViaRegexp Mr Mark via regular expression.
+markVimFiles Mv Mark all vim files.
+markDirectory Md Mark all directories.
+markExecutable Me Mark all executable files.
+clearSelect Mc Clear all marks.
+deleteSelected sd Delete marked files.
+yankSelected sy Copy marked files.
+cutSelected sx Cut marked files.
+tabViewMulti se Edit every marked file in separate
+ tabs.
+paste p Paste.
+diff2files = Diff two files.
+tabView e Edit file in new tab.
+openRenamer ;r Open Renamer (Note 1)
+startShell ;c Start a shell from current path.
+startExplorer ;e Start another file
+ manager(nautilus,konquer,explorer.exe).
+
+Visual Mode Hotkeys~
+visualSelect <space> Mark files.
+visualDelete d Delete files.
+visualYank y Copy files.
+visualCut x Cut files.
+tabView e View files in new tabs.
+
+2.3 Commands *VimExplorer-commands*
+>
+ VE
+<
+Start VimExplorer.
+
+>
+ VEC
+<
+Close VimExplorer, Hotkey |Q| has the same ability.
+
+==============================================================================
+3. Directory Browsing *VimExplorer-browse*
+
+3.1 Tree Browsing *VimExplorer-treebrowse*
+
+Press "Enter" on one tree node will change the path and add the new path to
+browse history. By default, if a directory has it's own child directories, |+|
+will be displayed before it's name, and It will cause a little performance
+lost. If you don't need this feature ,set the following variable to zero can
+disable it.
+>
+ let VEConf_showFolderStatus = 0
+<
+There are some differences between win32 and other platforms. In win32, there
+are several root nodes (such as C:\,D:\), but one root node (/) in other
+platforms.
+
+3.2 File Browsing *VimExplorer-filebrowse*
+
+The file panel consist of two parts: the path in the top and the following
+file list. Every line of the file list consist from the following regions:
+
+[*] {file-name} [file-size] {permission} {modify-time}
+
+The file panel can sort by type, file name and date. Hotkey |i| is used to
+cycle between these modes. Default sort mode controlled by following variable:
+>
+ VEConf_filePanelSortType
+
+<
+See Customization section for more details.
+
+3.3 Forward and Backward *VimExplorer-forbackward*
+
+When using "Enter" switch to an new folder, the path will be add to browse
+history. Then you can use |<c-o>| and |<c-i>| to go backward and forward.
+Hotkey |b| is used to list all browse history, select by number or mouse can
+take you directory to that path.
+
+By default, the depth of browse history is 100. Controled by this variable:
+>
+ VEConf_browseHistory
+<
+
+3.4 Favorites *VimExplorer-favorite*
+
+The favorite folder list is saved to the file $HOME/.ve_favorite . It will be
+updated when new folder is added to favorite by hotkey |F|. The format of
+".ve_favorite" is very simple: every line is a path, so edit it is quite
+easy.
+
+3.5 Temp Marks *VimExplorer-tempmark*
+
+Just like the favorites, |ma| put current path into register 'a', and |'a| can
+jump to the path. |J| is used to list every non empty register. All paths in
+register will disappear after VimExplorer exists.
+
+==============================================================================
+4. Marks *VimExplorer-mark*
+
+The simplest way is to press <space> upon a file. There will be a '*' before
+marked files and also be displayed in a different color.
+There are three way to mark files:
+
+4.1 Single File Marks *VimExplorer-marksingle*
+
+<space> Invert selection, move the cursor down.
+<s-space> Move the cursor up, then invert selection.
+Just like most of vim commands, 5<space> will mark 5 files start from current
+cursor.
+
+4.2 Visual Marks *VimExplorer-markvisual*
+
+<space> in visual mode will invert selected these files.
+
+4.3 Regexp Marks *VimExplorer-markregexp*
+
+Hotkey: |Mr|
+Only the file name is the target of regexp match. Example:
+>
+ Mark file (regexp): ^abc.*\.vim$
+<
+It will mark all vim scripts start with abc. The following functionalities is
+derived from this feature:
+|Mv| mark all vim scripts.
+|Me| mark all executable files.
+|Md| mark all directories.
+and |Mc| to clear all marks.
+
+==============================================================================
+5. File Operations *VimExplorer-fileoperation*
+
+5.1 Create *VimExplorer-new*
+
+|+f| and |+d| is used to create new files and directories.
+
+5.2 Move *VimExplorer-move*
+
+There are several hotkey used to copy/cut files:
+|yy| and |sy| in normal mode ,|y| in visual mode is to copy file.
+|xx| and |sx| in normal mode ,|x| in visual mode is to cut file.
+|p| paste file.
+Note that the clipboard is shared between all VimExplorers ,you can cut in one
+VE tab and paste in another.
+If you want to view the clipboard, |yl| can be help.
+
+5.3 Delete *VimExplorer-delete*
+
+|dd| in normal mode and |d| in visual mode. Feel good?
+
+5.4 Diff *VimExplorer-diff*
+
+|=| is used to diff 2 files, so make sure you have selected 2 files before
+using this command.
+
+5.5 Search *VimExplorer-search*
+
+Just like / ,but the pattern here is not the regexp in vim, it will be
+expended by shell.
+
+5.6 Other Operations *VimExplorer-otherfileopt*
+
+|e| |R| |u| and so on ... Refer to section 2.2
+
+==============================================================================
+6. Other Functionalities *VimExplorer-otherfuncs*
+
+|;r| |;c| |;e| and so on ...Rever to section 2.2
+
+==============================================================================
+7. Customization *VimExplorer-customize*
+
+7.1 Normal Options *VimExplorer-custnormal*
+
+Common Options~
+
+|g:VEConf_systemEncoding| It controls the encoding of vim calling
+ function system(). If your system encoding
+ is different from '&encoding', set this
+ value to system encoding. Example: let
+ g:VEConf_systemEncoding = 'utf-8'
+ ,Default: '' (empty)
+
+|g:VEConf_win32Disks| The default value is all 26 volumes. Set this
+ value to fit your system can increase the
+ startup speed. If you are not using
+ Microsoft Windows, ignore it. Example:
+ let VEConf_win32Disks =
+ ["A:","B:","C:","D:"]
+
+|g:VEConf_browseHistory| Depth of browse history. Default: 100
+
+|g:VEConf_previewSplitLocation| Split location of preview panel. Optional
+ parameters are:
+ "belowright","topleft","leftabove","botright".
+ Default: "belowright"
+
+|g:VEConf_showHiddenFiles| Show hidden files, 1: show,0: hide. Default: 1
+
+|g:VEConf_externalExplorer| Name of the external file explorer. You can
+ set this value according to you system.
+ Default: "explorer.exe"(win32) "nautilus"
+ (gnome)
+
+|g:VEConf_sortCaseSensitive| 0: not case sensitive 1: case sensitive
+ Default: 1
+
+|g:VEConf_favorite| Favorite folder file name. Always stored in
+ $HOME. Default: ".ve_favorite"
+
+|g:VEConf_overWriteExisting| Ask when over write existing files.
+ 0: ask 1: always over write 2: always
+ not over write Default: 0
+
+|g:VEConf_usingKDE| If set to 1, use "kfmclient"
+|g:VEConf_usingGnome| If set to 1, use "gnome-open"
+
+Tree Panel Options~
+
+|g:VEConf_showFolderStatus| It controls show '+' before the folders which
+ have their own child folders. If it is set
+ to 1, every folder will have a '+'.
+ Default: 1
+
+|g:VEConf_treePanelWidth| Width of tree panel. Default: 30
+
+|g:VEConf_treePanelSplitMode| Split mode of tree panel. Default: "vertical"
+
+|g:VEConf_treePanelSplitLocation| Split location of tree panel, Optional
+ parameters: "belowright" , "topleft" ,
+ "leftabove" , "botright", Default:
+ "leftabove"
+
+|g:VEConf_treeSortDirection| Sort direction. 1: A-Z 0: Z-A. Default: 1
+
+File Panel Options~
+
+|g:VEConf_fileGroupSortDirection| Sort direction. 1: A-Z 0: Z-A, Default: 1
+
+|g:VEConf_fileDeleteConfirm| Confirm when deleting a file. 1: confirm 2:
+ no confirm. Default: 1
+
+|g:VEConf_filePanelWidth| Width of file panel. Default: 40
+
+|g:VEConf_filePanelSplitMode| Split mode of file panel. Default: "vertical"
+
+|g:VEConf_filePanelSplitLocation| Split location of file panel, Optional
+ parameters: "belowright" , "topleft" ,
+ "leftabove" , "botright" ,Default:
+ "leftabove"
+
+|g:VEConf_filePanelSortType| File sort type. 1: sort by name 2: sort by
+ time 3: sort by type, Default: 3
+
+|g:VEConf_showFileSizeInMKB| 1: Show file size in MKB format. 0: always
+ show file size in byte.
+
+|g:VEConf_filePanelFilter| Filter of the file panel, which will be
+ passed to glob() function. Example:
+ let g:VEConf_filePanelFilter = '*.txt'
+
+7.2 Hotkey Customization *VimExplorer-custhotkey*
+
+All user defined hotkeys are controlled by the two dicts:
+|g:VEConf_treeHotkey| and |g:VEConf_fileHotkey|
+Example:
+>
+ let g:VEConf_treeHotkey = {}
+ let g:VEConf_treeHotkey.help = '??'
+ let g:VEConf_treeHotkey.quitVE = 'qq'
+ let g:VEConf_treeHotkey.switchPanel = '<s-tab>'
+<
+All definable hotkeys and their default bindings refer to section 2 .
+
+7.3. Command Customization *VimExplorer-custcommand*
+
+VimExplorer supports three types of command interface:
+single file hotkeys and actions, multi file hotkeys and actions and normal
+hotkeys and actions.
+They are controlled by these variables:
+
+ |VEConf_singleFileActions| |VEConf_singleFileHotKeys|
+
+ |VEConf_multiFileActions| |VEConf_multiFileHotKeys|
+
+ |VEConf_normalActions| |VEConf_normalHotKeys|
+
+All of them are dicts. Example:
+>
+ let VEConf_normalActions = {}
+ let VEConf_normalHotKeys = {}
+ let VEConf_normalHotKeys['test1'] = 'T1'
+ function! VEConf_normalActions['test1']()
+ Renamer
+ endfunction
+<
+"test1" is the key. VimExplorer will bind the hotkey and corresponding actions
+automatically.
+>
+ let VEConf_singleFileActions = {}
+ let VEConf_singleFileHotKeys = {}
+ let VEConf_singleFileHotKeys['test2'] = 'T2'
+ function! VEConf_singleFileActions['test2'](path)
+ call VEPlatform.system("notepad.exe " . VEPlatform.escape(a:path))
+ endfunction
+<
+Here, parameter "path" is the path of file under cursor.
+>
+ let VEConf_multiFileActions = {}
+ let VEConf_multiFileHotKeys = {}
+ let VEConf_multiFileHotKeys['test3'] = 'T3'
+ function! VEConf_multiFileActions['test3'](fileList)
+ for i in a:fileList
+ call VEPlatform.start("nautilus " . i)
+ endfor
+ endfunction
+<
+Parameter "fileList" consists of all paths of marked files.
+In addition, VimExplorer provides some platform independent functions:
+>
+ VEPlatform.start(path)
+ VEPlatform.system(cmd)
+ VEPlatform.copyfile(filename,topath)
+ VEPlatform.search(filename,path)
+ VEPlatform.deleteSingle(path)
+<
+These functions can be used in user defined actions.
+
+
+
+
+==============================================================================
+8. The Author *VimExplorer-author*
+
+If you found a bug, or have some suggestions , mail me.
+
+mail: mbbill<AT>gmail<Dot>com
+
+==============================================================================
+9. Problems and Fixes *VimExplorer-problems*
+
+ *VimExplorer-p1*
+P1. Case sensitive in Win32.
+ At present, the path in win32 is case sensitive. Pay attention to this
+ when starting VE, editing the favorite list or using <c-g> to change
+ path. A good suggestion is using <tab> or <ctrl-d> to complete path
+ automatically.
+
+ *VimExplorer-p2*
+P2. 'wildignre' option cause some files disappeared.
+ If 'wildignore' is not empty, glob() function will not return files
+ matching the file pattern listed in it, then you may find some files
+ disappeared in the file panel.
+
+
+
+==============================================================================
+10. Changelog *VimExplorer-changelog*
+
+0.95
+ - Initial release.
+
+0.96
+ - Bug fix: VE_normalAction not found.
+
+0.97
+ - Change the behaviour of hotkey 'F', now it adds the path under cursor to
+ favorite list. If no path under cursor, use current working path
+ instead.(Thanks to Vincent Wang)
+ - Bug fix: escape ' %#' for path.
+ - Add options |g:VEConf_usingKDE| and |g:VEConf_usingGnome| for starting
+ program in *nix environment.
+ - Check if the script is already loaded, thanks to Dennis Hostetler.
+ - Change default g:VEConf_systemEncoding to '' (empty).
+ - Bug fix: favorite selection out of range.
+0.98
+ - Add option VEConf_filePanelFilter.
+ - Bug fix: Escape <space> in command 'e' 'se' 'u' and '='.
+ - Bug fix: 'Cut' and 'Paste' command causes file lost.
+ - Change the default hotkey 'M' and 'B' to 'm','J'.
+ - Change forward and backward hotkey to |<c-o>| and |<c-i>|(<tab>).
+ - Change hotkey |<tab>| to |<c-tab>|.
+ - Change hotkey |mr| |mv| |md| |me| |mc| to |Mr| |Mv| |Md| |Me| |Mc|.
+ - When GUI is running, use confirm() to pop a dialog instead of input().
+
+==============================================================================
+11. TODO *VimExplorer-todo*
+ - More clipboard.
+ - Diff files in different directories.
+ - Remember the cursor place when switch between directories.
+ - Two panel mode, just like TotalCommand.
+ - Diff directories.
+ - Browse via e.g. FTP, SCP ... directorys on a server.
+
+==============================================================================
+Note 1:
+Renamer is a good plugin used to rename files. The author is John Orr. It can
+be found here:
+http://www.vim.org/scripts/script.php?script_id=1721
+
+
+
+ vim:tw=78:ts=8:ft=help:norl:
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
