Skip to content

Commit f747d0c

Browse files
committed
docs(faq): how to compose messages in another editer
1 parent 614bf29 commit f747d0c

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/FAQ.md

+25
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,31 @@ We think of Zulip Terminal as a keyboard-centric client. Consequently, while fun
321321

322322
If any of the hotkeys don't work for you, feel free to open an issue or discuss it on [#zulip-terminal](https://chat.zulip.org/#narrow/stream/206-zulip-terminal).
323323

324+
## Can I compose messages in another editor ?
325+
326+
In the main branch of zulip-terminal, you can now use an external editor to
327+
compose your message using `ctrl o` shortcut. If `ZULIP_EDITOR_COMMAND` or
328+
`EDITOR` environment variable is set, this command or program would be used
329+
to open the message by appending a temporary file filepath of the current message.
330+
331+
It will work directly for most terminal editors with only the program name `vim`,
332+
`nano`, `helix`, `kakoune`, `nvim`...
333+
334+
It can also be used for desktop editor with some constraint which needs to be
335+
address using `ZULIP_EDITOR_COMMAND` custom command. The program must not fork
336+
or detach from the running terminal and should open in a new window, some
337+
examples:
338+
339+
- [lapce](https://github.com/lapce/lapce) with `lapce -n -w`
340+
- [sublime-text](https://www.sublimetext.com/) with `subl -n -w`
341+
- [marker](https://github.com/fabiocolacio/Marker) with `marker`
342+
- [vim](https://github.com/vim/vim) with `vim -g -f` or `gvim -f`
343+
- [vscode](https://github.com/microsoft/vscode) with `code -n -w`
344+
345+
When the external editor process ends (closing the window or quitting terminal
346+
editor), the composing box will be updated with the new message content from
347+
the temporary file.
348+
324349
## Zulip-term crashed!
325350

326351
We hope this doesn't happen, but would love to hear about this in order to fix it, since the application should be increasingly stable! Please let us know the problem, and if you're able to duplicate the issue, on the github issue-tracker or at [#zulip-terminal](https://chat.zulip.org/#narrow/stream/206-zulip-terminal).

0 commit comments

Comments
 (0)