Permalink
Browse files

docs

  • Loading branch information...
1 parent 79b9f3b commit 9696404f368170050ec2fea380b308c912faf638 @tomtom committed Oct 23, 2010
Showing with 37 additions and 10 deletions.
  1. +0 −2 README
  2. +37 −8 doc/tmarks.txt
View
2 README
@@ -1,5 +1,3 @@
-*tmarks.txt* Browse & manipulate marks
-
This plugin provides commands to browse and to manipulate (place &
delete) marks.
View
@@ -5,16 +5,24 @@ This plugin provides commands to browse and to manipulate (place &
delete) marks.
Features:
+
- Browse marks
- Delete all (lower-case) marks in the current buffer
- Delete all (lower-case) marks in a range
- Set the next available (lower-case) mark at a specified line
-
Key maps in the list view:
+
<c-d> ... Delete mark
<cr> ... Jump to mark
+If g:tmarks_key is set in your |vimrc| file, this plugin also provides the
+following maps:
+
+ <c-KEY> ... Toggle the mark at the current line
+ <KEY> ... Jump to the next mark
+ <s-KEY> ... Jump to the previous mark
+
-----------------------------------------------------------------------
Install~
@@ -35,9 +43,13 @@ Also available via git: http://github.com/tomtom/vimtlib/
========================================================================
Contents~
- :TMarks .................. |:TMarks|
- tmarks#AgentDeleteMark ... |tmarks#AgentDeleteMark()|
- tmarks#List .............. |tmarks#List()|
+ :TMarks ................... |:TMarks|
+ :TMarkstoggle ............. |:TMarkstoggle|
+ :TMarksdelete ............. |:TMarksdelete|
+ :TMarksdeleteall .......... |:TMarksdeleteall|
+ :TMarksnext ............... |:TMarksnext|
+ tmarks#ToggleMarkAtLine ... |tmarks#ToggleMarkAtLine()|
+ tmarks#Next ............... |tmarks#Next()|
========================================================================
@@ -47,15 +59,32 @@ plugin/tmarks.vim~
:TMarks
Browse all marks.
+ *:TMarkstoggle*
+:{range}TMarkstoggle
+ Place the next available a-z mark at the specified line.
+
+ *:TMarksdelete*
+:{range}TMarksdelete
+ Delete all a-z marks in range.
+
+ *:TMarksdeleteall*
+:TMarksdeleteall
+ Delete all a-z marks in the current buffer.
+
+ *:TMarksnext*
+:TMarksnext
+ Jump to the nth prev/next mark.
+
========================================================================
autoload/tmarks.vim~
- *tmarks#AgentDeleteMark()*
-tmarks#AgentDeleteMark(world, selected)
+ *tmarks#ToggleMarkAtLine()*
+tmarks#ToggleMarkAtLine(?line='.')
+ Toggle the mark at line.
- *tmarks#List()*
-tmarks#List()
+ *tmarks#Next()*
+tmarks#Next(count)

0 comments on commit 9696404

Please sign in to comment.