TREE.md

Directory structure

• src/ - crate sources

  1. Common:

     • error.rs - error propagating functions

     • lib.rs - main library file

     • tmux_interface.rs - common functions

     • tmux_interface_tests.rs

     • version.rs - parse version response

     • version_tests.rs

  2. TMUX Options src/options

     • mod.rs - module file

     • pane_options.rs - pane options

     • pane_options_tests.rs - pane options tests

     • server_options.rs - server options

     • server_options_tests.rs - server options tests

     • session_options.rs - session options

     • session_options_tests.rs - session options tests

     • window_options.rs - window options

     • window_options_tests.rs - window options tests

  3. TMUX Commands (structure similar to TMUX manual):

     • src/commands/buffers (TMUX manual)

       • mod.rs

       • choose_buffer.rs - (^1.3)

       • choose_buffer_tests.rs - (^1.3)

       • clear_history.rs - (^0.9)

       • clear_history_tests.rs - (^0.9)

       • delete_buffer.rs - (^0.8)

       • delete_buffer_tests.rs - (^0.8)

       • list_buffers.rs - (^0.8)

       • list_buffers_tests.rs - (^0.8)

       • load_buffer.rs - (^0.8)

       • load_buffer_tests.rs - (^0.8)

       • paste_buffer.rs - (^0.8)

       • paste_buffer_tests.rs - (^0.8)

       • save_buffer.rs - (^0.8)

       • save_buffer_tests.rs - (^0.8)

       • set_buffer.rs - (^0.8)

       • set_buffer_tests.rs - (^0.8)

       • show_buffer.rs - (^0.8)

       • show_buffer_tests.rs - (^0.8)

     • src/commands/clients_and_sessions - (TMUX manual)

       • attach_session.rs - (^0_8)

       • attach_session_tests.rs - (^0_8)

       • detach_client.rs - (^0.8)

       • detach_client_tests.rs - (^0.8)

       • has_session.rs - (^0.8)

       • has_session_tests.rs - (^0.8)

       • kill_server.rs - (^0.8)

       • kill_server_tests.rs - (^0.8)

       • kill_session.rs - (^0.8)

       • kill_session_tests.rs - (^0.8)

       • list_clients.rs - (^0.8)

       • list_clients_tests.rs - (^0.8)

       • list_commands.rs - (^0.8)

       • list_commands_tests.rs - (^0.8)

       • list_sessions.rs - (^0.8)

       • list_sessions_tests.rs - (^0.8)

       • lock_client.rs - (^1.1)

       • lock_client_tests.rs - (^1.1)

       • lock_session.rs - (^1.1)

       • lock_session_tests.rs - (^1.1)

       • mod.rs

       • new_session.rs - (^0.8)

       • new_session_tests.rs - (^0.8)

       • refresh_client.rs - (^0.8)

       • refresh_client_tests.rs - (^0.8)

       • rename_session.rs - (^0.8)

       • rename_session_tests.rs - (^0.8)

       • show_messages.rs - (^1.2)

       • show_messages_tests.rs - (^1.2)

       • source_file.rs - (^0.8)

       • source_file_tests.rs - (^0.8)

       • start_server.rs - (^0.8)

       • start_server_tests.rs - (^0.8)

       • suspend_client.rs - (^0.8)

       • suspend_client_tests.rs - (^0.8)

       • switch_client.rs - (^0.8)

       • switch_client_tests.rs - (^0.8)

     • src/commands/global_and_session_environment - (TMUX manual)

       • mod.rs

       • set_environment.rs - (^1.0)

       • set_environment_tests.rs - (^1.0)

       • show_environment.rs - (^1.0)

       • show_environment_tests.rs - (^1.0)

     • src/commands/hooks - (TMUX manual)

       • mod.rs

       • set_hook.rs - (^2.2)

       • set_hook_tests.rs - (^2.2)

       • show_hooks.rs - (^2.2)

       • show_hooks_tests.rs - (^2.2)

     • src/commands/key_bindings - (TMUX manual)

       • bind_key.rs - (^0.8)

       • bind_key_tests.rs - (^0.8)

       • list_keys.rs - (^0.8)

       • list_keys_tests.rs - (^0.8)

       • mod.rs

       • send_keys.rs - (^0.8)

       • send_keys_tests.rs - (^0.8)

       • send_prefix.rs - (^0.8)

       • send_prefix_tests.rs - (^0.8)

       • unbind_key.rs - (^0.8)

       • unbind_key_tests.rs - (^0.8)

     • src/command/miscellaneous - (TMUX manual)

       • clock_mode.rs - (^0.8)

       • clock_mode_tests.rs - (^0.8)

       • if_shell.rs - (^0.8)

       • if_shell_tests.rs - (^0.8)

       • lock_server.rs - (^0.8)

       • lock_server_tests.rs - (^0.8)

       • mod.rs

       • run_shell.rs - (^1.1)

       • run_shell_tests.rs - (^1.1)

       • wait_for.rs - (^1.8)

       • wait_for_tests.rs - (^1.8)

     • src/command/options - (TMUX manual)

       • mod.rs

       • set_option.rs - (^0.8)

       • set_option_tests.rs - (^0.8)

       • set_window_option.rs - (^0.8)

       • set_window_option_tests.rs - (^0.8)

       • show_options.rs - (^0.8)

       • show_options_tests.rs - (^0.8)

       • show_window_options.rs - (^0.8)

       • show_window_options_tests.rs - (^0.8)

     • src/command/status_line - (TMUX manual)

       • command_prompt.rs - (^0.8)

       • command_prompt_tests.rs - (^0.8)

       • confirm_before.rs - (^0.9)

       • confirm_before_tests.rs - (^0.9)

       • display_menu.rs - (^3.0)

       • display_menu_tests.rs - (^3.0)

       • display_message.rs - (^1.0)

       • display_message_tests.rs - (^1.0)

       • mod.rs

     • src/command/windows_and_panes - (TMUX manual)

       • break_pane.rs - (^0.8)

       • break_pane_tests.rs - (^0.8)

       • capture_pane.rs - (^1.2)

       • capture_pane_tests.rs - (^1.2)

       • choose_client.rs - (^1.0)

       • choose_client_tests.rs - (^1.0)

       • choose_tree.rs - (^1.7)

       • choose_tree_tests.rs - (^1.7)

       • copy_mode.rs - (^0.8)

       • copy_mode_tests.rs - (^0.8)

       • display_pane.rs - (^1.0)

       • display_pane_tests.rs - (^1.0)

       • find_window.rs - (^0.8)

       • find_window_tests.rs - (^0.8)

       • join_pane.rs - (^1.2)

       • join_pane_tests.rs - (^1.2)

       • kill_pane.rs - (^0.8)

       • kill_pane_tests.rs - (^0.8)

       • kill_window.rs - (^0.8)

       • kill_window_tests.rs - (^0.8)

       • last_pane.rs - (^1.4)

       • last_pane_tests.rs - (^1.4)

       • last_window.rs - (^0.8)

       • last_window_tests.rs - (^0.8)

       • link_window.rs - (^0.8)

       • link_window_tests.rs - (^0.8)

       • list_panes.rs - (^0.8)

       • list_panes_tests.rs - (^0.8)

       • list_windows.rs - (^0.8)

       • list_windows_tests.rs - (^0.8)

       • mod.rs

       • move_pane.rs - (^1.7)

       • move_pane_tests.rs - (^1.7)

       • move_window.rs - (^0.8)

       • move_window_tests.rs - (^0.8)

       • new_window.rs - (^0.8)

       • new_window_tests.rs - (^0.8)

       • next_layout.rs - (^0.8)

       • next_layout_tests.rs - (^0.8)

       • next_window.rs - (^0.8)

       • next_window_tests.rs - (^0.8)

       • pipe_pane.rs - (^1.1)

       • pipe_pane_tests.rs - (^1.1)

       • previous_layout.rs - (^1.3)

       • previous_layout_tests.rs - (^1.3)

       • previous_window.rs - (^0.8)

       • previous_window_tests.rs - (^0.8)

       • rename_window.rs - (^0.8)

       • rename_window_tests.rs - (^0.8)

       • resize_pane.rs - (^0.9)

       • resize_pane_tests.rs - (^0.9)

       • resize_window.rs - (^2.9)

       • resize_window_tests.rs - (^2.9)

       • respawn_pane.rs - (^1.5)

       • respawn_pane_tests.rs - (^1.5)

       • respawn_window.rs - (^0.8)

       • respawn_window_tests.rs - (^0.8)

       • rotate_window.rs - (^0.8)

       • rotate_window_tests.rs - (^0.8)

       • select_layout.rs - (^0.9)

       • select_layout_tests.rs - (^0.9)

       • select_pane.rs - (^0.8)

       • select_pane_tests.rs - (^0.8)

       • select_window.rs - (^0.8)

       • select_window_tests.rs - (^0.8)

       • split_window.rs - (^0.8)

       • split_window_tests.rs - (^0.8)

       • swap_pane.rs - (^0.8)

       • swap_pane_tests.rs - (^0.8)

       • swap_window.rs - (^0.8)

       • swap_window_tests.rs - (^0.8)

       • unlink_window.rs - (^0.8)

       • unlink_window_tests.rs - (^0.8)

     • mod.rs

  4. TMUX Target module

     • target_pane.rs - TargetPane & TargetPaneEx objects

     • target_pane_tests.rs

     • target_session.rs - TargetSession object

     • target_session_tests.rs

     • target_window.rs - TargetWindow & TargetWindowEx objects

     • target_window_tests.rs

  5. TMUX Variables parsing functions

     • src/variables

       • mod.rs

     • src/variables/layout

       • mod.rs

       • layout_cell.rs - parse layout cell string

       • layout_cell_tests.rs

       • layout_checksum.rs - calculate layout checksum

       • layout_checksum_tests.rs

       • layout.rs - parse layot tree string

       • layout_tests.rs

     • src/variables/session

       • mod.rs

       • session.rs - parse a session

       • session_tests.rs

       • sessions.rs - parse a session list

       • sessions_tests.rs

       • session_stack.rs - session stack

     • src/variables/window

       • mod.rs

       • window_flag.rs - window flag

       • window.rs - parse a window

       • window_tests.rs

       • windows.rs - parse a windows list

       • windows_tests.rs

     • src/variables/pane

       • mod.rs

       • pane.rs - parse a pane

       • pane_tests.rs

       • panes.rs - parse a panes list

       • panes_tests.rs

       • pane_tabs.rs - pane tabs

• tests/ - crate integration tests (multiple functions):

  • issue1.rs - issue #1 tests
  • sessions_tests.rs - sessions tests
  • windows_tests.rs - windows tests
  • panes_tests.rs - panes tests
  • tmux_interface.rs

• scripts/ - scripts and variables:

  • man_tmux/ scripts for tmux manual analysis:
    • build_all.sh - bash script for building library for all tmux versions
    • generate_manpages.sh - bash script for generating man pages for all tmux versions
    • grep_options.sh - bash script for extracting tmux options from man pages
    • grep_variables.sh - bash script for extracting tmux variables from man pages
    • versions.var - contains tmux versions variables for using in scripts
  • tmux_error_mock.sh - bash script for testing of tmux error handling functions
  • tmux_mock.sh - bash script can be used instead of tmux binary, for simple logging (sniffing) intercommmunication between library functions and tmux
  • tmux_test.sh - bash script for output testing of tmux functions
  • tmux_variables_test.py - bash script for output testing of tmux functions

• .editorconfig - consistent coding style configuration (File Format)

• Cargo.toml - crate configuration (File Format)

• clippy.toml - Clippy configuration file (Clippy)

• rustfmt.toml - rustfmt configuration file (rustfmt)

• rust-toolchain - rustup toolchain configuration file (rustup)

• .travis.yml - travis CI configuration (File Format)

• CHANGELOG.md - version history

• LICENSE.md - license text

• README.md - common information (this file)

• ROADMAP.md - future goals, wishlist, ideas