Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 123322 - Proposal for Zsh guide section in Gentoo documentation
Summary: Proposal for Zsh guide section in Gentoo documentation
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs on www.gentoo.org
Classification: Unclassified
Component: New Documentation (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Xavier Neys (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-02-18 15:42 UTC by Henryk Konsek
Modified: 2006-09-29 11:01 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
Proposal of initial version of the Zsh guide (zsh.xml,2.95 KB, text/plain)
2006-02-18 15:44 UTC, Henryk Konsek
Details
zsh.xml (zsh.xml,3.15 KB, text/plain)
2006-02-18 16:12 UTC, Chris White (RETIRED)
Details
zsh.diff (zsh.diff,4.90 KB, patch)
2006-02-18 16:13 UTC, Chris White (RETIRED)
Details | Diff
Added Custom Prompt section (zsh.xml,4.92 KB, text/plain)
2006-02-18 19:11 UTC, Andrew Morritt
Details
Typos, more about completion, misc section (zsh.xml,5.96 KB, text/plain)
2006-02-20 14:38 UTC, Henryk Konsek
Details
Diff against last version (zsh.diff,2.39 KB, patch)
2006-02-20 14:40 UTC, Henryk Konsek
Details | Diff
Aspelling, history section has been added (zsh.xml,7.90 KB, text/plain)
2006-02-20 16:16 UTC, Henryk Konsek
Details
Diff against the latest version (zsh.diff,2.52 KB, patch)
2006-02-20 16:17 UTC, Henryk Konsek
Details | Diff
zsh.xml (zsh.xml,8.59 KB, text/plain)
2006-08-06 12:33 UTC, Henryk Konsek
Details
zsh.xml (zsh.xml,8.89 KB, text/plain)
2006-09-03 09:59 UTC, Peter Weller (RETIRED)
Details
zsh.xml (zsh.xml,9.31 KB, text/plain)
2006-09-03 12:30 UTC, Peter Weller (RETIRED)
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Henryk Konsek 2006-02-18 15:42:13 UTC
As far as I know there is no section in Gentoo documentation concerning Zsh 
configuration. I've written sample article covering basic Zsh installation 
and configuration issues.
Comment 1 Henryk Konsek 2006-02-18 15:44:35 UTC
Created attachment 80129 [details]
Proposal of initial version of the Zsh guide
Comment 2 Chris White (RETIRED) gentoo-dev 2006-02-18 15:52:31 UTC
Latching onto this bug to do some basic editing.
Comment 3 Chris White (RETIRED) gentoo-dev 2006-02-18 16:12:53 UTC
Created attachment 80133 [details]
zsh.xml

New edited version. Added <i>'s to prompts, Zsh->zsh, some other minor guidexml fixes, and some grammar fixes.
Comment 4 Chris White (RETIRED) gentoo-dev 2006-02-18 16:13:37 UTC
Created attachment 80134 [details, diff]
zsh.diff

Diff against the original version.
Comment 5 Andrew Morritt 2006-02-18 19:11:40 UTC
Created attachment 80144 [details]
Added Custom Prompt section

Here is a version I created, adding a section on creating a custom zsh prompt. I created it using Chris White's version, and set the version tag to 1.2. Because I'm on a Windows computer at the moment, I can't create a patch.

Thank You,
Andrew
Comment 6 Andrew Morritt 2006-02-18 19:13:36 UTC
Comment on attachment 80144 [details]
Added Custom Prompt section

Changed filetype
Comment 7 Henryk Konsek 2006-02-20 14:38:34 UTC
Created attachment 80319 [details]
Typos, more about completion, misc section
Comment 8 Henryk Konsek 2006-02-20 14:40:32 UTC
Created attachment 80320 [details, diff]
Diff against last version
Comment 9 Henryk Konsek 2006-02-20 16:16:46 UTC
Created attachment 80326 [details]
Aspelling, history section has been added
Comment 10 Henryk Konsek 2006-02-20 16:17:42 UTC
Created attachment 80327 [details, diff]
Diff against the latest version
Comment 11 Łukasz Damentko (RETIRED) gentoo-dev 2006-07-20 14:39:46 UTC
Is that finished? We could finally publish it if i got some input from you.

BTW, while reading it, i noticed that it doesn't in fact mention switching to zsh permanently (usermod -s)... How about adding it?
Comment 12 Henryk Konsek 2006-08-06 02:13:15 UTC
Hi
> Is that finished? We could finally publish it if i got some input from you.

In my humble opinion it is fine to publish. At this moment it contains majority of information needed by "zsh youngsters".

> BTW, while reading it, i noticed that it doesn't in fact mention switching to
> zsh permanently (usermod -s)... How about adding it?

Good idea. usermod or ~/.bashrc (for non-root users with lazy sysadmins :-) ). I can write it. I'll do it and commit results this evening or night I guess.
Comment 13 Henryk Konsek 2006-08-06 12:33:33 UTC
Created attachment 93612 [details]
zsh.xml

I've added chapter 'Making zsh default shell' as requested.
Comment 14 Peter Weller (RETIRED) gentoo-dev 2006-09-03 09:59:21 UTC
Created attachment 95857 [details]
zsh.xml

Just grammar/spellchecked it, added a little bit about starting zsh after installation - nothing too big though, improves the quality of the doc though imho. Also updated version number and date. Made sure that it followed the GuideXML standards (it didn't when i got it...).
Comment 15 Peter Weller (RETIRED) gentoo-dev 2006-09-03 12:30:01 UTC
Created attachment 95873 [details]
zsh.xml

Added a paragraph on chsh, double checked for grammatical/spelling mistakes - all looks good. Passes xmllint, and I've double-checked to ensure that there are no missing <c> or <i> tags. Sorted out the indentation of the table - everything looks good to go :)
Comment 16 Xavier Neys (RETIRED) gentoo-dev 2006-09-03 12:41:45 UTC
Edited & commented out the bit about searching the history as it just does not work as explained (up arrow displays previous commands in sequence).
Feel free to open a new bug about it.

Thanks to all for your contribution.
Comment 17 Henryk Konsek 2006-09-03 15:15:45 UTC
(In reply to comment #16)
> Edited & commented out the bit about searching the history as it just does not
> work as explained (up arrow displays previous commands in sequence).

Weird. I've checked again on brand new zsh installation and it still works as it ought to. I've noticed similar behaviour sth about 2 years ago on PLD Linux, but I  haven't figured out why it happens.
I would be grateful is somebody else olso could try it and share his or her observation with us. Maybe we could fix it somehow. This history searching is really splendid feature and we should share it with others :)
Comment 18 Łukasz Damentko (RETIRED) gentoo-dev 2006-09-03 23:22:24 UTC
I've never used zsh for more than half an hour so i can't really say what's wrong. But i can say that neysx is right and this search part just isn't working. It shows the last command typed in and doesn't search for anything.
Comment 19 Xavier Neys (RETIRED) gentoo-dev 2006-09-21 03:49:39 UTC
Hmmm. I hadn't meant to keep this on open. Sorry.
Comment 20 Henryk Konsek 2006-09-29 08:41:28 UTC
I've done some research and noticed that this weird history scanning depends on terminal used. In particular Eterm used by me (as well as TTY console) works fine, while for instance Xterm and GnomeTerminal ignore search settings.
I can't figure out why such weird things happen so I've issued this question to Zsh-Users mailing list.
Greetings.
Comment 21 Henryk Konsek 2006-09-29 11:01:59 UTC
Thanks to Andrey Borzenkov who has answered my question on Zsh-Users mailing list. 
Solution is to use 'zkdb' module:

autoload zkbd; zkbd

However there is a relative lots of user interaction with zkdb script and also few additional lines to add to zshrc to make our shell to load script generated by zkbd. It may be hard to make description of this process short and clear enough. I consider removal of this feature from this tutorial then.
Another anxious issue is that XTerm configured with zkb works fine while Gnome-Terminal prompt me with Help when zkb asks me to enter F1 during its tests. That may be another reason to avoid this feature due to nondeterministic behaviour of zkb under various types of X11-terms.
I'm afraid that this section (i.e. history searching) of guide will be too large and complicated to fit into Gentoo Guides convention.