124 lines
2.8 KiB
Markdown
124 lines
2.8 KiB
Markdown
# **42 Header**
|
|
|
|
42Lausanne (Switzerland)
|
|
|
|
### **Description**
|
|
|
|
42 standard header for vim editor.
|
|
|
|
|
|
|
|
### **Usage**
|
|
|
|
In **NORMAL** mode (<kbd>ESC</kbd>) you can simply press the shortcut <kbd>F2</kbd> (or <kbd>FN</kbd> <kbd>F2</kbd>) or use `:FT` as command.
|
|
```
|
|
vim 42.c
|
|
<ESC> <F2>
|
|
<ESC> :wq
|
|
|
|
vim Makefile
|
|
<ESC> :FT
|
|
<ESC> :wq
|
|
```
|
|
|
|
### **Quick Setup**
|
|
|
|
Below replace "marvin" with your 42 Network login.
|
|
|
|
```
|
|
export USER="marvin"
|
|
export MAIL="marvin@student.42lausanne.ch"
|
|
|
|
./set_header.sh
|
|
```
|
|
|
|
In all your git repositories:
|
|
```
|
|
git clone git@... project
|
|
cd project
|
|
git config user.name "marvin"
|
|
git config user.email "marvin@student.42lausanne.ch"
|
|
```
|
|
|
|
### **Manual Setup**
|
|
|
|
Below replace "marvin" with your 42 Network login.
|
|
|
|
Copy `stdheader.vim` in your `~/.vim/plugin`.
|
|
```
|
|
test -d ~/.vim/plugin || mkdir -p ~/.vim/plugin
|
|
cp -va vim/stdheader.vim ~/.vim/plugin
|
|
```
|
|
|
|
In all your git repositories:
|
|
```
|
|
git clone git@... project
|
|
cd project
|
|
git config user.name "marvin"
|
|
git config user.email "marvin@student.42lausanne.ch"
|
|
```
|
|
|
|
UNIX/BSD Distro (MacOS X, FreeBSD, OpenBSD, etc.) edit `~/.zshrc`:
|
|
```
|
|
vim ~/.zshrc
|
|
export USER="marvin"
|
|
export MAIL="marvin@student.42lausanne.ch"
|
|
<ESC> :wq
|
|
source ~/.zshrc
|
|
```
|
|
|
|
Linux/GNU Distro (Debian/Ubuntu, RedHat/SuSE, Arch, Gentoo, etc.) edit `~/.bashrc`:
|
|
```
|
|
vim ~/.bashrc
|
|
export USER="marvin"
|
|
export MAIL="marvin@student.42lausanne.ch"
|
|
<ESC> :wq
|
|
. ~/.bashrc
|
|
```
|
|
|
|
### **Note**
|
|
|
|
- Your git username and email will always have the priority over $USER and $MAIL variables.
|
|
- if you are outside a git repo tree, it will use the $USER and $MAIL environement variables.
|
|
- if none of the above, it will default to marvin@student.42lausanne.ch and marvin as username.
|
|
|
|
Troubleshooting:
|
|
```
|
|
git config user.name
|
|
git config user.email
|
|
echo $USER
|
|
echo $MAIL
|
|
grep -e 'USER=' -e 'MAIL=' ~/.zshrc
|
|
```
|
|
|
|
The location of this alternative version of stdheader.vim:
|
|
- ~/.vim/plugin/stdheader.vim
|
|
- $HOME/.vim/plugin/stdheader.vim
|
|
|
|
The location of the official stdheader.vim in 42lausanne's clusters:
|
|
- /usr/share/vim/vim80/plugin/stdheader.vim
|
|
- /usr/share/vim/vim81/plugin/stdheader.vim (at the time of writing)
|
|
- /usr/share/vim/vim82/plugin/stdheader.vim
|
|
|
|
### **Credits**
|
|
|
|
- [@42Paris](https://github.com/42Paris)
|
|
- [@zazard](https://github.com/zazard)
|
|
|
|
### **Bonus**
|
|
|
|
- Swissair is gone? Have a look to [Airline](https://github.com/vim-airline/vim-airline) for a nice status for vim.
|
|
```
|
|
test -d ~/.vim/plugin || mkdir -p ~/.vim/plugin
|
|
test -d ~/.vim/autoload || mkdir -p ~/.vim/autoload
|
|
git clone https://github.com/vim-airline/vim-airline.git vim-airline
|
|
cd vim-airline
|
|
cp -va autoload/* ~/.vim/autoload/
|
|
cp -va plugin/* ~/.vim/plugin/
|
|
```
|
|
[RTFM](https://github.com/vim-airline/vim-airline/blob/master/doc/airline.txt)
|
|
|
|
### **License**
|
|
|
|
This work is published under the terms of **[42 Unlicense](https://github.com/gcamerli/42unlicense)**.
|