search

tcsh-org / tcsh

This is a read-only mirror of the tcsh code repository.
https://www.tcsh.org/
Other
232 stars 42 forks source link

Document how to disable automatic logout #22

Closed 0mp closed 4 years ago

suominen commented 4 years ago

If you don't want the functionality behind a special shell variable enabled, you unset the variable. This applies to all special variables.

0mp commented 4 years ago

If you don't want the functionality behind a special shell variable enabled, you unset the variable. This applies to all special variables.

It makes sense, thanks!

Nevertheless, I find the current description confusing: it is unclear that unsetting the variable is the way to disable this functionality. Especially, that most blog posts I found online suggest setting it to 0.

I think that a note about disabling autologout would be valuable. What do you think?

suominen commented 4 years ago

The "Variable substitution" section explains how shell variables work. The third paragraph (https://github.com/tcsh-org/tcsh/blob/master/tcsh.man#L1250) especially brings up special shell variables.

I don't think it makes sense to explain the unsetting of special variables under any specific special variable. Instead, maybe something could be added to the first paragraph under the "Special shell variables" section (https://github.com/tcsh-org/tcsh/blob/master/tcsh.man#L3705), perhaps similar to what "Special aliases" has (https://github.com/tcsh-org/tcsh/blob/master/tcsh.man#L3613).

But care should be taken to explain that some of the special shell variables act as toggles (as mentioned under "Variable substition").

zoulasc commented 4 years ago

I am not opposed to adding a sentence explaining that unsetting it disables autologout, if people think it is not obvious. After all documentation is there to help people.

zoulasc commented 4 years ago

I committed an explanation since it was not obvious.