From: Jonas Fonseca Date: Wed, 18 Nov 2009 02:24:44 +0000 (-0500) Subject: Update asciidoc table syntax to the one supported by version 8.4.4 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=fa41280ad285af9c866c49f8db6e60817729d912;p=tig.git Update asciidoc table syntax to the one supported by version 8.4.4 Also, fix README.html dependencies. --- diff --git a/INSTALL b/INSTALL index 7759326..a79a3d5 100644 --- a/INSTALL +++ b/INSTALL @@ -29,27 +29,29 @@ installation. The following tools and packages are needed: -`-------------------------------`---------------------------------------------- -Tool Description -------------------------------------------------------------------------------- -git-core Tig is just a frontend for git. -ncurses Be sure to also have development files \ - installed. Usually they are available in a \ - separate package ending with `-dev`. -iconv If iconv is not provided by the c library \ - you need to change the Makefile to link it \ - into the binary. -------------------------------------------------------------------------------- +[cols="2<,8<",options="header"] +|============================================================================= +|Tool |Description +|git-core |Tig is just a frontend for git. +|ncurses |Be sure to also have development files + installed. Usually they are available in a + separate package ending with `-dev`. +|iconv |If iconv is not provided by the c library + you need to change the Makefile to link it + into the binary. +|============================================================================= The following optional tools and packages are needed for creating the configure script and building documentation: -`-------------------------------`---------------------------------------------- -autoconf Contains autoreconf for generating configure \ - from configure.ac. -asciidoc (>= 8.0) Generates HTML and (DocBook) XML from text. -xmlto Generates manpages and chunked HTML from XML. -DocBook XSL (>= 1.72.0) Used by xmlto for building manpages. -DocBook (DSSL/Jade) tools Generates PDF from XML. \ +[cols="2<,8<",options="header"] +|============================================================================= +|Tool |Description +|autoconf |Contains autoreconf for generating configure + from configure.ac. +|asciidoc (>= 8.0) |Generates HTML and (DocBook) XML from text. +|xmlto |Generates manpages and chunked HTML from XML. +|DocBook XSL (>= 1.72.0) |Used by xmlto for building manpages. +|DocBook (DSSL/Jade) tools |Generates PDF from XML. Also known as docbook-utils. -------------------------------------------------------------------------------- +|============================================================================= diff --git a/Makefile b/Makefile index d764644..8688eb5 100644 --- a/Makefile +++ b/Makefile @@ -150,7 +150,7 @@ manual.toc: manual.txt *) ref="$$ref, $$line" ;; \ esac; done | sed 's/\[\[\(.*\)\]\]/\1/' > $@ -README.html: README asciidoc.conf +README.html: README SITES INSTALL asciidoc.conf $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article -a readme $< NEWS.html: NEWS asciidoc.conf diff --git a/manual.txt b/manual.txt index d73e819..559c345 100644 --- a/manual.txt +++ b/manual.txt @@ -44,7 +44,7 @@ given command and all will be shell quoted before they are passed to the shell. NOTE: If you specify options for the main view, you should not use the -`\--pretty` option as this option will be set automatically to the format +`--pretty` option as this option will be set automatically to the format expected by the main view. Example on how to view a commit and show both author and committer @@ -145,17 +145,17 @@ some of the <> as well as the arguments that refer to the current browsing state by using one of the following variables. -`-----------------------`----------------------------------------------------- -Browsing state variables ------------------------------------------------------------------------------- -%(head) The currently viewed 'head' ID. Defaults to HEAD -%(commit) The currently selected commit ID. -%(blob) The currently selected blob ID. -%(directory) The current directory path in the tree view; \ - empty for the root directory. -%(file) The currently selected file. -%(ref) The reference given to blame or HEAD if undefined. ------------------------------------------------------------------------------- +.Browsing state variables +[frame="none",grid="none",cols="25). In the stage view, when pressing this on \ - a diff chunk line stages only that chunk for next commit, when not on \ - a diff chunk line all changes in the displayed diff is staged. -M Resolve unmerged file by launching git-mergetool(1). Note, to work \ - correctly this might require some initial configuration of your \ - preferred merge tool. See the manpage of git-mergetool(1). -! Checkout file with unstaged changes. This will reset the file to \ - contain the content it had at last commit. -@ Move to next chunk in the stage view. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|Key |Action +|u |Update status of file. In the status view, this allows you to add an + untracked file or stage changes to a file for next commit (similar to + running git-add ). In the stage view, when pressing this on + a diff chunk line stages only that chunk for next commit, when not on + a diff chunk line all changes in the displayed diff is staged. +|M |Resolve unmerged file by launching git-mergetool(1). Note, to work + correctly this might require some initial configuration of your + preferred merge tool. See the manpage of git-mergetool(1). +|! |Checkout file with unstaged changes. This will reset the file to + contain the content it had at last commit. +|@ |Move to next chunk in the stage view. +|============================================================================= [[cursor-nav]] Cursor Navigation ~~~~~~~~~~~~~~~~~ -`-------`-------------------------------------------------------------------- -Key Action ------------------------------------------------------------------------------ -k Move cursor one line up. -j Move cursor one line down. -PgUp,\ --,a Move cursor one page up. -PgDown Space Move cursor one page down. -Home Jump to first line. -End Jump to last line. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|Key |Action +|k |Move cursor one line up. +|j |Move cursor one line down. +|PgUp,-,a |Move cursor one page up. +|PgDown, Space |Move cursor one page down. +|End |Jump to last line. +|Home |Jump to first line. +|============================================================================= [[view-scrolling]] Scrolling ~~~~~~~~~ -`-------`-------------------------------------------------------------------- -Key Action ------------------------------------------------------------------------------ -Insert Scroll view one line up. -Delete Scroll view one line down. -w Scroll view one page up. -s Scroll view one page down. -Left Scroll view one column left. -Right Scroll view one column right. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|Key |Action +|Insert |Scroll view one line up. +|Delete |Scroll view one line down. +|w |Scroll view one page up. +|s |Scroll view one page down. +|Left |Scroll view one column left. +|Right |Scroll view one column right. +|============================================================================= [[searching]] Searching ~~~~~~~~~ -`-------`-------------------------------------------------------------------- -Key Action ------------------------------------------------------------------------------ -/ Search the view. Opens a prompt for entering search regexp to use. -? Search backwards in the view. Also prompts for regexp. -n Find next match for the current search regexp. -N Find previous match for the current search regexp. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|Key |Action +|/ |Search the view. Opens a prompt for entering search regexp to use. +|? |Search backwards in the view. Also prompts for regexp. +|n |Find next match for the current search regexp. +|N |Find previous match for the current search regexp. +|============================================================================= [[misc-keys]] Misc ~~~~ -`-------`-------------------------------------------------------------------- -Key Action ------------------------------------------------------------------------------ -Q Quit. -r Redraw screen. -z Stop all background loading. This can be useful if you use \ - tig in a repository with a long history without limiting \ - the revision log. -v Show version. -o Open option menu -'.' Toggle line numbers on/off. -D Toggle date display on/off. -A Toggle author display on/off. -g Toggle revision graph visualization on/off. -F Toggle reference display on/off (tag and branch names). -':' Open prompt. This allows you to specify what git command \ - to run. Example `:log -p`. You can also use this to jump \ - to a specific line by typing `:`, e.g. `:80`. -e Open file in editor. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|Key |Action +|Q |Quit. +|r |Redraw screen. +|z |Stop all background loading. This can be useful if you use + tig in a repository with a long history without limiting + the revision log. +|v |Show version. +|o |Open option menu +|. |Toggle line numbers on/off. +|D |Toggle date display on/off. +|A |Toggle author display on/off. +|g |Toggle revision graph visualization on/off. +|F |Toggle reference display on/off (tag and branch names). +|: |Open prompt. This allows you to specify what git command + to run. Example `:log -p`. You can also use this to jump + to a specific line by typing `:`, e.g. `:80`. +|e |Open file in editor. +|============================================================================= [[external-commands]] External Commands @@ -451,13 +450,13 @@ a script or program. They are bound to keys and use information from the current browsing state, such as the current commit ID. Tig comes with the following built-in external commands: -`-------`-------`------------------------------------------------------------ -Keymap Key Action ------------------------------------------------------------------------------ -main C git cherry-pick %(commit) -status C git commit -generic G git gc ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="1<,1<,8<",options="header"] +|============================================================================= +|Keymap |Key |Action +|main |C |git cherry-pick %(commit) +|status |C |git commit +|generic|G |git gc +|============================================================================= [[refspec]] Revision Specification @@ -485,7 +484,7 @@ $ tig Makefile README ----------------------------------------------------------------------------- To avoid ambiguity with tig's subcommands or repository references such as tag -name, be sure to separate file names from other git options using "\--". So if +name, be sure to separate file names from other git options using "`--`". So if you have a file named 'status' it will clash with the 'status' subcommand, and thus you will have to use: @@ -499,7 +498,7 @@ Limit by Date or Number To speed up interaction with git, you can limit the amount of commits to show both for the log and main view. Either limit by date using e.g. -`\--since=1.month` or limit by the number of commits using `-n400`. +`--since=1.month` or limit by the number of commits using `-n400`. If you are only interested in changed that happened between two dates you can use: @@ -509,7 +508,7 @@ $ tig --after="May 5th" --before="2006-05-16 15:44" ----------------------------------------------------------------------------- NOTE: If you want to avoid having to quote dates containing spaces you can use -"." instead, e.g. `\--after=May.5th`. +"." instead, e.g. `--after=May.5th`. [[commit-range-limiting]] Limiting by Commit Ranges @@ -602,8 +601,3 @@ Manpages: Online resources: include::SITES[] - -Other git repository browsers: - - - gitk(1) - - qgit(1) diff --git a/tigrc.5.txt b/tigrc.5.txt index 3ead320..711c6a4 100644 --- a/tigrc.5.txt +++ b/tigrc.5.txt @@ -213,20 +213,17 @@ be available as an external command. External commands can contain variable names that will be substituted before the command is run. Valid variable names are: -ifdef::backend-xhtml11[] -[frame="none"] -`-----------------------`----------------------------------------------------- -endif::backend-xhtml11[] -Browsing state variables ------------------------------------------------------------------------------- -%(head) The currently viewed 'head' ID. Defaults to HEAD -%(commit) The currently selected commit ID. -%(blob) The currently selected blob ID. -%(directory) The current directory path in the tree view; \ - empty for the root directory. -%(file) The currently selected file. -%(ref) The reference given to blame or HEAD if undefined. ------------------------------------------------------------------------------- +.Browsing state variables +[frame="none",grid="none",cols="25 !git publish -------------------------------------------------------------------------- -ifdef::backend-xhtml11[] -[frame="none"] -`-----------------------`----------------------------------------------------- -endif::backend-xhtml11[] -View switching: ------------------------------------------------------------------------------- -view-main Show main view -view-diff Show diff view -view-log Show log view -view-tree Show tree view -view-blob Show blob view -view-blame Show blame view -view-branch Show branch view -view-status Show status view -view-stage Show stage view -view-pager Show pager view -view-help Show help page ------------------------------------------------------------------------------- - -ifdef::backend-xhtml11[] -[frame="none"] -`-----------------------`----------------------------------------------------- -endif::backend-xhtml11[] -View manipulation: ------------------------------------------------------------------------------- -enter Enter current line and scroll -next Move to next -previous Move to previous -parent Move to parent -view-next Move focus to next view -refresh Reload and refresh view -maximize Maximize the current view -view-close Close the current view -quit Close all views and quit ------------------------------------------------------------------------------- - -ifdef::backend-xhtml11[] -[frame="none"] -`-----------------------`----------------------------------------------------- -endif::backend-xhtml11[] -View specific actions: ------------------------------------------------------------------------------- -status-update Update file status -status-merge Resolve unmerged file -stage-next Find next chunk to stage ------------------------------------------------------------------------------- - -ifdef::backend-xhtml11[] -[frame="none"] -`-----------------------`----------------------------------------------------- -endif::backend-xhtml11[] -Cursor navigation: ------------------------------------------------------------------------------- -move-up Move cursor one line up -move-down Move cursor one line down -move-page-down Move cursor one page down -move-page-up Move cursor one page up -move-first-line Move cursor to first line -move-last-line Move cursor to last line ------------------------------------------------------------------------------- - -ifdef::backend-xhtml11[] -[frame="none"] -`-----------------------`----------------------------------------------------- -endif::backend-xhtml11[] -Scrolling: ------------------------------------------------------------------------------- -scroll-line-up Scroll one line up -scroll-line-down Scroll one line down -scroll-page-up Scroll one page up -scroll-page-down Scroll one page down -scroll-left Scroll one column left -scroll-right Scroll one column right ------------------------------------------------------------------------------- - -ifdef::backend-xhtml11[] -[frame="none"] -`-----------------------`----------------------------------------------------- -endif::backend-xhtml11[] -Searching: ------------------------------------------------------------------------------- -search Search the view -search-back Search backwards in the view -find-next Find next search match -find-prev Find previous search match ------------------------------------------------------------------------------- - -ifdef::backend-xhtml11[] -[frame="none"] -`-----------------------`----------------------------------------------------- -endif::backend-xhtml11[] -Misc: ------------------------------------------------------------------------------- -prompt Bring up the prompt -screen-redraw Redraw the screen -screen-resize Resize the screen -show-version Show version information -stop-loading Stop all loading views -options Open options menu -toggle-lineno Toggle line numbers -toggle-date Toggle date display -toggle-author Toggle author display -toggle-rev-graph Toggle revision graph visualization -toggle-refs Toggle reference display -edit Open in editor -none Do nothing ------------------------------------------------------------------------------- +.View switching +[frame="none",grid="none",cols="25